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

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

void	SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)

void	SetVerbose (int a_verbose)

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

virtual int	CheckSpecificParameters ()=0
	This function is used to check the parameters of the child functions before initialization if required. More...

int	ReadAndCheckConfigurationFile (string a_fileOptions)

virtual int	ReadAndCheckConfigurationFileSpecific ()=0
	This function is used to read options from a configuration file. It is pure virtual so must be implemented by children. More...

virtual int	ReadAndCheckOptionsList (string a_listOptions)=0

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

virtual int	InitializeSpecific ()=0
	A private function used to initialize everything specific to the child model. More...

virtual void	ShowHelpModelSpecific ()=0
	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...

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)

virtual int	EstimateModelParameters (oImageSpace *ap_Image, int a_ite, int a_sset)=0

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

virtual int	EstimateImageWithModel (oImageSpace *ap_Image, int a_ite, int a_sset)=0

int	SaveParametricImages (int a_iteration, int a_subset=-1)

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)

int	NNLS (FLTNB *A, int m, int n, FLTNB B, FLTNB X, FLTNB rnorm, FLTNB wp, FLTNB zzp, int *indexp)

	vDynamicModel ()

virtual	~vDynamicModel ()

void	SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)

void	SetVerbose (int a_verbose)

virtual int	CheckParameters ()

virtual int	CheckSpecificParameters ()=0

int	ReadAndCheckConfigurationFile (string a_fileOptions)

virtual int	ReadAndCheckConfigurationFileSpecific ()=0

virtual int	ReadAndCheckOptionsList (string a_listOptions)=0

int	Initialize ()

virtual int	InitializeSpecific ()=0

virtual void	ShowHelpModelSpecific ()=0

void	ShowHelp ()

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

virtual int	EstimateModelParameters (oImageSpace *ap_Image, int a_ite, int a_sset)=0

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

virtual int	EstimateImageWithModel (oImageSpace *ap_Image, int a_ite, int a_sset)=0

int	SaveParametricImages (int a_iteration, int a_subset=-1)

virtual int	ApplyOutputFOVMaskingOnParametricImages ()

bool	GetAICflag ()

bool	GetModelBasisFunctionsRequiredFlag ()

int	GetNbTimeBasisFunctions ()

FLTNB **	GetTimeBasisFunctions ()

virtual void	ComputeOutputParImage ()

void	SetUseModelInReconstruction (bool a_useModelInReconstruction)

int	NNLS (FLTNB *A, int m, int n, FLTNB B, FLTNB X, FLTNB rnorm, FLTNB wp, FLTNB zzp, int *indexp)

Protected Attributes
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

Private Member Functions
int	NNLS_LSS_H12 (int mode, int lpivot, int l1, int m, FLTNB u, int u_dim1, FLTNB up, FLTNB *cm, int ice, int icv, int ncv)

void	NNLS_LSS_G1 (FLTNB a, FLTNB b, FLTNB cterm, FLTNB sterm, FLTNB *sig)

int	NNLS_LSS_H12 (int mode, int lpivot, int l1, int m, FLTNB u, int u_dim1, FLTNB up, FLTNB *cm, int ice, int icv, int ncv)

void	NNLS_LSS_G1 (FLTNB a, FLTNB b, FLTNB cterm, FLTNB sterm, FLTNB *sig)

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 EstimateImageWithModel() 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)
EstimateImageWithModel(): Fit the dynamic model to the series of dynamic images

Definition at line 40 of file code/include/dynamic/vDynamicModel.hh.

Constructor & Destructor Documentation

◆ vDynamicModel() [1/2]

vDynamicModel::vDynamicModel ( )

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

Definition at line 18 of file code/src/dynamic/vDynamicModel.cc.

◆ ~vDynamicModel() [1/2]

vDynamicModel::~vDynamicModel ( )

virtual

Destructor of vDynamicModel.

Definition at line 67 of file code/src/dynamic/vDynamicModel.cc.

◆ vDynamicModel() [2/2]

vDynamicModel::vDynamicModel ( )

◆ ~vDynamicModel() [2/2]

virtual vDynamicModel::~vDynamicModel ( )

virtual

Member Function Documentation

◆ ApplyOutputFOVMaskingOnParametricImages() [1/2]

int vDynamicModel::ApplyOutputFOVMaskingOnParametricImages ( )

virtual

Mask the outside of the transaxial FOV based on the m_fovOutPercent.

Similar to the eponym function in ImageSpace, but on parametric images

Definition at line 306 of file code/src/dynamic/vDynamicModel.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ApplyOutputFOVMaskingOnParametricImages() [2/2]

virtual int vDynamicModel::ApplyOutputFOVMaskingOnParametricImages ( )

virtual

◆ CheckParameters() [1/2]

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 126 of file code/src/dynamic/vDynamicModel.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckParameters() [2/2]

virtual int vDynamicModel::CheckParameters ( )

virtual

◆ CheckSpecificParameters() [1/2]

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 i1TCModel, i1TCModel, iLinearModel, iLinearModel, iLinearModelTemplate, iLinearModelTemplate, iLinearPatlakModel, iLinearPatlakModel, iLinearSpectralModel, iLinearSpectralModel, iDynamicModelTemplate, and iDynamicModelTemplate.

Here is the caller graph for this function:

◆ CheckSpecificParameters() [2/2]

virtual int vDynamicModel::CheckSpecificParameters ( )

pure virtual

Implemented in i1TCModel, i1TCModel, iLinearModel, iLinearModel, iLinearModelTemplate, iLinearModelTemplate, iLinearPatlakModel, iLinearPatlakModel, iLinearSpectralModel, iLinearSpectralModel, iDynamicModelTemplate, and iDynamicModelTemplate.

◆ ComputeOutputParImage() [1/2]

void vDynamicModel::ComputeOutputParImage ( )

virtual

Compute output image using the m2p_parametricImages matrix Store the result in the m2p_outputParImages matrix.

Definition at line 271 of file code/src/dynamic/vDynamicModel.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ComputeOutputParImage() [2/2]

virtual void vDynamicModel::ComputeOutputParImage ( )

virtual

◆ EstimateImage() [1/2]

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

virtual

◆ EstimateImage() [2/2]

int vDynamicModel::EstimateImage	(	oImageSpace *	ap_Image,
		int	a_ite,
		int	a_sset
	)

virtual

Definition at line 458 of file code/src/dynamic/vDynamicModel.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EstimateImageWithModel() [1/2]

virtual int vDynamicModel::EstimateImageWithModel	(	oImageSpace *	ap_Image,
		int	a_ite,
		int	a_sset
	)

pure virtual

Implemented in iLinearModel, iLinearModel, i1TCModel, i1TCModel, iDynamicModelTemplate, and iDynamicModelTemplate.

◆ EstimateImageWithModel() [2/2]

virtual int vDynamicModel::EstimateImageWithModel	(	oImageSpace *	ap_Image,
		int	a_ite,
		int	a_sset
	)

pure virtual

Implemented in iLinearModel, iLinearModel, i1TCModel, i1TCModel, iDynamicModelTemplate, and iDynamicModelTemplate.

Here is the caller graph for this function:

◆ EstimateModel() [1/2]

virtual int vDynamicModel::EstimateModel	(	oImageSpace *	ap_Image,
		int	a_ite,
		int	a_sset
	)

virtual

◆ EstimateModel() [2/2]

int vDynamicModel::EstimateModel	(	oImageSpace *	ap_Image,
		int	a_ite,
		int	a_sset
	)

virtual

Definition at line 420 of file code/src/dynamic/vDynamicModel.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EstimateModelParameters() [1/2]

virtual int vDynamicModel::EstimateModelParameters	(	oImageSpace *	ap_Image,
		int	a_ite,
		int	a_sset
	)

pure virtual

Implemented in iLinearModel, iLinearModel, i1TCModel, i1TCModel, iDynamicModelTemplate, and iDynamicModelTemplate.

◆ EstimateModelParameters() [2/2]

virtual int vDynamicModel::EstimateModelParameters	(	oImageSpace *	ap_Image,
		int	a_ite,
		int	a_sset
	)

pure virtual

Implemented in iLinearModel, iLinearModel, i1TCModel, i1TCModel, iDynamicModelTemplate, and iDynamicModelTemplate.

Here is the caller graph for this function:

◆ GetAICflag() [1/2]

bool vDynamicModel::GetAICflag ( )

inline

Definition at line 208 of file code/include/dynamic/vDynamicModel.hh.

◆ GetAICflag() [2/2]

bool vDynamicModel::GetAICflag ( )

inline

Definition at line 208 of file include/dynamic/vDynamicModel.hh.

◆ GetModelBasisFunctionsRequiredFlag() [1/2]

bool vDynamicModel::GetModelBasisFunctionsRequiredFlag ( )

inline

Definition at line 213 of file code/include/dynamic/vDynamicModel.hh.

Here is the caller graph for this function:

◆ GetModelBasisFunctionsRequiredFlag() [2/2]

bool vDynamicModel::GetModelBasisFunctionsRequiredFlag ( )

inline

Definition at line 213 of file include/dynamic/vDynamicModel.hh.

◆ GetNbTimeBasisFunctions() [1/2]

int vDynamicModel::GetNbTimeBasisFunctions ( )

inline

Definition at line 218 of file code/include/dynamic/vDynamicModel.hh.

Here is the caller graph for this function:

◆ GetNbTimeBasisFunctions() [2/2]

int vDynamicModel::GetNbTimeBasisFunctions ( )

inline

Definition at line 218 of file include/dynamic/vDynamicModel.hh.

◆ GetTimeBasisFunctions() [1/2]

FLTNB** vDynamicModel::GetTimeBasisFunctions ( )

inline

Definition at line 223 of file include/dynamic/vDynamicModel.hh.

Here is the call graph for this function:

◆ GetTimeBasisFunctions() [2/2]

FLTNB** vDynamicModel::GetTimeBasisFunctions ( )

inline

Definition at line 223 of file code/include/dynamic/vDynamicModel.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialize() [1/2]

int vDynamicModel::Initialize ( )

A public function used to initialize the dynamic model.

This function does not take any parameter and is used to initialize everything that is generic and required for all models. At the end, it calls the pure virtual InitializeSpecific() function implemented by children models.

Returns: 0 if success, other value otherwise.

Definition at line 193 of file code/src/dynamic/vDynamicModel.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialize() [2/2]

int vDynamicModel::Initialize ( )

◆ InitializeSpecific() [1/2]

virtual int vDynamicModel::InitializeSpecific ( )

pure virtual

Implemented in iLinearModel, iLinearModel, i1TCModel, i1TCModel, iLinearModelTemplate, iLinearModelTemplate, iLinearPatlakModel, iLinearPatlakModel, iLinearSpectralModel, iLinearSpectralModel, iDynamicModelTemplate, and iDynamicModelTemplate.

◆ InitializeSpecific() [2/2]

vDynamicModel::InitializeSpecific ( )

pure virtual

A private function used to initialize everything specific to the child model.

This function is used to initialize everything specific to the model that should be initialized. It is called by the Initialize() function. It is pure virtual so is implemented only by children.

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

Implemented in iLinearModel, iLinearModel, i1TCModel, i1TCModel, iLinearModelTemplate, iLinearModelTemplate, iLinearPatlakModel, iLinearPatlakModel, iLinearSpectralModel, iLinearSpectralModel, iDynamicModelTemplate, and iDynamicModelTemplate.

Here is the caller graph for this function:

◆ NNLS() [1/2]

int vDynamicModel::NNLS	(	FLTNB **	A,
		int	m,
		int	n,
		FLTNB *	B,
		FLTNB *	X,
		FLTNB *	rnorm,
		FLTNB *	wp,
		FLTNB *	zzp,
		int *	indexp
	)

Definition at line 842 of file code/src/dynamic/vDynamicModel.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NNLS() [2/2]

int vDynamicModel::NNLS	(	FLTNB **	A,
		int	m,
		int	n,
		FLTNB *	B,
		FLTNB *	X,
		FLTNB *	rnorm,
		FLTNB *	wp,
		FLTNB *	zzp,
		int *	indexp
	)

◆ NNLS_LSS_G1() [1/2]

void vDynamicModel::NNLS_LSS_G1	(	FLTNB	a,
		FLTNB	b,
		FLTNB *	cterm,
		FLTNB *	sterm,
		FLTNB *	sig
	)

private

◆ NNLS_LSS_G1() [2/2]

void vDynamicModel::NNLS_LSS_G1	(	FLTNB	a,
		FLTNB	b,
		FLTNB *	cterm,
		FLTNB *	sterm,
		FLTNB *	sig
	)

private

Definition at line 1257 of file code/src/dynamic/vDynamicModel.cc.

Here is the caller graph for this function:

◆ NNLS_LSS_H12() [1/2]

int vDynamicModel::NNLS_LSS_H12	(	int	mode,
		int	lpivot,
		int	l1,
		int	m,
		FLTNB *	u,
		int	u_dim1,
		FLTNB *	up,
		FLTNB *	cm,
		int	ice,
		int	icv,
		int	ncv
	)

private

◆ NNLS_LSS_H12() [2/2]

int vDynamicModel::NNLS_LSS_H12	(	int	mode,
		int	lpivot,
		int	l1,
		int	m,
		FLTNB *	u,
		int	u_dim1,
		FLTNB *	up,
		FLTNB *	cm,
		int	ice,
		int	icv,
		int	ncv
	)

private

Definition at line 1158 of file code/src/dynamic/vDynamicModel.cc.

Here is the caller graph for this function:

◆ ReadAndCheckConfigurationFile() [1/2]

int vDynamicModel::ReadAndCheckConfigurationFile ( string a_fileOptions )

Definition at line 496 of file code/src/dynamic/vDynamicModel.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadAndCheckConfigurationFile() [2/2]

int vDynamicModel::ReadAndCheckConfigurationFile ( string a_fileOptions )

◆ ReadAndCheckConfigurationFileSpecific() [1/2]

virtual int vDynamicModel::ReadAndCheckConfigurationFileSpecific ( )

pure virtual

Implemented in i1TCModel, i1TCModel, iLinearModel, iLinearModel, iLinearModelTemplate, iLinearModelTemplate, iLinearPatlakModel, iLinearPatlakModel, iLinearSpectralModel, iLinearSpectralModel, iDynamicModelTemplate, and iDynamicModelTemplate.

◆ ReadAndCheckConfigurationFileSpecific() [2/2]

vDynamicModel::ReadAndCheckConfigurationFileSpecific ( )

pure virtual

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

Returns: 0 if success, other value otherwise.

Implemented in i1TCModel, i1TCModel, iLinearModel, iLinearModel, iLinearModelTemplate, iLinearModelTemplate, iLinearPatlakModel, iLinearPatlakModel, iLinearSpectralModel, iLinearSpectralModel, iDynamicModelTemplate, and iDynamicModelTemplate.

Here is the caller graph for this function:

◆ ReadAndCheckOptionsList() [1/2]

virtual int vDynamicModel::ReadAndCheckOptionsList ( string a_listOptions )

pure virtual

Implemented in i1TCModel, i1TCModel, iLinearModel, iLinearModel, iLinearModelTemplate, iLinearModelTemplate, iLinearPatlakModel, iLinearPatlakModel, iLinearSpectralModel, iLinearSpectralModel, iDynamicModelTemplate, and iDynamicModelTemplate.

◆ ReadAndCheckOptionsList() [2/2]

virtual int vDynamicModel::ReadAndCheckOptionsList ( string a_listOptions )

pure virtual

Implemented in i1TCModel, i1TCModel, iLinearModel, iLinearModel, iLinearModelTemplate, iLinearModelTemplate, iLinearPatlakModel, iLinearPatlakModel, iLinearSpectralModel, iLinearSpectralModel, iDynamicModelTemplate, and iDynamicModelTemplate.

