This class is a child of the vDynamicModel class implementing a template squeleton. More...

#include <iDynamicModelTemplate.hh>

Inheritance diagram for iDynamicModelTemplate:

Collaboration diagram for iDynamicModelTemplate:

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

	~iDynamicModelTemplate ()
	Destructor of iDynamicModelTemplate. More...

int	CheckSpecificParameters ()
	This function is used to check whether all member variables have been correctly initialized or not. More...

int	ReadAndCheckConfigurationFile (string a_fileOptions)
	This function is used to read options from a configuration file. More...

int	ReadAndCheckOptionsList (string a_listOptions)
	This function is used to read parameters from a string. More...

int	Initialize ()
	This function is used to initialize the model parametric images and basis functions. More...

void	ShowHelp ()
	This function is used to print out specific help about the deformation model and its options. More...

int	EstimateModelParameters (oImageSpace *ap_Image, int a_ite, int a_sset)
	Estimate the model parametric images. More...

int	EstimateImageWithModel (oImageSpace *ap_Image, int a_ite, int a_sset)
	Estimate image using model parametric images and basis functions. More...

int	SaveParametricImages (int a_iteration)
	Write parametric images on disk. More...

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

virtual	~vDynamicModel ()
	Destructor of vDynamicModel. More...

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

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

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

virtual int	SaveParametricImages (int a_iteration, int a_subset=-1)
	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. More...

virtual int	ApplyOutputFOVMaskingOnParametricImages ()
	Mask the outside of the transaxial FOV based on the m_fovOutPercent. More...

virtual void	ComputeOutputParImage ()
	Compute output image using the m2p_parametricImages matrix Store the result in the m2p_outputParImages matrix. More...

Protected Attributes
FLTNB **	m2p_parametricImages

Protected Attributes inherited from vDynamicModel
oImageDimensionsAndQuantification *	mp_ID

int	m_verbose

int	m_nbTimeBF

bool	m_checked

bool	m_initialized

bool	m_saveParImageFlag

uint16_t	m_nbModelParam

FLTNB **	m2p_parametricImages

FLTNB **	m2p_modelTACs

FLTNB **	m2p_outputParImages

Detailed Description

This class is a child of the vDynamicModel class implementing a template squeleton.

Use this class to implement your own custom deformation model.

Definition at line 44 of file iDynamicModelTemplate.hh.

Constructor & Destructor Documentation

iDynamicModelTemplate::iDynamicModelTemplate ( )

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

Definition at line 41 of file iDynamicModelTemplate.cc.

iDynamicModelTemplate::~iDynamicModelTemplate ( )

Destructor of iDynamicModelTemplate.

Definition at line 58 of file iDynamicModelTemplate.cc.

Member Function Documentation

int iDynamicModelTemplate::CheckSpecificParameters ( )

virtual

This function is used to check whether all member variables have been correctly initialized or not.

Returns: 0 if success, positive value otherwise.

Implements vDynamicModel.

Definition at line 146 of file iDynamicModelTemplate.cc.

int iDynamicModelTemplate::EstimateImageWithModel	(	oImageSpace *	ap_Image,
		int	a_ite,
		int	a_sset
	)

virtual

Estimate image using model parametric images and basis functions.

Parameters

ap_ImageS	: pointer to the ImageSpace
a_ite	: index of the actual iteration (not used)
a_sset	: index of the actual subset (not used)

Returns: 0 if success, other value otherwise.

Implements vDynamicModel.

Definition at line 266 of file iDynamicModelTemplate.cc.

Here is the call graph for this function:

int iDynamicModelTemplate::EstimateModelParameters	(	oImageSpace *	ap_Image,
		int	a_ite,
		int	a_sset
	)

virtual

Estimate the model parametric images.

Parameters

ap_ImageS	: pointer to the ImageSpace
a_ite	: index of the actual iteration (not used)
a_sset	: index of the actual subset (not used)

Returns: 0 if success, other value otherwise.

Implements vDynamicModel.

Definition at line 209 of file iDynamicModelTemplate.cc.

Here is the call graph for this function:

int iDynamicModelTemplate::Initialize ( )

virtual

This function is used to initialize the model parametric images and basis functions.

Implements vDynamicModel.

Definition at line 171 of file iDynamicModelTemplate.cc.

int iDynamicModelTemplate::ReadAndCheckConfigurationFile ( string a_fileOptions )

virtual

This function is used to read options from a configuration file.

Parameters

a_configurationFile : ASCII file containing informations about a dynamic model

Returns: 0 if success, other value otherwise.

Implements vDynamicModel.

Definition at line 95 of file iDynamicModelTemplate.cc.

int iDynamicModelTemplate::ReadAndCheckOptionsList ( string a_listOptions )

virtual

This function is used to read parameters from a string.

Parameters

a_optionsList : a list of parameters separated by commas

Returns: 0 if success, other value otherwise.

Implements vDynamicModel.

Definition at line 121 of file iDynamicModelTemplate.cc.

int iDynamicModelTemplate::SaveParametricImages ( int a_iteration )

Write parametric images on disk.

Parameters

a_ite : index of the actual iteration

Returns: 0 if success, other value otherwise.

Definition at line 325 of file iDynamicModelTemplate.cc.

Here is the call graph for this function:

void iDynamicModelTemplate::ShowHelp ( )

virtual

This function is used to print out specific help about the deformation model and its options.

Implements vDynamicModel.

Definition at line 74 of file iDynamicModelTemplate.cc.

Member Data Documentation

FLTNB** iDynamicModelTemplate::m2p_parametricImages

protected

2 dimensions (or more if required) array containing parametric image. It must be a 2 dimensions array [nb of basis functions][nb of voxels]

Definition at line 133 of file iDynamicModelTemplate.hh.

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation