CASToR  3.2
Tomographic Reconstruction (PET/SPECT/CT)
iOptimizerAPPGML.hh
Go to the documentation of this file.
1 
8 #ifndef IOPTIMIZERAPPGML_HH
9 #define IOPTIMIZERAPPGML_HH 1
10 
11 #include "gVariables.hh"
12 #include "sAddonManager.hh"
13 #include "vOptimizer.hh"
14 
15 
22 {
23  // -------------------------------------------------------------------
24  // Constructor & Destructor
25  public:
40 
41 
42  // -------------------------------------------------------------------
43  // Public member functions
44  public:
45  // Function for automatic insertion (put the class name as the parameter and do not add semi-column at the end of the line)
57  int ReadConfigurationFile(const string& a_configurationFile);
68  int ReadOptionsList(const string& a_optionsList);
69 
70  // -------------------------------------------------------------------
71  // Private member functions (virtual in vOptimizer)
72  private:
73 
74 
75  private:
83  virtual int PreDataUpdateSpecificStep();
92 
93  // -------------------------------------------------------------------
94  // Private member functions (pure virtual in vOptimizer)
95  private:
105  void ShowHelpSpecific();
122  int InitializeSpecific();
137  int SensitivitySpecificOperations( FLTNB a_data, FLTNB a_forwardModel, FLTNB* ap_weight,
138  FLTNB a_multiplicativeCorrections, FLTNB a_additiveCorrections, FLTNB a_blankValue,
139  FLTNB a_quantificationFactor, oProjectionLine* ap_Line );
155  int DataSpaceSpecificOperations( FLTNB a_data, FLTNB a_forwardModel, FLTNB* ap_backwardValues,
156  FLTNB a_multiplicativeCorrections, FLTNB a_additiveCorrections, FLTNB a_blankValue,
157  FLTNB a_quantificationFactor, oProjectionLine* ap_Line );
169  int ImageSpaceSpecificOperations( FLTNB a_currentImageValue, FLTNB* ap_newImageValue,
170  FLTNB a_sensitivity, FLTNB* ap_correctionValues, INTNB a_voxel, int tbf = -1, int rbf = -1, int cbf = -1 );
171 
172 
173  // -------------------------------------------------------------------
174  // Data members
175  private:
186 };
187 
188 
189 // Class for automatic insertion (set here the visible optimizer's name as the first parameter,
190 // put the class name as the second parameter and do NOT add semi-colon at the end of the line)
192 
193 #endif
194 
FLTNB * mp_specificRegionOfInterestConvolved
FLTNB * mp_specificRegionOfInterest
int InitializeSpecific()
This function is used to initialize specific stuff to the child optimizer.
int ImageSpaceSpecificOperations(FLTNB a_currentImageValue, FLTNB *ap_newImageValue, FLTNB a_sensitivity, FLTNB *ap_correctionValues, INTNB a_voxel, int tbf=-1, int rbf=-1, int cbf=-1)
This function perform the image update step specific to the optimizer.
int PreImageUpdateSpecificStep()
A private function used to compute the penalty term update adaptive alpha of the ADMM algorithm...
int DataSpaceSpecificOperations(FLTNB a_data, FLTNB a_forwardModel, FLTNB *ap_backwardValues, FLTNB a_multiplicativeCorrections, FLTNB a_additiveCorrections, FLTNB a_blankValue, FLTNB a_quantificationFactor, oProjectionLine *ap_Line)
This function performs the data space operations specific to the optimizer (computes the values to be...
int ReadOptionsList(const string &a_optionsList)
A function used to read options from a list of options.
int ReadConfigurationFile(const string &a_configurationFile)
A function used to read options from a configuration file.
FLTNB **** m4p_imageNotShifted
FLTNB **** m4p_secondDerivativePenaltyImage
Declaration of class vOptimizer.
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_blankValue, FLTNB a_quantificationFactor, oProjectionLine *ap_Line)
This function compute the weight associated to the provided event (for sensitivity computation) ...
FLTNB m_dataSpaceDenominatorThreshold
#define FUNCTION_OPTIMIZER(CLASS)
#define CLASS_OPTIMIZER(NAME, CLASS)
This class is designed to generically described any iterative optimizer.
This class is designed to manage and store system matrix elements associated to a vEvent...
int CheckSpecificParameters()
A private function used to check the parameters settings specific to the child optimizer.
This class implements the A-Preconditioned Gradient MAP algorithm.
iOptimizerAPPGML()
The constructor of iOptimizerAPPGML.
virtual int PreDataUpdateSpecificStep()
A private function used to compute some norms for the image update.
FLTNB **** m4p_firstDerivativePenaltyImage
~iOptimizerAPPGML()
The destructor of iOptimizerAPPGML.