diff options
Diffstat (limited to 'include/astra/Float32ProjectionData3DMemory.h')
| -rw-r--r-- | include/astra/Float32ProjectionData3DMemory.h | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/include/astra/Float32ProjectionData3DMemory.h b/include/astra/Float32ProjectionData3DMemory.h new file mode 100644 index 0000000..8b61d45 --- /dev/null +++ b/include/astra/Float32ProjectionData3DMemory.h @@ -0,0 +1,218 @@ +/* +----------------------------------------------------------------------- +Copyright 2012 iMinds-Vision Lab, University of Antwerp + +Contact: astra@ua.ac.be +Website: http://astra.ua.ac.be + + +This file is part of the +All Scale Tomographic Reconstruction Antwerp Toolbox ("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/>. + +----------------------------------------------------------------------- +$Id$ +*/ + +#ifndef _INC_ASTRA_FLOAT32PROJECTIONDATA3DMEMORY +#define _INC_ASTRA_FLOAT32PROJECTIONDATA3DMEMORY + +#include "Float32Data3DMemory.h" +#include "Float32ProjectionData3D.h" +#include "ParallelProjectionGeometry2D.h" // TEMP + +namespace astra { + +/** + * This class represents three-dimensional Projection Data. + * + * It contains member functions for accessing this data and for performing + * elementary computations on the data. + * The data block is "owned" by the class, meaning that the class is + * responsible for deallocation of the memory involved. + * + * The projection data is stored as a series of consecutive rows, where + * each row contains the data for a single projection. + */ +class _AstraExport CFloat32ProjectionData3DMemory : public CFloat32Data3DMemory, public CFloat32ProjectionData3D { + +public: + + /** + * Default constructor. Sets all numeric member variables to 0 and all pointer member variables to NULL. + * + * If an object is constructed using this default constructor, it must always be followed by a call + * to one of the init() methods before the object can be used. Any use before calling init() is not allowed, + * except calling the member function isInitialized(). + * + */ + CFloat32ProjectionData3DMemory(); + + /** + * Constructor. Create an instance of the CFloat32ProjectionData3DMemory class without initializing the data. + * + * Memory is allocated for the data block. The allocated memory is not cleared and + * its contents after construction is undefined. Construction may be followed by a + * call to copyData() to fill the memory block. + * The size of the data is determined by the specified projection geometry object. + * + * @param _pGeometry Projection Geometry object. This object will be HARDCOPIED into this class. + */ + CFloat32ProjectionData3DMemory(CProjectionGeometry3D* _pGeometry); + + /** + * Constructor. Create an instance of the CFloat32ProjectionData3DMemory class with initialization of the data. + * + * Creates an instance of the CFloat32ProjectionData3DMemory class. Memory + * is allocated for the data block and the contents of the memory pointed to by + * _pfData is copied into the allocated memory. + * The size of the data is determined by the specified projection geometry object. + * + * @param _pGeometry Projection Geometry object. This object will be HARDCOPIED into this class. + * @param _pfData pointer to a one-dimensional float32 data block + */ + CFloat32ProjectionData3DMemory(CProjectionGeometry3D* _pGeometry, float32* _pfData); + + /** + * Constructor. Create an instance of the CFloat32ProjectionData3DMemory class filled with scalar data. + * + * Creates an instance of the CFloat32ProjectionData3DMemory class. Memory + * is allocated for the data block and the contents of the memory pointed to by + * _pfData is copied into the allocated memory. + * The size of the data is determined by the specified projection geometry object. + * + * @param _pGeometry Projection Geometry object. This object will be HARDCOPIED into this class. + * @param _fScalar scalar data + */ + CFloat32ProjectionData3DMemory(CProjectionGeometry3D* _pGeometry, float32 _fScalar); + + /** + * Destructor. + */ + virtual ~CFloat32ProjectionData3DMemory(); + + /** Initialization. Initializes an instance of the CFloat32ProjectionData3DMemory class, without filling the data block. + * + * Initializes an instance of the CFloat32ProjectionData3DMemory class. Memory is allocated for the + * data block. The allocated memory is not cleared and its contents after + * construction is undefined. Initialization may be followed by a call to + * copyData() to fill the memory block. If the object has been initialized before, the + * object is reinitialized and memory is freed and reallocated if necessary. + * + * @param _pGeometry Projection Geometry of the data. This object will be HARDCOPIED into this class. + * @return Initialization of the base class successfull. + */ + bool initialize(CProjectionGeometry3D* _pGeometry); + + /** Initialization. Initializes an instance of the CFloat32ProjectionData3DMemory class with scalar initialization. + * + * Initializes an instance of the CFloat32ProjectionData3DMemory class. Memory + * is allocated for the data block and the contents of the memory pointed to by + * _pfData is copied into the allocated memory. If the object has been initialized before, the + * object is reinitialized and memory is freed and reallocated if necessary. + * + * @param _pGeometry Projection Geometry of the data. This object will be HARDCOPIED into this class. + * @param _fScalar scalar value + */ + bool initialize(CProjectionGeometry3D* _pGeometry, float32 _fScalar); + + /** Initialization. Initializes an instance of the CFloat32ProjectionData3DMemory class with initialization of the data block. + * + * Initializes an instance of the CFloat32ProjectionData3DMemory class. Memory + * is allocated for the data block and the contents of the memory pointed to by + * _pfData is copied into the allocated memory. If the object has been initialized before, the + * object is reinitialized and memory is freed and reallocated if necessary. + * + * @param _pGeometry Projection Geometry of the data. This object will be HARDCOPIED into this class. + * @param _pfData pointer to a one-dimensional float32 data block + */ + bool initialize(CProjectionGeometry3D* _pGeometry, const float32* _pfData); + + /** Fetch a COPY of a projection of the data. Note that if you update the 2D data slice, the data in the + * 3D data object will remain unaltered. To copy the data back in the 3D-volume you must return the data by calling 'returnProjection'. + * + * @param _iProjectionNr projection number + * @return Volume data object + */ + virtual CFloat32VolumeData2D* fetchProjection(int _iProjectionNr) const; + + /** Return a projection slice to the 3D data. The data will be deleted. If the slice was fetched with + * 'fetchProjection', the data will be stored first. + * + * @param _iProjectionNr projection number + * @param _pProjection 2D Projection image + */ + virtual void returnProjection(int _iProjectionNr, CFloat32VolumeData2D* _pProjection); + + /** Fetch a COPY of a sinogram slice of the data. Note that if you update the 2D data slice, the data in the + * 3D data object will remain unaltered. To copy the data back in the 3D-volume you must return the data by calling 'returnSlice'. + * + * @param _iSliceNr slice number + * @return Sinogram data object + */ + virtual CFloat32ProjectionData2D* fetchSinogram(int _iSliceNr) const; + + /** This SLOW function returns a detector value stored a specific index in the array. + * Reading values in this way might cause a lot of unnecessary memory operations, don't + * use it in time-critical code. + * + * @param _iIndex Index in the array if the data were stored completely in main memory + * @return The value the location specified by _iIndex + */ + virtual float32 getDetectorValue(int _iIndex); + + /** This SLOW function stores a detector value at a specific index in the array. + * Writing values in this way might cause a lot of unnecessary memory operations, don't + * use it in time-critical code. + * + * @param _iIndex Index in the array if the data were stored completely in main memory + * @param _fValue The value to be stored at the location specified by _iIndex + */ + virtual void setDetectorValue(int _iIndex, float32 _fValue); + + /** Return a sinogram slice to the 3d data. The data will be stored in the 3D Data object. + * + * @param _iSliceNr slice number + * @param _pSinogram2D 2D Sinogram Object. + */ + virtual void returnSinogram(int _iSliceNr, CFloat32ProjectionData2D* _pSinogram2D); + + /** Which type is this class? + * + * @return DataType: PROJECTION + */ + virtual EDataType getType() const; + + /** + * Overloaded Operator: data = data (pointwise) + * + * @param _dataIn r-value + * @return l-value + */ + CFloat32ProjectionData3DMemory& operator=(const CFloat32ProjectionData3DMemory& _dataIn); +}; +//---------------------------------------------------------------------------------------- + +//---------------------------------------------------------------------------------------- +// Get type. +inline CFloat32Data3D::EDataType CFloat32ProjectionData3DMemory::getType() const +{ + return PROJECTION; +} +//---------------------------------------------------------------------------------------- + +} // end namespace astra + +#endif // _INC_ASTRA_FLOAT32PROJECTIONDATA3DMEMORY |