This class is designed to manage the use of dynamic model in the reconstruction. More...

#include <oDynamicModelManager.hh>

Collaboration diagram for oDynamicModelManager:

Public Member Functions
	oDynamicModelManager ()
	Constructor of oDynamicModelManager. Simply set all data members to default values. More...

	~oDynamicModelManager ()
	Destructor of oDynamicModelManager. Free memory from all allocated tabs. More...

int	CheckParameters ()
	This function is used to check parameters after the latter have been all set using Set functions. More...

int	Initialize ()
	Set the dynamic model flag and instanciate/initialize model objects through the ParseOptionsAndInitializeDeformations() private function. More...

int	ApplyDynamicModel (oImageSpace *ap_ImageS, int a_iteration, int a_subset)

int	SaveParametricImages (int a_iteration, int a_subset=-1)
	Call SaveParametricImages() function of the dynamic model object is 'm_UseModel' is on, in order to save any parameter image. More...

void	SetVerbose (int a_verboseLevel)
	Set the verbose level. More...

void	SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)
	Set the image dimensions in use. More...

void	SetOptions (const string &a_options)
	Set the respiratory motion options contained in the provided string. More...

bool	UseModel ()
	Indicate if the use of a dynamic model is enabled. More...

Private Member Functions
int	ParseOptionsAndInitializeModel ()
	Parse dynamic model options contained in the previously provided strings. This function is called inside the Initialize() function. More...

Private Attributes
oImageDimensionsAndQuantification *	mp_ID

string	m_options

vDynamicModel *	mp_DynamicModel

bool	m_UseModel

int	m_verbose

bool	m_checked

bool	m_initialized

Detailed Description

This class is designed to manage the use of dynamic model in the reconstruction.

As each manager class, it is created in the main program, all parameters are then set, checked, and the manager is initialized.
The manager is then used by the algorithm itself, where the function ApplyDynamicModel() is called at the end of the subset loop

Definition at line 46 of file oDynamicModelManager.hh.

Constructor & Destructor Documentation

oDynamicModelManager::oDynamicModelManager ( )

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

Definition at line 42 of file oDynamicModelManager.cc.

oDynamicModelManager::~oDynamicModelManager ( )

Destructor of oDynamicModelManager. Free memory from all allocated tabs.

Definition at line 67 of file oDynamicModelManager.cc.

Member Function Documentation

int oDynamicModelManager::ApplyDynamicModel	(	oImageSpace *	ap_ImageS,
		int	a_iteration,
		int	a_subset
	)

Definition at line 288 of file oDynamicModelManager.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

int oDynamicModelManager::CheckParameters ( )

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 83 of file oDynamicModelManager.cc.

Here is the caller graph for this function:

int oDynamicModelManager::Initialize ( )

Set the dynamic model flag and instanciate/initialize model objects through the ParseOptionsAndInitializeDeformations() private function.

Returns: 0 if success, positive value otherwise.

Definition at line 117 of file oDynamicModelManager.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

int oDynamicModelManager::ParseOptionsAndInitializeModel ( )

private

Parse dynamic model options contained in the previously provided strings. This function is called inside the Initialize() function.

Manage the options reading and initialize specific vDynamicModel
Options are a string containing first the name of the model, then either a ':' and a configuration file specific to the model

or - as many ',' as needed parameters for this model.
Specific pure virtual functions of the vDynamicModel are used to read parameters and initialize them.
Returns
0 if success, positive value otherwise

Definition at line 167 of file oDynamicModelManager.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

int oDynamicModelManager::SaveParametricImages	(	int	a_iteration,
		int	a_subset = `-1`
	)

Call SaveParametricImages() function of the dynamic model object is 'm_UseModel' is on, in order to save any parameter image.

Parameters

a_iteration	: current iteration index
a_subset	: current number of subsets (or -1 by default)

Returns: 0 if success, positive value otherwise

Definition at line 333 of file oDynamicModelManager.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

oDynamicModelManager::SetImageDimensionsAndQuantification ( oImageDimensionsAndQuantification * ap_ImageDimensionsAndQuantification )

inline

Set the image dimensions in use.

Parameters

ap_ImageDimensionsAndQuantification

Definition at line 115 of file oDynamicModelManager.hh.

Here is the caller graph for this function:

oDynamicModelManager::SetOptions ( const string & a_options )

inline

Set the respiratory motion options contained in the provided string.

Parameters

a_options

Definition at line 122 of file oDynamicModelManager.hh.

Here is the caller graph for this function:

oDynamicModelManager::SetVerbose ( int a_verboseLevel )

inline

Set the verbose level.

Parameters

a_verboseLevel

Definition at line 108 of file oDynamicModelManager.hh.

Here is the caller graph for this function:

oDynamicModelManager::UseModel ( )

inline

Indicate if the use of a dynamic model is enabled.

Returns: true if enabled, false otherwise

Definition at line 129 of file oDynamicModelManager.hh.

Member Data Documentation

bool oDynamicModelManager::m_checked

private

Boolean indicating whether the parameters were checked or not

Definition at line 159 of file oDynamicModelManager.hh.

bool oDynamicModelManager::m_initialized

private

Boolean indicating whether the manager was initialized or not

Definition at line 160 of file oDynamicModelManager.hh.

string oDynamicModelManager::m_options

private

The string containing options for the dynamic model

Definition at line 155 of file oDynamicModelManager.hh.

bool oDynamicModelManager::m_UseModel

private

Flag indicating that use of a dynamic model is enabled or not

Definition at line 157 of file oDynamicModelManager.hh.

int oDynamicModelManager::m_verbose

private

The verbose level

Definition at line 158 of file oDynamicModelManager.hh.

vDynamicModel* oDynamicModelManager::mp_DynamicModel

private

Dynamic model object

Definition at line 156 of file oDynamicModelManager.hh.

oImageDimensionsAndQuantification* oDynamicModelManager::mp_ID

private

Pointer to the oImageDimensionsAndQuantification object in use

Definition at line 154 of file oDynamicModelManager.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