CASToR  3.2
Tomographic Reconstruction (PET/SPECT/CT)
Public Member Functions | List of all members
iDeformationTemplate Class Reference

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

#include <iDeformationTemplate.hh>

Inheritance diagram for iDeformationTemplate:
Inheritance graph
Collaboration diagram for iDeformationTemplate:
Collaboration graph

Public Member Functions

 iDeformationTemplate ()
 Constructor of iDeformationTemplate. Simply set all data members to default values. More...
 
 ~iDeformationTemplate ()
 Destructor of iDeformationTemplate. Free memory from all allocated tabs. More...
 
int ReadAndCheckConfigurationFile (const string &a_fileOptions)
 
int ReadAndCheckOptionsList (const string &a_listOptions)
 
int CheckSpecificParameters ()
 This function is an implementation of the pure virtual mother function. It is used to check parameters of the child deformation model before initialization. More...
 
int Initialize ()
 This function is an implementation of the pure virtual mother function. It is used to initialize specific stuff to the child deformation model. More...
 
void ShowHelp ()
 This function is used to print out specific help about the deformation model and its options. More...
 
int ApplyDeformations (FLTNB *ap_inputImage, FLTNB *ap_outputImage, int a_direction, int a_defIdx)
 
 iDeformationTemplate ()
 
 ~iDeformationTemplate ()
 
int ReadAndCheckConfigurationFile (const string &a_fileOptions)
 
int ReadAndCheckOptionsList (const string &a_listOptions)
 
int CheckSpecificParameters ()
 This function is used to check the parameters of the child functions before initialization if required. More...
 
int Initialize ()
 This function is used to initialize specific data related to the child deformation model.
It is pure virtual so must be implemented by children. More...
 
void ShowHelp ()
 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. More...
 
int ApplyDeformations (FLTNB *ap_inputImage, FLTNB *ap_outputImage, int a_direction, int a_defIdx)
 
- Public Member Functions inherited from vDeformation
 vDeformation ()
 Constructor of vDeformation. Simply set all data members to default values. More...
 
virtual ~vDeformation ()
 Destructor of vDeformation. More...
 
void SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)
 
void SetVerbose (int a_verbose)
 
void SetNbTransformations (int a_nbTransformations)
 
virtual int CheckParameters ()
 This function is used to check parameters after the latter have been all set using Set functions. More...
 
virtual int PerformDeformation (oImageSpace *ap_Image, int a_defIdx, int a_fr, int a_rimg, int a_cimg)
 
virtual int PerformHistoSensitivityDeformation (oImageSpace *ap_Image, int a_defIdx, int fr, int rimg, int cimg)
 
virtual int ApplyDeformationsToBackwardImage (oImageSpace *ap_Image, int a_fr, int a_defIdx)
 
virtual int ApplyDeformationsToHistoSensitivityImage (oImageSpace *ap_Image, int a_fr, int a_defIdx)
 
virtual int PerformSensitivityDeformation (oImageSpace *ap_Image, int a_defDirection, int a_defIdx, int fr, int rg, int cg)
 
int Tlerp (HPFLTNB *ap_inputImage, HPFLTNB *ap_outputImage, uint32_t iov, uint32_t iiv, FLTNB dX, FLTNB dY, FLTNB dZ)
 
 vDeformation ()
 
virtual ~vDeformation ()
 
void SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)
 
void SetVerbose (int a_verbose)
 
void SetNbTransformations (int a_nbTransformations)
 
virtual int CheckParameters ()
 
virtual int PerformDeformation (oImageSpace *ap_Image, int a_defIdx, int a_fr, int a_rimg, int a_cimg)
 
virtual int PerformHistoSensitivityDeformation (oImageSpace *ap_Image, int a_defIdx, int fr, int rimg, int cimg)
 
virtual int ApplyDeformationsToBackwardImage (oImageSpace *ap_Image, int a_fr, int a_defIdx)
 
virtual int ApplyDeformationsToHistoSensitivityImage (oImageSpace *ap_Image, int a_fr, int a_defIdx)
 
virtual int PerformSensitivityDeformation (oImageSpace *ap_Image, int a_defDirection, int a_defIdx, int fr, int rg, int cg)
 