Here is the caller graph for this function:

◆ SaveParametricImages() [1/2]

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

◆ SaveParametricImages() [2/2]

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

Definition at line 660 of file code/src/dynamic/vDynamicModel.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetImageDimensionsAndQuantification() [1/2]

void vDynamicModel::SetImageDimensionsAndQuantification ( oImageDimensionsAndQuantification * ap_ImageDimensionsAndQuantification )

inline

Definition at line 65 of file include/dynamic/vDynamicModel.hh.

◆ SetImageDimensionsAndQuantification() [2/2]

void vDynamicModel::SetImageDimensionsAndQuantification ( oImageDimensionsAndQuantification * ap_ImageDimensionsAndQuantification )

inline

Definition at line 65 of file code/include/dynamic/vDynamicModel.hh.

Here is the caller graph for this function:

◆ SetUseModelInReconstruction() [1/2]

void vDynamicModel::SetUseModelInReconstruction ( bool a_useModelInReconstruction )

inline

Definition at line 236 of file code/include/dynamic/vDynamicModel.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetUseModelInReconstruction() [2/2]

void vDynamicModel::SetUseModelInReconstruction ( bool a_useModelInReconstruction )

inline

Definition at line 236 of file include/dynamic/vDynamicModel.hh.

Here is the call graph for this function:

◆ SetVerbose() [1/2]

void vDynamicModel::SetVerbose ( int a_verbose )

inline

Definition at line 72 of file code/include/dynamic/vDynamicModel.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetVerbose() [2/2]

void vDynamicModel::SetVerbose ( int a_verbose )

inline

Definition at line 72 of file include/dynamic/vDynamicModel.hh.

Here is the call graph for this function:

◆ ShowHelp() [1/2]

void vDynamicModel::ShowHelp ( )

This function is used to print out general help about dynamic models.

Definition at line 95 of file code/src/dynamic/vDynamicModel.cc.

Here is the caller graph for this function:

◆ ShowHelp() [2/2]

void vDynamicModel::ShowHelp ( )

◆ ShowHelpModelSpecific() [1/2]

vDynamicModel::ShowHelpModelSpecific ( )

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

Implemented in iLinearModel, iLinearModel, i1TCModel, i1TCModel, iLinearModelTemplate, iLinearModelTemplate, iLinearPatlakModel, iLinearPatlakModel, iLinearSpectralModel, iLinearSpectralModel, iDynamicModelTemplate, and iDynamicModelTemplate.

Here is the caller graph for this function:

◆ ShowHelpModelSpecific() [2/2]

virtual void vDynamicModel::ShowHelpModelSpecific ( )

pure virtual

Implemented in iLinearModel, iLinearModel, i1TCModel, i1TCModel, iLinearModelTemplate, iLinearModelTemplate, iLinearPatlakModel, iLinearPatlakModel, iLinearSpectralModel, iLinearSpectralModel, iDynamicModelTemplate, and iDynamicModelTemplate.

Member Data Documentation

◆ m2p_CGParametricImages

FLTNB ** vDynamicModel::m2p_CGParametricImages

protected

Image matrix containing the parametric images of the cardiac gating model
2 pointers:
1: Parametric image related to the cardiac gating model basis functions.
2: 3D voxels

Definition at line 392 of file code/include/dynamic/vDynamicModel.hh.

◆ m2p_nestedModelTimeBasisFunctions

FLTNB ** vDynamicModel::m2p_nestedModelTimeBasisFunctions

protected

Vector containing the Model temporal basis functions
2 pointers:
1: index of the temporal function
2: coefficient of the functions for each time points of a dynamic acquisition

Definition at line 374 of file code/include/dynamic/vDynamicModel.hh.

◆ m2p_nnlsB

FLTNB ** vDynamicModel::m2p_nnlsB

protected

1D vector for NNLS estimation, containing the solution (multithreaded), dims must be [nb_th][nb_samples]

