This class implements the Landweber algorithm. More...

#include <iOptimizerLandweber.hh>

Inheritance diagram for iOptimizerLandweber:

Collaboration diagram for iOptimizerLandweber:

Public Member Functions
	iOptimizerLandweber ()
	The constructor of iOptimizerLandweber.
	~iOptimizerLandweber ()
	The destructor of iOptimizerLandweber.
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_relaxationFactor

Detailed Description

This class implements the Landweber algorithm.

This class inherits from vOptimizer and implements the classical Landweber algorithm for least-squares minimization. A relaxation parameter can be used to scale (down) the additive update step.

Definition at line 23 of file iOptimizerLandweber.hh.

Constructor & Destructor Documentation

iOptimizerLandweber::iOptimizerLandweber ( )

The constructor of iOptimizerLandweber.

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 iOptimizerLandweber.cc.

iOptimizerLandweber::~iOptimizerLandweber ( )

The destructor of iOptimizerLandweber.

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 55 of file iOptimizerLandweber.cc.

Member Function Documentation

int iOptimizerLandweber::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.

Returns:: An integer reflecting the check status; 0 if no problem, another value otherwise.

Implements vOptimizer.

Definition at line 131 of file iOptimizerLandweber.cc.

int iOptimizerLandweber::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)

Parameters:

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.

Returns:: An integer reflecting the process status; 0 if no problem, another value otherwise.

Implements vOptimizer.

Definition at line 184 of file iOptimizerLandweber.cc.

int iOptimizerLandweber::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.

Parameters:

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.

Returns:: An integer reflecting the process status; 0 if no problem, another value otherwise.

Implements vOptimizer.

Definition at line 199 of file iOptimizerLandweber.cc.

int iOptimizerLandweber::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.

Returns:: An integer reflecting the initialization status; 0 if no problem, another value otherwise.

Implements vOptimizer.

Definition at line 148 of file iOptimizerLandweber.cc.

int iOptimizerLandweber::ReadConfigurationFile ( const string & a_configurationFile ) [virtual]

A function used to read options from a configuration file.

Parameters:

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.

Returns:: An integer reflecting the reading success; 0 if success, another value otherwise.

Implements vOptimizer.

Definition at line 81 of file iOptimizerLandweber.cc.

Here is the call graph for this function:

int iOptimizerLandweber::ReadOptionsList ( const string & a_optionsList ) [virtual]

A function used to read options from a list of options.

Parameters:

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.

Returns:: An integer reflecting the reading success; 0 if success, another value otherwise.

Implements vOptimizer.

Definition at line 107 of file iOptimizerLandweber.cc.

Here is the call graph for this function:

int iOptimizerLandweber::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)

Parameters:

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.

Returns:: An integer reflecting the process status; 0 if no problem, another value otherwise.

Implements vOptimizer.

Definition at line 169 of file iOptimizerLandweber.cc.

void iOptimizerLandweber::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 64 of file iOptimizerLandweber.cc.

Member Data Documentation

FLTNB iOptimizerLandweber::m_relaxationFactor [private]

The relaxation parameter that can be used to scale down the additive update

Definition at line 155 of file iOptimizerLandweber.hh.

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation