CASToR  2.0
Tomographic Reconstruction (PET/SPECT/CT)
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
iProjectorTemplate.hh
Go to the documentation of this file.
1 /*
2 This file is part of CASToR.
3 
4  CASToR is free software: you can redistribute it and/or modify it under the
5  terms of the GNU General Public License as published by the Free Software
6  Foundation, either version 3 of the License, or (at your option) any later
7  version.
8 
9  CASToR is distributed in the hope that it will be useful, but WITHOUT ANY
10  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12  details.
13 
14  You should have received a copy of the GNU General Public License along with
15  CASToR (in file GNU_GPL.TXT). If not, see <http://www.gnu.org/licenses/>.
16 
17 Copyright 2017-2018 all CASToR contributors listed below:
18 
19  --> current contributors: Thibaut MERLIN, Simon STUTE, Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Mael MILLARDET
20  --> past contributors: Valentin VIELZEUF
21 
22 This is CASToR version 2.0.
23 */
24 
31 #ifndef IPROJECTORTEMPLATE_HH
32 #define IPROJECTORTEMPLATE_HH 1
33 
34 #include "gVariables.hh"
35 #include "sAddonManager.hh"
36 #include "vProjector.hh"
37 
44 {
45  // -------------------------------------------------------------------
46  // Constructor & Destructor
47  public:
62 
63 
64  // -------------------------------------------------------------------
65  // Public member functions
66  public:
67  // Function for automatic insertion (put the class name as the parameter and do not add semi-column at the end of the line)
79  int ReadConfigurationFile(const string& a_configurationFile);
90  int ReadOptionsList(const string& a_optionsList);
100 
101 
102  // -------------------------------------------------------------------
103  // Private member functions
104  private:
113  void ShowHelpSpecific();
130  int InitializeSpecific();
140  int ProjectWithoutTOF( int a_direction, oProjectionLine* ap_ProjectionLine );
151  int ProjectWithTOFPos( int a_direction, oProjectionLine* ap_ProjectionLine );
162  int ProjectWithTOFBin( int a_direction, oProjectionLine* ap_ProjectionLine );
163 
164 
165  // -------------------------------------------------------------------
166  // Data members
167  private:
168 
169 };
170 
171 
172 // Class for automatic insertion (set here the visible projector's name as the first parameter,
173 // put the class name as the second parameter and do NOT add semi-colon at the end of the line)
175 
176 #endif
177 
This header file is mainly used to declare some macro definitions and all includes needed from the st...
int ProjectWithTOFBin(int a_direction, oProjectionLine *ap_ProjectionLine)
A function to project with TOF binned information.
iProjectorTemplate()
The constructor of iProjectorTemplate.
int ProjectWithoutTOF(int a_direction, oProjectionLine *ap_ProjectionLine)
A function to project without TOF.
int ReadOptionsList(const string &a_optionsList)
A function used to read options from a list of options.
INTNB EstimateMaxNumberOfVoxelsPerLine()
This function is used to compute and provide an estimate of the maximum number of voxels that could c...
This class is designed to generically described any on-the-fly projector.
Definition: vProjector.hh:76
void ShowHelpSpecific()
A function used to show help about the child module.
~iProjectorTemplate()
The destructor of iProjectorTemplate.
int CheckSpecificParameters()
A private function used to check the parameters settings specific to the child projector.
Declaration of class vProjector.
int InitializeSpecific()
This function is used to initialize specific stuff to the child projector.
#define FUNCTION_PROJECTOR(CLASS)
Definition: vProjector.hh:374
int ReadConfigurationFile(const string &a_configurationFile)
A function used to read options from a configuration file.
#define INTNB
Definition: gVariables.hh:92
This class is designed to manage and store system matrix elements associated to a vEvent...
int ProjectWithTOFPos(int a_direction, oProjectionLine *ap_ProjectionLine)
A function to project with TOF continuous information.
This class is a child of the vProjector class implementing a template squeleton.
#define CLASS_PROJECTOR(NAME, CLASS)
Definition: vProjector.hh:378
Declaration of class sAddonManager.