CASToR  3.0
Tomographic Reconstruction (PET/SPECT/CT)
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-2019 all CASToR contributors listed below:
18 
19  --> Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Thibaut MERLIN, Mael MILLARDET, Simon STUTE, Valentin VIELZEUF
20 
21 This is CASToR version 3.0.
22 */
23 
30 #ifndef IPROJECTORTEMPLATE_HH
31 #define IPROJECTORTEMPLATE_HH 1
32 
33 #include "gVariables.hh"
34 #include "sAddonManager.hh"
35 #include "vProjector.hh"
36 
43 {
44  // -------------------------------------------------------------------
45  // Constructor & Destructor
46  public:
61 
62 
63  // -------------------------------------------------------------------
64  // Public member functions
65  public:
66  // Function for automatic insertion (put the class name as the parameter and do not add semi-column at the end of the line)
78  int ReadConfigurationFile(const string& a_configurationFile);
89  int ReadOptionsList(const string& a_optionsList);
99 
100 
101  // -------------------------------------------------------------------
102  // Private member functions
103  private:
112  void ShowHelpSpecific();
129  int InitializeSpecific();
139  int ProjectWithoutTOF( int a_direction, oProjectionLine* ap_ProjectionLine );
150  int ProjectTOFListmode( int a_direction, oProjectionLine* ap_ProjectionLine );
161  int ProjectTOFHistogram( int a_direction, oProjectionLine* ap_ProjectionLine );
162 
163 
164  // -------------------------------------------------------------------
165  // Data members
166  private:
167 
168 };
169 
170 
171 // Class for automatic insertion (set here the visible projector's name as the first parameter,
172 // put the class name as the second parameter and do NOT add semi-colon at the end of the line)
174 
175 #endif
176 
This header file is mainly used to declare some macro definitions and all includes needed from the st...
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:75
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.
int ProjectTOFHistogram(int a_direction, oProjectionLine *ap_ProjectionLine)
A function to project with TOF binned information.
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:424
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...
This class is a child of the vProjector class implementing a template squeleton.
int ProjectTOFListmode(int a_direction, oProjectionLine *ap_ProjectionLine)
A function to project with TOF continuous information.
#define CLASS_PROJECTOR(NAME, CLASS)
Definition: vProjector.hh:428
Declaration of class sAddonManager.