This is the mother class of dynamic model classes. More...

#include <vDynamicModel.hh>

Inheritance diagram for vDynamicModel:

Collaboration diagram for vDynamicModel:

Public Member Functions
	vDynamicModel ()
	Constructor of vDynamicModel. Simply set all data members to default values.
virtual	~vDynamicModel ()
	Destructor of vDynamicModel.
void	SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)
	Set the image dimensions in use.
void	SetVerbose (int a_verbose)
	Set the verbose level.
virtual int	CheckParameters ()
	This function is used to check parameters after the latter have been all set using Set functions.
virtual int	CheckSpecificParameters ()=0
	This function is used to check the parameters of the child functions before initialization if required.
virtual int	ReadAndCheckConfigurationFile (string a_fileOptions)=0
	This function is used to read options from a configuration file. It is pure virtual so must be implemented by children.
virtual int	ReadAndCheckOptionsList (string a_listOptions)=0
	This function is used to read parameters from a string. It is pure virtual so must be implemented by children.
virtual int	Initialize ()=0
	This function is used to initialize specific data related to the child deformation model. It is pure virtual so must be implemented by children.
virtual void	ShowHelp ()=0
	This function is used to print out specific help about the deformation and its options. It is pure virtual so must be implemented by children.
virtual int	EstimateModelParameters (oImageSpace *ap_Image, int a_ite, int a_sset)=0
	This function is pure virtual so must be implemented by children. It can be used to estimate any temporal functions or coefficients related to the dynamic model, if required.
virtual int	FitModel (oImageSpace *ap_Image, int a_ite, int a_sset)=0
	This function is pure virtual so must be implemented by children. It is used to fit the dynamic model to the series of dynamic images.
virtual int	SaveParametricImages (int a_ite)=0
	This function is pure virtual so must be implemented by children Call SaveParametricImages() function of the dynamic model object, in order to write on disk any parametric image of the model.
Protected Attributes
oImageDimensionsAndQuantification *	mp_ID
int	m_verbose
int	m_nbTimeBF
bool	m_checked
bool	m_initialized

Detailed Description

This is the mother class of dynamic model classes.

This class is a virtual one, in the sense that it cannot be used on its own
because several pure virtual functions belong to it. Its children are implementations of actual dynamic models.
Everywhere in the code, this parent class should be used instead of any of its children.
It can be used during the reconstruction process by the oDynamicModelManager through the use of the EstimateModelParameters() and FitModel() functions

All children must implement the following pure virtual functions:

ReadAndCheckConfigurationFile(): read specific options from a configuration file
ReadAndCheckOptionsList(): read specific options from a string
ShowHelp(): print helps about the projector specifications
Initialize(): initialize specific data of the projector (if required)
CheckParameters(): Check the initialization of the parameters (if required)

EstimateModelParameters() : (virtual only)
Estimate any temporal functions or coefficients
related to the dynamic model (if required)
FitModel(): Fit the dynamic model to the series of dynamic images

Definition at line 43 of file vDynamicModel.hh.

Constructor & Destructor Documentation

vDynamicModel::vDynamicModel ( )

Constructor of vDynamicModel. Simply set all data members to default values.

Definition at line 31 of file vDynamicModel.cc.

vDynamicModel::~vDynamicModel ( ) [virtual]

Destructor of vDynamicModel.

Definition at line 51 of file vDynamicModel.cc.

Member Function Documentation

int vDynamicModel::CheckParameters ( ) [virtual]

This function is used to check parameters after the latter have been all set using Set functions.

Returns:: 0 if success, positive value otherwise.

Definition at line 66 of file vDynamicModel.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

vDynamicModel::CheckSpecificParameters ( ) [pure virtual]

This function is used to check the parameters of the child functions before initialization if required.

It could be overloaded by the child if needed. Default implementation is empty and return 0.

Returns:: 0 if success, other value otherwise.

Implemented in iDynamicModelTemplate, and iPatlakModel.

Here is the caller graph for this function:

vDynamicModel::EstimateModelParameters	(	oImageSpace *	ap_Image,
		int	a_ite,
		int	a_sset
	)		`[pure virtual]`

This function is pure virtual so must be implemented by children.
It can be used to estimate any temporal functions or coefficients related to the dynamic model, if required.

Parameters:

ap_ImageS	: pointer to the ImageSpace
a_ite	: index of the actual iteration
a_sset	: index of the actual subset

Returns:: 0 if success, other value otherwise.

Implemented in iDynamicModelTemplate, and iPatlakModel.

Here is the caller graph for this function:

vDynamicModel::FitModel	(	oImageSpace *	ap_Image,
		int	a_ite,
		int	a_sset
	)		`[pure virtual]`

This function is pure virtual so must be implemented by children.
It is used to fit the dynamic model to the series of dynamic images.

Parameters:

ap_ImageS	: pointer to the ImageSpace
a_ite	: index of the actual iteration
a_sset	: index of the actual subset

Returns:: 0 if success, other value otherwise.

Implemented in iDynamicModelTemplate, and iPatlakModel.

Here is the caller graph for this function:

vDynamicModel::Initialize ( ) [pure virtual]

This function is used to initialize specific data related to the child deformation model.
It is pure virtual so must be implemented by children.

Returns:: 0 if success, other value otherwise.

Implemented in iDynamicModelTemplate, and iPatlakModel.

Here is the caller graph for this function:

vDynamicModel::ReadAndCheckConfigurationFile ( string a_fileOptions ) [pure virtual]

This function is used to read options from a configuration file.
It is pure virtual so must be implemented by children.

Parameters:

const string& a_configurationFile : ASCII file containing informations about a dynamic model

Returns:: 0 if success, other value otherwise.

Implemented in iDynamicModelTemplate, and iPatlakModel.

Here is the caller graph for this function:

vDynamicModel::ReadAndCheckOptionsList ( string a_listOptions ) [pure virtual]

This function is used to read parameters from a string.
It is pure virtual so must be implemented by children.

Parameters:

const string& a_optionsList : a list of parameters separated by commas

Returns:: 0 if success, other value otherwise.

Implemented in iDynamicModelTemplate, and iPatlakModel.

Here is the caller graph for this function:

vDynamicModel::SaveParametricImages ( int a_ite ) [pure virtual]

This function is pure virtual so must be implemented by children
Call SaveParametricImages() function of the dynamic model object, in order to write on disk any parametric image of the model.

Parameters:

a_ite