diff options
author | Daniel M. Pelt <D.M.Pelt@cwi.nl> | 2015-02-24 12:35:45 +0100 |
---|---|---|
committer | Daniel M. Pelt <D.M.Pelt@cwi.nl> | 2015-02-24 12:35:45 +0100 |
commit | 3cae1d138c53a3fd042de3d2c9d9a07cf0650e0f (patch) | |
tree | 72f1bf197b33cfb64f259089830910a9754e5893 /python/astra/algorithm.py | |
parent | e212ab0d4f84adafa0a2fe11f5e16f856504769a (diff) | |
download | astra-3cae1d138c53a3fd042de3d2c9d9a07cf0650e0f.tar.gz astra-3cae1d138c53a3fd042de3d2c9d9a07cf0650e0f.tar.bz2 astra-3cae1d138c53a3fd042de3d2c9d9a07cf0650e0f.tar.xz astra-3cae1d138c53a3fd042de3d2c9d9a07cf0650e0f.zip |
Added Python interface
Diffstat (limited to 'python/astra/algorithm.py')
-rw-r--r-- | python/astra/algorithm.py | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/python/astra/algorithm.py b/python/astra/algorithm.py new file mode 100644 index 0000000..46cfccc --- /dev/null +++ b/python/astra/algorithm.py @@ -0,0 +1,76 @@ +#----------------------------------------------------------------------- +#Copyright 2013 Centrum Wiskunde & Informatica, Amsterdam +# +#Author: Daniel M. Pelt +#Contact: D.M.Pelt@cwi.nl +#Website: http://dmpelt.github.io/pyastratoolbox/ +# +# +#This file is part of the Python interface to the +#All Scale Tomographic Reconstruction Antwerp Toolbox ("ASTRA Toolbox"). +# +#The Python interface to the ASTRA Toolbox is free software: you can redistribute it and/or modify +#it under the terms of the GNU General Public License as published by +#the Free Software Foundation, either version 3 of the License, or +#(at your option) any later version. +# +#The Python interface to the ASTRA Toolbox is distributed in the hope that it will be useful, +#but WITHOUT ANY WARRANTY; without even the implied warranty of +#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +#GNU General Public License for more details. +# +#You should have received a copy of the GNU General Public License +#along with the Python interface to the ASTRA Toolbox. If not, see <http://www.gnu.org/licenses/>. +# +#----------------------------------------------------------------------- + +from . import algorithm_c as a + +def create(config): + """Create algorithm object. + + :param config: Algorithm options. + :type config: :class:`dict` + :returns: :class:`int` -- the ID of the constructed object. + + """ + return a.create(config) + +def run(i, iterations=1): + """Run an algorithm. + + :param i: ID of object. + :type i: :class:`int` + :param iterations: Number of iterations to run. + :type iterations: :class:`int` + + """ + return a.run(i,iterations) + +def get_res_norm(i): + """Get residual norm of algorithm. + + :param i: ID of object. + :type i: :class:`int` + :returns: :class:`float` -- The residual norm. + + """ + + return a.get_res_norm(i) + +def delete(ids): + """Delete a matrix object. + + :param ids: ID or list of ID's to delete. + :type ids: :class:`int` or :class:`list` + + """ + return a.delete(ids) + +def clear(): + """Clear all matrix objects.""" + return a.clear() + +def info(): + """Print info on matrix objects in memory.""" + return a.info() |