Definition at line 421 of file code/include/dynamic/vDynamicModel.hh.

◆ m2p_nnlsIdx

int ** vDynamicModel::m2p_nnlsIdx

protected

Working space array for NNLS estimation (multithreaded) dims must be [nb_th][m_nnlsN]

Definition at line 425 of file code/include/dynamic/vDynamicModel.hh.

◆ m2p_nnlsMat

FLTNB ** vDynamicModel::m2p_nnlsMat

protected

1D working vector for NNLS estimation (multithreaded) dims must be [nb_th][ (m_nnlsN+2)*nb_samples ]

Definition at line 422 of file code/include/dynamic/vDynamicModel.hh.

◆ m2p_nnlsWp

FLTNB ** vDynamicModel::m2p_nnlsWp

protected

Working space array for NNLS estimation (multithreaded) dims must be [nb_th][m_nnlsN]

Definition at line 424 of file code/include/dynamic/vDynamicModel.hh.

◆ m2p_nnlsX

FLTNB ** vDynamicModel::m2p_nnlsX

protected

1D solution vector for NNLS estimation (multithreaded) dims must be [nb_th][m_nnlsN]

Definition at line 423 of file code/include/dynamic/vDynamicModel.hh.

◆ m2p_outputParImages

FLTNB ** vDynamicModel::m2p_outputParImages

protected

Image matrix to gather the parametric image before writing on disk
By default it will point directly to the parametric m2p_parametricImages.
They are allocated if post-processing are enabled before writing the image (i.e FOV masking)
2 pointers:
1: Parametric image related to the dynamic model basis functions.
2: 3D voxels

Definition at line 380 of file code/include/dynamic/vDynamicModel.hh.

◆ m2p_parametricImages

FLTNB ** vDynamicModel::m2p_parametricImages

protected

Image matrix containing the parametric images
2 pointers:
1: Parametric image related to the dynamic model basis functions.
2: 3D voxels

Definition at line 365 of file code/include/dynamic/vDynamicModel.hh.

◆ m2p_RGParametricImages

FLTNB ** vDynamicModel::m2p_RGParametricImages

protected

Image matrix containing the parametric images of the respiratory gating model
2 pointers:
1: Parametric image related to the respiratory gating model basis functions.
2: 3D voxels

Definition at line 387 of file code/include/dynamic/vDynamicModel.hh.

◆ m3p_nnlsA

FLTNB *** vDynamicModel::m3p_nnlsA

protected

2D coefficient matrix for NNLS estimation (multithreaded), dims must be [nb_th][m_nnlsN][nb_samples]

Definition at line 420 of file code/include/dynamic/vDynamicModel.hh.

◆ m_AICfile

string vDynamicModel::m_AICfile

protected

The file containing the data of the sampled Arterial Input Curve

Definition at line 361 of file code/include/dynamic/vDynamicModel.hh.

◆ m_AICfileProvided

bool vDynamicModel::m_AICfileProvided

protected

Flag indicating that an AIC file has been provided instead of Time Basis Functions

Definition at line 405 of file code/include/dynamic/vDynamicModel.hh.

◆ m_checked

bool vDynamicModel::m_checked

protected

Boolean indicating whether the parameters were checked or not

Definition at line 400 of file code/include/dynamic/vDynamicModel.hh.

◆ m_fileOptions

string vDynamicModel::m_fileOptions

protected

Path to a configuration file

Definition at line 397 of file code/include/dynamic/vDynamicModel.hh.

◆ m_initialized

bool vDynamicModel::m_initialized

protected

Boolean indicating whether the manager was initialized or not

Definition at line 401 of file code/include/dynamic/vDynamicModel.hh.

◆ m_listOptions

string vDynamicModel::m_listOptions

protected

String containing a list of options

Definition at line 398 of file code/include/dynamic/vDynamicModel.hh.

◆ m_ModelSpecificBasisFunctionsRequired

bool vDynamicModel::m_ModelSpecificBasisFunctionsRequired

protected

