diff options
Diffstat (limited to 'include/astra/Float32VolumeData2D.h')
| -rw-r--r-- | include/astra/Float32VolumeData2D.h | 183 |
1 files changed, 183 insertions, 0 deletions
diff --git a/include/astra/Float32VolumeData2D.h b/include/astra/Float32VolumeData2D.h new file mode 100644 index 0000000..d7bf2f6 --- /dev/null +++ b/include/astra/Float32VolumeData2D.h @@ -0,0 +1,183 @@ +/* +----------------------------------------------------------------------- +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_FLOAT32VOLUMEDATA2D +#define _INC_ASTRA_FLOAT32VOLUMEDATA2D + +#include "Float32Data2D.h" +#include "VolumeGeometry2D.h" + +namespace astra { + +/** + * This class represents two-dimensional Volume 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. + */ +class _AstraExport CFloat32VolumeData2D : public CFloat32Data2D { + +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(). + * + */ + CFloat32VolumeData2D(); + + /** Constructor. Create an instance of the CFloat32VolumeData2D 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 volume geometry object. + * + * @param _pGeometry Volume Geometry object. This object will be HARDCOPIED into this class. + */ + CFloat32VolumeData2D(CVolumeGeometry2D* _pGeometry); + + /** Constructor. Create an instance of the CFloat32VolumeData2D class with initialization of the data. + * + * 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 volume geometry object. + * + * @param _pGeometry Volume Geometry object. This object will be HARDCOPIED into this class. + * @param _pfData pointer to a one-dimensional float32 data block + */ + CFloat32VolumeData2D(CVolumeGeometry2D* _pGeometry, float32* _pfData); + + /** Constructor. Create an instance of the CFloat32VolumeData2D class with a scalar initialization of the data. + * + * 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 volume geometry object. + * + * @param _pGeometry Volume Geometry object. This object will be HARDCOPIED into this class. + * @param _fScalar scalar value to be put at each index. + */ + CFloat32VolumeData2D(CVolumeGeometry2D* _pGeometry, float32 _fScalar); + + /** + * Copy constructor + */ + CFloat32VolumeData2D(const CFloat32VolumeData2D& _other); + + /** + * Assignment operator + */ + CFloat32VolumeData2D& operator=(const CFloat32VolumeData2D& _other); + + /** Initialization. Initializes of the CFloat32VolumeData2D 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 volume geometry object. + * + * @param _pGeometry Volume Geometry of the data. This object will be HARDCOPIED into this class. + * @return Initialization of the base class successfull. + */ + bool initialize(CVolumeGeometry2D* _pGeometry); + + /** Initialization. Initializes an instance of the CFloat32VolumeData2D class with initialization of the data. + * + * 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 volume geometry object. + * + * @param _pGeometry Volume Geometry of the data. This object will be HARDCOPIED into this class. + * @param _pfData pointer to a one-dimensional float32 data block + */ + bool initialize(CVolumeGeometry2D* _pGeometry, const float32* _pfData); + + + /** Initialization. Initializes an instance of the CFloat32VolumeData2D class with scalar initialization of the data. + * + * 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 volume geometry object. + * + * @param _pGeometry Volume Geometry of the data. This object will be HARDCOPIED into this class. + * @param _fScalar scalar value to be put at each index. + */ + bool initialize(CVolumeGeometry2D* _pGeometry, float32 _fScalar); + + /** Destructor. + */ + virtual ~CFloat32VolumeData2D(); + + /** Which type is this class? + * + * @return DataType: VOLUME + */ + virtual EDataType getType() const; + + /** Get the volume geometry. + * + * @return pointer to volume geometry. + */ + virtual CVolumeGeometry2D* getGeometry() const; + + /** Change the projection geometry. + * Note that this can't change the dimensions of the data. + */ + virtual void changeGeometry(CVolumeGeometry2D* pGeometry); + +protected: + + /** The projection geometry for this data. + */ + CVolumeGeometry2D* m_pGeometry; + +}; + +//---------------------------------------------------------------------------------------- +// Get the projection geometry. +inline CVolumeGeometry2D* CFloat32VolumeData2D::getGeometry() const +{ + ASTRA_ASSERT(m_bInitialized); + return m_pGeometry; +} + +//---------------------------------------------------------------------------------------- +// Get type +inline CFloat32Data2D::EDataType CFloat32VolumeData2D::getType() const +{ + return VOLUME; +} + + +} // end namespace astra + +#endif // _INC_ASTRA_FLOAT32VOLUMEDATA2D |