![]() |
CASToR
1.0
Tomographic Reconstruction (PET/SPECT)
|
This class implements the Maximum Likelihood Expectation Maximization algorithm. More...
#include <iOptimizerMLEM.hh>
Public Member Functions | |
iOptimizerMLEM () | |
The constructor of iOptimizerMLEM. | |
~iOptimizerMLEM () | |
The destructor of iOptimizerMLEM. | |
int | ReadConfigurationFile (const string &a_configurationFile) |
A function used to read options from a configuration file. | |
int | ReadOptionsList (const string &a_optionsList) |
A function used to read options from a list of options. | |
Private Member Functions | |
void | ShowHelpSpecific () |
A function used to show help about the child optimizer. | |
int | CheckSpecificParameters () |
A private function used to check the parameters settings specific to the child optimizer. | |
int | InitializeSpecific () |
This function is used to initialize specific stuff to 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) | |
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 backprojected) | |
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. | |
Private Attributes | |
FLTNB | m_dataSpaceDenominatorThreshold |
FLTNB | m_minimumImageUpdateFactor |
FLTNB | m_maximumImageUpdateFactor |
This class implements the Maximum Likelihood Expectation Maximization algorithm.
This class inherits from vOptimizer and implements the classical MLEM algorithm for likelihood maximization. It is implemented in its multiplicative form.
Definition at line 22 of file iOptimizerMLEM.hh.
The constructor of iOptimizerMLEM.
This is the default and unique constructor. It does not take any parameter and its role is only to affect default values to each member of the class.
Definition at line 26 of file iOptimizerMLEM.cc.
The destructor of iOptimizerMLEM.
This is the default and unique destructor. It does not take any parameter and its role is only to free or delete all structures that were built by this class.
Definition at line 56 of file iOptimizerMLEM.cc.
int iOptimizerMLEM::CheckSpecificParameters | ( | ) | [private, virtual] |
A private function used to check the parameters settings specific to the child optimizer.
This function is used to check that all parameters specific to the optimizer are correctly set within allowed values. It is called by the CheckParameters() function of the mother class. It is the implementation of the pure virtual function inherited from the abstract mother class vOptimizer.
Implements vOptimizer.
Definition at line 149 of file iOptimizerMLEM.cc.
int iOptimizerMLEM::DataSpaceSpecificOperations | ( | FLTNB | a_data, |
FLTNB | a_forwardModel, | ||
FLTNB * | ap_backwardValues, | ||
FLTNB | a_multiplicativeCorrections, | ||
FLTNB | a_additiveCorrections, | ||
FLTNB | a_quantificationFactor, | ||
oProjectionLine * | ap_Line | ||
) | [private, virtual] |
This function performs the data space operations specific to the optimizer (computes the values to be backprojected)
FLTNB | a_data |
FLTNB | a_forwardModel |
FLTNB* | ap_backwardValues |
FLTNB | a_multiplicativeCorrections |
FLTNB | a_additiveCorrections |
FLTNB | a_quantificationFactor |
oProjectionLine* | ap_Line |
It is the implementation of the pure virtual function from vOptimizer. The results to be backprojected is put at ap_backwardValues location.
Implements vOptimizer.
Definition at line 217 of file iOptimizerMLEM.cc.
int iOptimizerMLEM::ImageSpaceSpecificOperations | ( | FLTNB | a_currentImageValue, |
FLTNB * | ap_newImageValue, | ||
FLTNB | a_sensitivity, | ||
FLTNB * | ap_correctionValues | ||
) | [private, virtual] |
This function perform the image update step specific to the optimizer.
FLTNB | a_currentImageValue |
FLTNB* | ap_newImageValue |
FLTNB | a_sensitivity |
FLTNB* | ap_correctionValues |
It is the implementation of the pure virtual function from vOptimizer. The new image value is put at the ap_newImageValue location.
Implements vOptimizer.
Definition at line 235 of file iOptimizerMLEM.cc.
int iOptimizerMLEM::InitializeSpecific | ( | ) | [private, virtual] |
This function is used to initialize specific stuff to the child optimizer.
It is called by the public Initialize() function from the mother.
Implements vOptimizer.
Definition at line 178 of file iOptimizerMLEM.cc.
int iOptimizerMLEM::ReadConfigurationFile | ( | const string & | a_configurationFile | ) | [virtual] |
A function used to read options from a configuration file.
const | string& a_configurationFile |
This function implements the reading of all options associated to the child optimizer, from a configuration file. It is the implementation of the pure virtual function inherited from the abstract class vOptimizer. It checks the reading status but not the options values that will be checked by the CheckSpecificParameters() function.
Implements vOptimizer.
Definition at line 83 of file iOptimizerMLEM.cc.
int iOptimizerMLEM::ReadOptionsList | ( | const string & | a_optionsList | ) | [virtual] |
A function used to read options from a list of options.
const | string& a_configurationFile |
This function implements the reading of all options associated to the child optimizer, from a list of options. It is the implementation of the pure virtual function inherited from the abstract class vOptimizer. It checks the reading status but not the options values that will be checked by the CheckSpecificParameters() function.
Implements vOptimizer.
Definition at line 123 of file iOptimizerMLEM.cc.
int iOptimizerMLEM::SensitivitySpecificOperations | ( | FLTNB | a_data, |
FLTNB | a_forwardModel, | ||
FLTNB * | ap_weight, | ||
FLTNB | a_multiplicativeCorrections, | ||
FLTNB | a_additiveCorrections, | ||
FLTNB | a_quantificationFactor, | ||
oProjectionLine * | ap_Line | ||
) | [private, virtual] |
This function compute the weight associated to the provided event (for sensitivity computation)
FLTNB | a_data |
FLTNB | a_forwardModel |
FLTNB* | ap_weight |
FLTNB | a_multiplicativeCorrections |
FLTNB | a_additiveCorrections |
FLTNB | a_quantificationFactor |
oProjectionLine* | ap_Line |
It is the implementation of the pure virtual function from vOptimizer. The result is put at ap_weight location.
Implements vOptimizer.
Definition at line 202 of file iOptimizerMLEM.cc.
void iOptimizerMLEM::ShowHelpSpecific | ( | ) | [private, virtual] |
A function used to show help about the child optimizer.
This function must describe what the module does and how to use it. It describes in details the different parameters of the optimizer, and how to set them through the use of a configuration file or a list of options. It is the implementation of the pure virtual function inherited from the abstract class vOptimizer. It is called by the public ShowHelp() function.
Implements vOptimizer.
Definition at line 65 of file iOptimizerMLEM.cc.
Threshold applied to the denominator of the data space operation to avoid 0-divisions or too high ratios
Definition at line 154 of file iOptimizerMLEM.hh.
Maximum allowed image update factor (null or negative values mean no restriction)
Definition at line 156 of file iOptimizerMLEM.hh.
Minimum allowed image update factor, useful to avoid voxels trapped in 0 value (null or negative values mean no restriction)
Definition at line 155 of file iOptimizerMLEM.hh.