Flag indicating if model specific Time Basis Functions are required

Definition at line 406 of file code/include/dynamic/vDynamicModel.hh.

◆ m_nbCGModelParam

int vDynamicModel::m_nbCGModelParam

protected

Number of cardiac model parameters

Definition at line 359 of file code/include/dynamic/vDynamicModel.hh.

◆ m_nbModelParam

int vDynamicModel::m_nbModelParam

protected

Number of dynamic model parameters

Definition at line 357 of file code/include/dynamic/vDynamicModel.hh.

◆ m_nbRGModelParam

int vDynamicModel::m_nbRGModelParam

protected

Number of respiratory model parameters

Definition at line 358 of file code/include/dynamic/vDynamicModel.hh.

◆ m_nbTimeBF

int vDynamicModel::m_nbTimeBF

protected

Number of time basis functions in the model

Definition at line 355 of file code/include/dynamic/vDynamicModel.hh.

◆ m_nbVoxelsMask

INTNB vDynamicModel::m_nbVoxelsMask

protected

Number of voxels in mask

Definition at line 416 of file code/include/dynamic/vDynamicModel.hh.

◆ m_nbWeightFactors

int vDynamicModel::m_nbWeightFactors

protected

Number of weight factors for WLS optimisation

Definition at line 356 of file code/include/dynamic/vDynamicModel.hh.

◆ m_nnlsN

uint16_t vDynamicModel::m_nnlsN =0

protected

Number of parameters in NNLS estimation

Definition at line 427 of file code/include/dynamic/vDynamicModel.hh.

◆ m_noImageUpdateFlag

bool vDynamicModel::m_noImageUpdateFlag

protected

If true, the reconstructed images are not estimated from the parametric images, the EstimateImageWithModel() functions is not called so the class only estimate parametric images from each current estimation of the images (default=false)

Definition at line 408 of file code/include/dynamic/vDynamicModel.hh.

◆ m_noParametersUpdateFlag

bool vDynamicModel::m_noParametersUpdateFlag

protected

If true, the parameters are not estimated from the serie of dynamic images, the EstimateModelParameters() functions is not called (default=false)

Definition at line 412 of file code/include/dynamic/vDynamicModel.hh.

◆ m_saveBlacklistedImageMaskFlag

bool vDynamicModel::m_saveBlacklistedImageMaskFlag

protected

Flag indicating if the blacklisted voxels mask image should be written on disk

Definition at line 404 of file code/include/dynamic/vDynamicModel.hh.

◆ m_saveParImageFlag

bool vDynamicModel::m_saveParImageFlag

protected

Flag indicating if parametric images should be written on disk (default=true)

Definition at line 403 of file code/include/dynamic/vDynamicModel.hh.

◆ m_startIteUpdateFlag

int vDynamicModel::m_startIteUpdateFlag

protected

Number of iterations after which the reconstructed images are estimated from the parametric images. (default or negative value =0)

Definition at line 414 of file code/include/dynamic/vDynamicModel.hh.

◆ m_useModelInReconstruction

bool vDynamicModel::m_useModelInReconstruction

protected

Flag indicating if the model is used with castor-recon or with imageDynamicTools

Definition at line 402 of file code/include/dynamic/vDynamicModel.hh.

◆ m_verbose

int vDynamicModel::m_verbose

protected

The verbose level

Definition at line 354 of file code/include/dynamic/vDynamicModel.hh.

◆ mp_ArterialInputCurve

oArterialInputCurve * vDynamicModel::mp_ArterialInputCurve

protected

oArterialInputCurve object related to processing of Arterial Input Curves

Definition at line 362 of file code/include/dynamic/vDynamicModel.hh.

◆ mp_blackListedvoxelsImage

FLTNB * vDynamicModel::mp_blackListedvoxelsImage

protected

Image matrix containing the voxels which the model cannot fit
1 pointer:
1: 3D voxels

Definition at line 370 of file code/include/dynamic/vDynamicModel.hh.

◆ mp_ID

oImageDimensionsAndQuantification * vDynamicModel::mp_ID

