Source code for astra.data3d

# -----------------------------------------------------------------------
# Copyright: 2010-2016, iMinds-Vision Lab, University of Antwerp
#            2013-2016, CWI, Amsterdam
#
# Contact: astra@uantwerpen.be
# Website: http://www.astra-toolbox.com/
#
# This file is part of the ASTRA Toolbox.
#
#
# 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 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 ASTRA Toolbox. If not, see <http://www.gnu.org/licenses/>.
#
# -----------------------------------------------------------------------

from . import data3d_c as d
import numpy as np

[docs]def create(datatype,geometry,data=None): """Create a 3D object. :param datatype: Data object type, '-vol' or '-sino'. :type datatype: :class:`string` :param geometry: Volume or projection geometry. :type geometry: :class:`dict` :param data: Data to fill the constructed object with, either a scalar or array. :type data: :class:`float` or :class:`numpy.ndarray` :returns: :class:`int` -- the ID of the constructed object. """ return d.create(datatype,geometry,data)
[docs]def get(i): """Get a 3D object. :param i: ID of object to get. :type i: :class:`int` :returns: :class:`numpy.ndarray` -- The object data. """ return d.get(i)
[docs]def get_shared(i): """Get a 3D object with memory shared between the ASTRA toolbox and numpy array. :param i: ID of object to get. :type i: :class:`int` :returns: :class:`numpy.ndarray` -- The object data. """ return d.get_shared(i)
[docs]def get_single(i): """Get a 3D object in single precision. :param i: ID of object to get. :type i: :class:`int` :returns: :class:`numpy.ndarray` -- The object data. """ return d.get_single(i)
[docs]def store(i,data): """Fill existing 3D object with data. :param i: ID of object to fill. :type i: :class:`int` :param data: Data to fill the object with, either a scalar or array. :type data: :class:`float` or :class:`numpy.ndarray` """ return d.store(i,data)
[docs]def get_geometry(i): """Get the geometry of a 3D object. :param i: ID of object. :type i: :class:`int` :returns: :class:`dict` -- The geometry of object with ID ``i``. """ return d.get_geometry(i)
[docs]def change_geometry(i, geometry): """Change the geometry of a 3D object. :param i: ID of object. :type i: :class:`int` :param geometry: Volume or projection geometry. :type geometry: :class:`dict` """ return d.change_geometry(i, geometry)
[docs]def dimensions(i): """Get dimensions of a 3D object. :param i: ID of object. :type i: :class:`int` :returns: :class:`tuple` -- dimensions of object with ID ``i``. """ return d.dimensions(i)
[docs]def delete(ids): """Delete a 2D object. :param ids: ID or list of ID's to delete. :type ids: :class:`int` or :class:`list` """ return d.delete(ids)
[docs]def clear(): """Clear all 3D data objects.""" return d.clear()
[docs]def info(): """Print info on 3D objects in memory.""" return d.info()