CASToR  1.1
Tomographic Reconstruction (PET/SPECT)
 All Classes Files Functions Variables Typedefs Macros Groups Pages
iOptimizerTemplate.hh
Go to the documentation of this file.
1 
8 #ifndef IOPTIMIZERTEMPLATE_HH
9 #define IOPTIMIZERTEMPLATE_HH 1
10 
11 #include "gVariables.hh"
12 #include "sAddonManager.hh"
13 #include "vOptimizer.hh"
14 
15 
23 {
24  // -----------------------------------------------------------------------------------------
25  // Constructor & Destructor
26  public:
41 
42 
43  // -----------------------------------------------------------------------------------------
44  // Public member functions
45  public:
46  // Function for automatic insertion (put the class name as the parameter and do not add semi-column at the end of the line)
58  int ReadConfigurationFile(const string& a_configurationFile);
69  int ReadOptionsList(const string& a_optionsList);
70 
71 
72  // -----------------------------------------------------------------------------------------
73  // Private member functions (pure virtual in vOptimizer)
74  private:
84  void ShowHelpSpecific();
101  int InitializeSpecific();
116  int SensitivitySpecificOperations( FLTNB a_data, FLTNB a_forwardModel, FLTNB* ap_weight,
117  FLTNB a_multiplicativeCorrections, FLTNB a_additiveCorrections,
118  FLTNB a_quantificationFactor, oProjectionLine* ap_Line );
134  int DataSpaceSpecificOperations( FLTNB a_data, FLTNB a_forwardModel, FLTNB* ap_backwardValues,
135  FLTNB a_multiplicativeCorrections, FLTNB a_additiveCorrections,
136  FLTNB a_quantificationFactor, oProjectionLine* ap_Line );
148  int ImageSpaceSpecificOperations( FLTNB a_currentImageValue, FLTNB* ap_newImageValue,
149  FLTNB a_sensitivity, FLTNB* ap_correctionValues );
150 
151 
152  // -----------------------------------------------------------------------------------------
153  // Data members
154  private:
155 
156 };
157 
158 
159 // Class for automatic insertion (set here the visible optimizer's name as the first parameter,
160 // put the class name as the second parameter and do NOT add semi-colon at the end of the line)
162 
163 #endif
164 
This header file is mainly used to declare some macro definitions and all includes needed from the st...
#define FLTNB
Definition: gVariables.hh:55
~iOptimizerTemplate()
The destructor of iOptimizerTemplate.
iOptimizerTemplate()
The constructor of iOptimizerTemplate.
int CheckSpecificParameters()
A private function used to check the parameters settings specific to the child optimizer.
This class is a child of the vOptimizer class implementing a template squeleton.
Declaration of class vOptimizer.
int ReadOptionsList(const string &a_optionsList)
A function used to read options from a list of options.
#define FUNCTION_OPTIMIZER(CLASS)
Definition: vOptimizer.hh:619
int InitializeSpecific()
This function is used to initialize specific stuff to the child optimizer.
#define CLASS_OPTIMIZER(NAME, CLASS)
Definition: vOptimizer.hh:623
int DataSpaceSpecificOperations(FLTNB a_data, FLTNB a_forwardModel, FLTNB *ap_backwardValues, FLTNB a_multiplicativeCorrections, FLTNB a_additiveCorrections, FLTNB a_quantificationFactor, oProjectionLine *ap_Line)
This function performs the data space operations specific to the optimizer (computes the values to be...
This class is designed to generically described any iterative optimizer.
Definition: vOptimizer.hh:36
This class is designed to manage and store system matrix elements associated to a vEvent...
int ReadConfigurationFile(const string &a_configurationFile)
A function used to read options from a configuration file.
void ShowHelpSpecific()
A function used to show help about the child optimizer.
int SensitivitySpecificOperations(FLTNB a_data, FLTNB a_forwardModel, FLTNB *ap_weight, FLTNB a_multiplicativeCorrections, FLTNB a_additiveCorrections, FLTNB a_quantificationFactor, oProjectionLine *ap_Line)
This function compute the weight associated to the provided event (for sensitivity computation) ...
Declaration of class sAddonManager.
int ImageSpaceSpecificOperations(FLTNB a_currentImageValue, FLTNB *ap_newImageValue, FLTNB a_sensitivity, FLTNB *ap_correctionValues)
This function perform the image update step specific to the optimizer.