protected

Pointer to the oImageDimensionsAndQuantification object in use

Definition at line 353 of file code/include/dynamic/vDynamicModel.hh.

◆ mp_maskModel

FLTNB * vDynamicModel::mp_maskModel

protected

Input image containing a mask defining in which voxels the model must be applied (1) or not (0). Default: all voxels to 1

Definition at line 415 of file code/include/dynamic/vDynamicModel.hh.

◆ mp_w

FLTNB * vDynamicModel::mp_w

protected

Vector containing the weights for NNLS estimation

Definition at line 419 of file code/include/dynamic/vDynamicModel.hh.

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

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ vDynamicModel() [1/2]

◆ ~vDynamicModel() [1/2]

◆ vDynamicModel() [2/2]

◆ ~vDynamicModel() [2/2]

Member Function Documentation

◆ ApplyOutputFOVMaskingOnParametricImages() [1/2]

◆ ApplyOutputFOVMaskingOnParametricImages() [2/2]

◆ CheckParameters() [1/2]

◆ CheckParameters() [2/2]

◆ CheckSpecificParameters() [1/2]

◆ CheckSpecificParameters() [2/2]

◆ ComputeOutputParImage() [1/2]

◆ ComputeOutputParImage() [2/2]

◆ EstimateImage() [1/2]

◆ EstimateImage() [2/2]

◆ EstimateImageWithModel() [1/2]

◆ EstimateImageWithModel() [2/2]

◆ EstimateModel() [1/2]

◆ EstimateModel() [2/2]

◆ EstimateModelParameters() [1/2]

◆ EstimateModelParameters() [2/2]

◆ GetAICflag() [1/2]

◆ GetAICflag() [2/2]

◆ GetModelBasisFunctionsRequiredFlag() [1/2]

◆ GetModelBasisFunctionsRequiredFlag() [2/2]

◆ GetNbTimeBasisFunctions() [1/2]

◆ GetNbTimeBasisFunctions() [2/2]

◆ GetTimeBasisFunctions() [1/2]

◆ GetTimeBasisFunctions() [2/2]

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ InitializeSpecific() [1/2]

◆ InitializeSpecific() [2/2]

◆ NNLS() [1/2]

◆ NNLS() [2/2]

◆ NNLS_LSS_G1() [1/2]

◆ NNLS_LSS_G1() [2/2]

◆ NNLS_LSS_H12() [1/2]

◆ NNLS_LSS_H12() [2/2]

◆ ReadAndCheckConfigurationFile() [1/2]

◆ ReadAndCheckConfigurationFile() [2/2]

◆ ReadAndCheckConfigurationFileSpecific() [1/2]

◆ ReadAndCheckConfigurationFileSpecific() [2/2]

◆ ReadAndCheckOptionsList() [1/2]

◆ ReadAndCheckOptionsList() [2/2]

◆ SaveParametricImages() [1/2]

◆ SaveParametricImages() [2/2]

◆ SetImageDimensionsAndQuantification() [1/2]

◆ SetImageDimensionsAndQuantification() [2/2]

◆ SetUseModelInReconstruction() [1/2]

◆ SetUseModelInReconstruction() [2/2]

◆ SetVerbose() [1/2]

◆ SetVerbose() [2/2]

◆ ShowHelp() [1/2]

◆ ShowHelp() [2/2]

◆ ShowHelpModelSpecific() [1/2]

◆ ShowHelpModelSpecific() [2/2]

Member Data Documentation

◆ m2p_CGParametricImages

◆ m2p_nestedModelTimeBasisFunctions

◆ m2p_nnlsB

◆ m2p_nnlsIdx

◆ m2p_nnlsMat

◆ m2p_nnlsWp

◆ m2p_nnlsX

◆ m2p_outputParImages

◆ m2p_parametricImages

◆ m2p_RGParametricImages

◆ m3p_nnlsA

◆ m_AICfile

◆ m_AICfileProvided

◆ m_checked

◆ m_fileOptions

◆ m_initialized

◆ m_listOptions