CASToR  2.0
Tomographic Reconstruction (PET/SPECT/CT)
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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)
 This function is an implementation of the pure virtual mother function. It is used to read options from a configuration file. More...
 
int ReadAndCheckOptionsList (const string &a_listOptions)
 This function is an implementation of the pure virtual mother function. It is used to read options from a list of options. More...
 
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)
 This function is an implementation of the pure virtual mother function. The actual deformation should be implemented here. More...
 
- 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)
 Set the image dimensions in use. More...
 
void SetVerbose (int a_verbose)
 Set the verbose level. More...
 
void SetNbTransformations (int a_nbTransformations)
 Set the number of transformation in the data to be performed on the dataset (equal to the number of gates in one frame) More...
 
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)
 Apply deformations during reconstruction. More...
 
virtual int PerformDeformationBis (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)
 Apply deformations on the sensitivity image during reconstruction in histogram mode. More...
 
virtual int ApplyDeformationsToBackwardImage (oImageSpace *ap_Image, int a_fr, int a_defIdx)
 Apply backward transformation of the backward image to the reference position. More...
 
virtual int ApplyDeformationsToHistoSensitivityImage (oImageSpace *ap_Image, int a_fr, int a_defIdx)
 Apply backward transformations of the sensitivity image to the reference position (histogram mode) More...
 
virtual int PerformSensitivityDeformation (oImageSpace *ap_Image, int a_defDirection, int a_defIdx, int fr, int rg, int cg)
 Apply image deformations during sensitivity image generation for list-mode. More...
 
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 46 of file iDeformationTemplate.hh.

Constructor & Destructor Documentation

iDeformationTemplate::iDeformationTemplate ( )

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

Definition at line 41 of file iDeformationTemplate.cc.

iDeformationTemplate::~iDeformationTemplate ( )

Destructor of iDeformationTemplate. Free memory from all allocated tabs.

Definition at line 56 of file iDeformationTemplate.cc.

Member Function Documentation

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

This function is an implementation of the pure virtual mother function. The actual deformation should be implemented here.

Parameters
ap_inputImage: input image to deform
ap_outputImage: image in which the output of the deformation should be recovered
a_direction: a direction for the deformation to perform (forward or backward)
a_defIdx: index of the deformation
Returns
0 if success, other value otherwise.

Implements vDeformation.

Definition at line 208 of file iDeformationTemplate.cc.

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 146 of file iDeformationTemplate.cc.

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 173 of file iDeformationTemplate.cc.

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

This function is an implementation of the pure virtual mother function. It 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 vDeformation.

Definition at line 93 of file iDeformationTemplate.cc.

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

This function is an implementation of the pure virtual mother function. It is used to read options from a list of options.

Parameters
a_optionsList: a list of parameters separated by commas
Returns
0 if success, other value otherwise.

Implements vDeformation.

Definition at line 120 of file iDeformationTemplate.cc.

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 71 of file iDeformationTemplate.cc.


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