summaryrefslogtreecommitdiffstats
path: root/include/astra/BackProjectionAlgorithm.h
diff options
context:
space:
mode:
authorWillem Jan Palenstijn <WillemJan.Palenstijn@uantwerpen.be>2013-07-01 22:34:11 +0000
committerwpalenst <WillemJan.Palenstijn@uantwerpen.be>2013-07-01 22:34:11 +0000
commitb2fc6c70434674d74551c3a6c01ffb3233499312 (patch)
treeb17f080ebc504ab85ebb7c3d89f917fd87ce9e00 /include/astra/BackProjectionAlgorithm.h
downloadastra-b2fc6c70434674d74551c3a6c01ffb3233499312.tar.gz
astra-b2fc6c70434674d74551c3a6c01ffb3233499312.tar.bz2
astra-b2fc6c70434674d74551c3a6c01ffb3233499312.tar.xz
astra-b2fc6c70434674d74551c3a6c01ffb3233499312.zip
Update version to 1.3
Diffstat (limited to 'include/astra/BackProjectionAlgorithm.h')
-rw-r--r--include/astra/BackProjectionAlgorithm.h155
1 files changed, 155 insertions, 0 deletions
diff --git a/include/astra/BackProjectionAlgorithm.h b/include/astra/BackProjectionAlgorithm.h
new file mode 100644
index 0000000..d50b406
--- /dev/null
+++ b/include/astra/BackProjectionAlgorithm.h
@@ -0,0 +1,155 @@
+/*
+-----------------------------------------------------------------------
+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_BACKPROJECTIONALGORITHM
+#define _INC_ASTRA_BACKPROJECTIONALGORITHM
+
+#include "Globals.h"
+#include "Config.h"
+
+#include "Algorithm.h"
+#include "ReconstructionAlgorithm2D.h"
+
+#include "Projector2D.h"
+#include "Float32ProjectionData2D.h"
+#include "Float32VolumeData2D.h"
+
+#include "DataProjector.h"
+
+namespace astra {
+
+/**
+ * \brief
+ * This class performs an unfiltered backprojection.
+ *
+ * \par XML Configuration
+ * \astra_xml_item{ProjectorId, integer, Identifier of a projector as it is stored in the ProjectorManager.}
+ * \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. 1 = reconstruct on this pixel. 0 = don't reconstruct on this pixel.}
+ * \astra_xml_item_option{SinogramMaskId, integer, not used, Identifier of a projection data object that acts as a projection mask. 1 = reconstruct using this ray. 0 = don't use this ray while reconstructing.}
+ *
+ */
+class _AstraExport CBackProjectionAlgorithm : public CReconstructionAlgorithm2D {
+
+protected:
+
+ /** Init stuff
+ */
+ virtual void _init();
+
+ /** Initial clearing. Only to be used by constructors.
+ */
+ virtual void _clear();
+
+ /** Check the values of this object. If everything is ok, the object can be set to the initialized state.
+ * The following statements are then guaranteed to hold:
+ * - valid projector
+ * - valid data objects
+ */
+ virtual bool _check();
+
+public:
+
+ // type of the algorithm, needed to register with CAlgorithmFactory
+ static std::string type;
+
+ /** Default constructor, containing no code.
+ */
+ CBackProjectionAlgorithm();
+
+ /** Default constructor
+ *
+ * @param _pProjector Projector Object.
+ * @param _pSinogram ProjectionData2D object containing the sinogram data.
+ * @param _pReconstruction VolumeData2D object for storing the reconstructed volume.
+ */
+ CBackProjectionAlgorithm(CProjector2D* _pProjector,
+ CFloat32ProjectionData2D* _pSinogram,
+ CFloat32VolumeData2D* _pReconstruction);
+
+ /** Destructor.
+ */
+ virtual ~CBackProjectionAlgorithm();
+
+ /** Clear this class.
+ */
+ virtual void clear();
+
+ /** Initialize the algorithm with a config object.
+ *
+ * @param _cfg Configuration Object
+ * @return Initialization successful?
+ */
+ virtual bool initialize(const Config& _cfg);
+
+ /** Initialize class.
+ *
+ * @param _pProjector Projector Object.
+ * @param _pSinogram ProjectionData2D object containing the sinogram data.
+ * @param _pReconstruction VolumeData2D object for storing the reconstructed volume.
+ * @return Initialization successful?
+ */
+ bool initialize(CProjector2D* _pProjector,
+ CFloat32ProjectionData2D* _pSinogram,
+ CFloat32VolumeData2D* _pReconstruction);
+
+ /** Get all information parameters.
+ *
+ * @return Map with all available identifier strings and their values.
+ */
+ virtual map<string,boost::any> getInformation();
+
+ /** Get a single piece of information represented as a boost::any
+ *
+ * @param _sIdentifier Identifier string to specify which piece of information you want.
+ * @return One piece of information.
+ */
+ virtual boost::any getInformation(std::string _sIdentifier);
+
+ /** Perform a number of iterations.
+ *
+ * @param _iNrIterations amount of iterations to perform.
+ */
+ virtual void run(int _iNrIterations = 0);
+
+ /** Get a description of the class.
+ *
+ * @return description string
+ */
+ virtual std::string description() const;
+
+};
+
+// inline functions
+inline std::string CBackProjectionAlgorithm::description() const { return CBackProjectionAlgorithm::type; };
+
+
+} // end namespace
+
+#endif