diff options
Diffstat (limited to 'include/astra/CudaCglsAlgorithm.h')
-rw-r--r-- | include/astra/CudaCglsAlgorithm.h | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/include/astra/CudaCglsAlgorithm.h b/include/astra/CudaCglsAlgorithm.h new file mode 100644 index 0000000..7734d6e --- /dev/null +++ b/include/astra/CudaCglsAlgorithm.h @@ -0,0 +1,122 @@ +/* +----------------------------------------------------------------------- +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_CUDACGLSALGORITHM +#define _INC_ASTRA_CUDACGLSALGORITHM + +#include "Globals.h" +#include "Config.h" + +#include "CudaReconstructionAlgorithm2D.h" + +#ifdef ASTRA_CUDA + +namespace astra { + +/** + * \brief + * This class contains a GPU implementation of the CGLS algorithm. + * + * \par XML Configuration + * \astra_xml_item{ProjectionGeometry, integer, Geometry of the projection data.} + * \astra_xml_item{VolumeGeometry, integer, Geometry of the volume data.} + * \astra_xml_item{ProjectionDataId, integer, Identifier of a projection data object as it is stored in the DataManager.} + * \astra_xml_item{ReconstructionDataId, integer, Identifier of a volume data object as it is stored in the DataManager.} + * \astra_xml_item_option{ReconstructionMaskId, integer, not used, Identifier of a volume data object that acts as a reconstruction mask. 0 = reconstruct on this pixel. 1 = don't reconstruct on this pixel.} + * + * \par MATLAB example + * \astra_code{ + * cfg = astra_struct('CGLS_CUDA');\n + * cfg.ProjectionGeometry = proj_geom;\n + * cfg.VolumeGeometry = vol_geom;\n + * cfg.ProjectionDataId = sino_id;\n + * cfg.ReconstructionDataId = recon_id;\n + * cfg.option.ReconstructionMaskId = mask_id;\n + * alg_id = astra_mex_algorithm('create'\, cfg);\n + * astra_mex_algorithm('iterate'\, alg_id\, 10);\n + * astra_mex_algorithm('delete'\, alg_id);\n + * } + * + */ + +class AstraCGLS; + +class _AstraExport CCudaCglsAlgorithm : public CCudaReconstructionAlgorithm2D +{ + +public: + + // type of the algorithm, needed to register with CAlgorithmFactory + static std::string type; + + /** Default constructor, containing no code. + */ + CCudaCglsAlgorithm(); + + /** Destructor. + */ + virtual ~CCudaCglsAlgorithm(); + + /** Initialize the algorithm with a config object. + * + * @param _cfg Configuration Object + * @return initialization successful? + */ + virtual bool initialize(const Config& _cfg); + + /** Initialize class, use sequential order. + * + * @param _pProjector Projector Object. (Ignored) + * @param _pSinogram ProjectionData2D object containing the sinogram + * @param _pReconstruction VolumeData2D for storing the reconstruction + * @param _iGPUindex Index of GPU to use. (Starting at 0.) + * @param _iDetectorSuperSampling Supersampling factor for the FP. + * @param _iPixelSuperSampling Square root of number of samples per voxel, used to compute the backprojection + */ + bool initialize(CProjector2D* _pProjector, + CFloat32ProjectionData2D* _pSinogram, + CFloat32VolumeData2D* _pReconstruction, + int _iGPUindex = 0, int _iDetectorSuperSampling = 1, + int _iPixelSuperSampling = 1); + + /** Get a description of the class. + * + * @return description string + */ + virtual std::string description() const; + +}; + +// inline functions +inline std::string CCudaCglsAlgorithm::description() const { return CCudaCglsAlgorithm::type; }; + +} // end namespace + +#endif // ASTRA_CUDA + +#endif |