int Tlerp (HPFLTNB *ap_inputImage, HPFLTNB *ap_outputImage, uint32_t iov, uint32_t iiv, FLTNB dX, FLTNB dY, FLTNB dZ)
 

Additional Inherited Members

- Protected Attributes inherited from vDeformation
oImageDimensionsAndQuantificationmp_ID
 
int m_verbose
 
int m_nbTransformations
 
int m_checked
 
int m_initialized
 

Detailed Description

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

Use this class to implement your own custom deformation model.

Definition at line 23 of file code/include/image/iDeformationTemplate.hh.

Constructor & Destructor Documentation

◆ iDeformationTemplate() [1/2]

iDeformationTemplate::iDeformationTemplate ( )

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

Definition at line 18 of file code/src/image/iDeformationTemplate.cc.

◆ ~iDeformationTemplate() [1/2]

iDeformationTemplate::~iDeformationTemplate ( )

Destructor of iDeformationTemplate. Free memory from all allocated tabs.

Definition at line 33 of file code/src/image/iDeformationTemplate.cc.

◆ iDeformationTemplate() [2/2]

iDeformationTemplate::iDeformationTemplate ( )

◆ ~iDeformationTemplate() [2/2]

iDeformationTemplate::~iDeformationTemplate ( )

Member Function Documentation

◆ ApplyDeformations() [1/2]

int iDeformationTemplate::ApplyDeformations ( FLTNB ap_inputImage,
FLTNB ap_outputImage,
int  a_direction,
int  a_defIdx 
)
virtual

Implements vDeformation.

Definition at line 185 of file code/src/image/iDeformationTemplate.cc.

◆ ApplyDeformations() [2/2]

int iDeformationTemplate::ApplyDeformations ( FLTNB ap_inputImage,
FLTNB ap_outputImage,
int  a_direction,
int  a_defIdx 
)
virtual

Implements vDeformation.

◆ CheckSpecificParameters() [1/2]

int iDeformationTemplate::CheckSpecificParameters ( )
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.

Implements vDeformation.

◆ CheckSpecificParameters() [2/2]

int iDeformationTemplate::CheckSpecificParameters ( )
virtual

This function is an implementation of the pure virtual mother function. It is used to check parameters of the child deformation model before initialization.

Returns
0 if success, other value otherwise.

Implements vDeformation.

Definition at line 123 of file code/src/image/iDeformationTemplate.cc.

◆ Initialize() [1/2]

int iDeformationTemplate::Initialize ( )
virtual

This function is an implementation of the pure virtual mother function. It is used to initialize specific stuff to the child deformation model.

Returns
0 if success, other value otherwise.

Implements vDeformation.

Definition at line 150 of file code/src/image/iDeformationTemplate.cc.

◆ Initialize() [2/2]

int iDeformationTemplate::Initialize ( )
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.

Implements vDeformation.

◆ ReadAndCheckConfigurationFile() [1/2]

int iDeformationTemplate::ReadAndCheckConfigurationFile ( const string &  a_fileOptions)
virtual

Implements vDeformation.

◆ ReadAndCheckConfigurationFile() [2/2]

int iDeformationTemplate::ReadAndCheckConfigurationFile ( const string &  a_fileOptions)
virtual

Implements vDeformation.

Definition at line 70 of file code/src/image/iDeformationTemplate.cc.

◆ ReadAndCheckOptionsList() [1/2]

int iDeformationTemplate::ReadAndCheckOptionsList ( const string &  a_listOptions)
virtual

Implements vDeformation.

Definition at line 97 of file code/src/image/iDeformationTemplate.cc.

◆ ReadAndCheckOptionsList() [2/2]

int iDeformationTemplate::ReadAndCheckOptionsList ( const string &  a_listOptions)
virtual

Implements vDeformation.

◆ ShowHelp() [1/2]

void iDeformationTemplate::ShowHelp ( )
virtual

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

Implements vDeformation.

Definition at line 48 of file code/src/image/iDeformationTemplate.cc.

◆ ShowHelp() [2/2]

void iDeformationTemplate::ShowHelp ( )
virtual

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.

Implements vDeformation.


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