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	ReadAndCheckConfigurationFileSpecific ()
	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	InitializeSpecific ()
	This function is used to initialize the model parametric images and basis functions. More...

void	ShowHelpModelSpecific ()
	This function is used to print out specific help about the dynamic model and its options. It is pure virtual so must be implemented by children. 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...

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

int	ReadAndCheckConfigurationFile (string a_fileOptions)
	This function is used to read options from a configuration file. It looks for the parameters implemented by the mother class, such as 'No_image_update', 'No_parameters_update', or 'Save_parametric_images'. More...

int	Initialize ()
	A public function used to initialize the dynamic model. More...

void	ShowHelp ()
	This function is used to print out general help about dynamic models. More...

virtual int	EstimateModel (oImageSpace *ap_Image, int a_ite, int a_sset)
	This function checks if the EstimateModelParameters() function (specific to each model) must be called at this stage of the reconstruction depending on the m_xxxUpdateflags. More...

virtual int	EstimateImage (oImageSpace *ap_Image, int a_ite, int a_sset)

int	SaveParametricImages (int a_iteration, int a_subset=-1)
	This function is virtual it can be overloaded by children if required. More...

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

bool	GetAICflag ()

bool	GetModelBasisFunctionsRequiredFlag ()

int	GetNbTimeBasisFunctions ()

FLTNB **	GetTimeBasisFunctions ()

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

void	SetUseModelInReconstruction (bool a_useModelInReconstruction)
	Set flag to indicate if the dynamic model is used in the tomographic reconstruction. More...

int	NNLS (FLTNB *A, int m, int n, FLTNB B, FLTNB X, FLTNB rnorm, FLTNB wp, FLTNB zzp, int *indexp)
	Implementation of NNLS (non-negative least squares) algorithm Derived from Turku PET center libraries (authors: Vesa Oikonen and Kaisa Sederholm) This routine is based on the text and fortran code in C.L. Lawson and R.J. Hanson, Solving Least Squares Problems, Prentice-Hall, Englewood Cliffs, New Jersey, 1974. More...

Protected Attributes
FLTNB **	m2p_parametricImages

Protected Attributes inherited from vDynamicModel
oImageDimensionsAndQuantification *	mp_ID

int	m_verbose

int	m_nbTimeBF

int	m_nbWeightFactors

int	m_nbModelParam

int	m_nbRGModelParam

int	m_nbCGModelParam

string	m_AICfile

oArterialInputCurve *	mp_ArterialInputCurve

FLTNB **	m2p_parametricImages

FLTNB *	mp_blackListedvoxelsImage

FLTNB **	m2p_nestedModelTimeBasisFunctions

FLTNB **	m2p_outputParImages

FLTNB **	m2p_RGParametricImages

FLTNB **	m2p_CGParametricImages

string	m_fileOptions

string	m_listOptions

bool	m_checked

bool	m_initialized

bool	m_useModelInReconstruction

bool	m_saveParImageFlag

bool	m_saveBlacklistedImageMaskFlag

bool	m_AICfileProvided

bool	m_ModelSpecificBasisFunctionsRequired

bool	m_noImageUpdateFlag

bool	m_noParametersUpdateFlag

int	m_startIteUpdateFlag

FLTNB *	mp_maskModel

INTNB	m_nbVoxelsMask

FLTNB *	mp_w

FLTNB ***	m3p_nnlsA

FLTNB **	m2p_nnlsB

FLTNB **	m2p_nnlsMat

FLTNB **	m2p_nnlsX

FLTNB **	m2p_nnlsWp

int **	m2p_nnlsIdx

uint16_t	m_nnlsN =0

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 43 of file iDynamicModelTemplate.hh.

Constructor & Destructor Documentation

◆ iDynamicModelTemplate()

iDynamicModelTemplate::iDynamicModelTemplate ( )

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

<

Definition at line 40 of file iDynamicModelTemplate.cc.

◆ ~iDynamicModelTemplate()

iDynamicModelTemplate::~iDynamicModelTemplate ( )

Destructor of iDynamicModelTemplate.

Definition at line 129 of file iDynamicModelTemplate.cc.

Member Function Documentation

◆ CheckSpecificParameters()

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 221 of file iDynamicModelTemplate.cc.

◆ EstimateImageWithModel()

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 343 of file iDynamicModelTemplate.cc.

Here is the call graph for this function:

◆ EstimateModelParameters()

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 284 of file iDynamicModelTemplate.cc.

Here is the call graph for this function:

◆ InitializeSpecific()

int iDynamicModelTemplate::InitializeSpecific ( )

virtual

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

Returns: 0 if success, other value otherwise.

Implements vDynamicModel.

Definition at line 246 of file iDynamicModelTemplate.cc.

◆ ReadAndCheckConfigurationFileSpecific()

int iDynamicModelTemplate::ReadAndCheckConfigurationFileSpecific ( )

virtual

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

Returns: 0 if success, other value otherwise.

Implements vDynamicModel.

Definition at line 169 of file iDynamicModelTemplate.cc.

◆ ReadAndCheckOptionsList()

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 196 of file iDynamicModelTemplate.cc.

◆ ShowHelpModelSpecific()

void iDynamicModelTemplate::ShowHelpModelSpecific ( )

virtual

This function is used to print out specific help about the dynamic model and its options. It is pure virtual so must be implemented by children.

Implements vDynamicModel.

Definition at line 149 of file iDynamicModelTemplate.cc.

Member Data Documentation

◆ m2p_parametricImages

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 131 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

◆ iDynamicModelTemplate()

◆ ~iDynamicModelTemplate()

Member Function Documentation

◆ CheckSpecificParameters()

◆ EstimateImageWithModel()

◆ EstimateModelParameters()

◆ InitializeSpecific()

◆ ReadAndCheckConfigurationFileSpecific()

◆ ReadAndCheckOptionsList()

◆ ShowHelpModelSpecific()

Member Data Documentation

◆ m2p_parametricImages