CASToR  1.1
Tomographic Reconstruction (PET/SPECT)
 All Classes Files Functions Variables Typedefs Macros Groups Pages
Public Member Functions | Private Member Functions | List of all members
iProjectorTemplate Class Reference

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

#include <iProjectorTemplate.hh>

Inheritance diagram for iProjectorTemplate:
Inheritance graph
Collaboration diagram for iProjectorTemplate:
Collaboration graph

Public Member Functions

 iProjectorTemplate ()
 The constructor of iProjectorTemplate. More...
 
 ~iProjectorTemplate ()
 The destructor of iProjectorTemplate. More...
 
int ReadConfigurationFile (const string &a_configurationFile)
 A function used to read options from a configuration file. More...
 
int ReadOptionsList (const string &a_optionsList)
 A function used to read options from a list of options. More...
 
INTNB EstimateMaxNumberOfVoxelsPerLine ()
 This function is used to compute and provide an estimate of the maximum number of voxels that could contribute to a projected line. More...
 
- Public Member Functions inherited from vProjector
 vProjector ()
 The constructor of vProjector. More...
 
virtual ~vProjector ()
 The destructor of vProjector. More...
 
void ShowHelp ()
 A function used to show help about the projector. More...
 
int ReadCommonOptionsList (const string &a_optionsList)
 This function is used to read options common to all projectors given as a string. More...
 
int CheckParameters ()
 A public function used to check the parameters settings. More...
 
int Initialize ()
 A public function used to initialize the projector. More...
 
int Project (int a_direction, oProjectionLine *ap_ProjectionLine, uint32_t *ap_index1, uint32_t *ap_index2, int a_nbIndices)
 A function use to computed the projection elements with respect to the provided parameters. More...
 
void SetVerbose (int a_verbose)
 Set the verbose level. More...
 
void SetScanner (vScanner *ap_Scanner)
 Set the pointer to the scanner in use. More...
 
int SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)
 Set the pointer to the image dimensions in use and copy locally some often use variables. More...
 
int SetTOFAndPOIOptions (int a_dataType, bool a_ignoreTOF, bool a_ignorePOI)
 Set the TOF use as well as POI and checks compatibility with current data type. More...
 
bool GetCompatibilityWithSPECTAttenuationCorrection ()
 

Private Member Functions

void ShowHelpSpecific ()
 A function used to show help about the child module. More...
 
int CheckSpecificParameters ()
 A private function used to check the parameters settings specific to the child projector. More...
 
int InitializeSpecific ()
 This function is used to initialize specific stuff to the child projector. More...
 
int ProjectWithoutTOF (int a_direction, oProjectionLine *ap_ProjectionLine)
 A function to project without TOF. More...
 
int ProjectWithTOFPos (int a_direction, oProjectionLine *ap_ProjectionLine)
 A function to project with TOF continuous information. More...
 
int ProjectWithTOFBin (int a_direction, oProjectionLine *ap_ProjectionLine)
 A function to project with TOF binned information. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from vProjector
static void ShowCommonHelp ()
 This function is used to print out some help about the use of options common to all projectors. It is static because it is called in main without instantiating an object. More...
 
- Protected Attributes inherited from vProjector
FLTNB mp_sizeVox [3]
 
INTNB mp_nbVox [3]
 
INTNB m_nbVoxXY
 
FLTNB mp_halfFOV [3]
 
oImageDimensionsAndQuantificationmp_ImageDimensionsAndQuantification
 
vScannermp_Scanner
 
int m_applyTOF
 
FLTNB m_TOFnbSigmas
 
bool m_applyPOI
 
bool m_compatibleWithSPECTAttenuationCorrection
 
int m_verbose
 
bool m_checked
 
bool m_initialized
 

Detailed Description

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

This class is a template squeleton providing an example of how to implement a new projector.

Definition at line 20 of file iProjectorTemplate.hh.

Constructor & Destructor Documentation

iProjectorTemplate::iProjectorTemplate ( )

The constructor of iProjectorTemplate.

This is the default and unique constructor. It does not take any parameter and its role is only to affect default values to each member of the class.

Definition at line 26 of file iProjectorTemplate.cc.

iProjectorTemplate::~iProjectorTemplate ( )

The destructor of iProjectorTemplate.

This is the default and unique destructor. It does not take any parameter and its role is only to free or delete all structures that were built by this class.

Definition at line 42 of file iProjectorTemplate.cc.

Member Function Documentation

int iProjectorTemplate::CheckSpecificParameters ( )
privatevirtual

A private function used to check the parameters settings specific to the child projector.

This function is used to check that all parameters specific to the projector are correctly set within allowed values. It is called by the CheckParameters() function of the mother class. It is the implementation of the pure virtual function inherited from the abstract mother class vProjector.

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

Implements vProjector.

Definition at line 89 of file iProjectorTemplate.cc.

INTNB iProjectorTemplate::EstimateMaxNumberOfVoxelsPerLine ( )
virtual

This function is used to compute and provide an estimate of the maximum number of voxels that could contribute to a projected line.

This function is an overloaded implementation of the virtual mother function. It is used to compute and provide an estimate of the maximum number of voxels that could contribute to a projected line.

Returns
The estimate of the maximum number of voxels contributing to a line.

Reimplemented from vProjector.

Definition at line 115 of file iProjectorTemplate.cc.

Here is the call graph for this function:

int iProjectorTemplate::InitializeSpecific ( )
privatevirtual

This function is used to initialize specific stuff to the child projector.

It is called by the public Initialize() function from the mother.

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

Implements vProjector.

Definition at line 102 of file iProjectorTemplate.cc.

int iProjectorTemplate::ProjectWithoutTOF ( int  a_direction,
oProjectionLine ap_ProjectionLine 
)
privatevirtual

A function to project without TOF.

Parameters
inta_direction
oProjectionLine*ap_ProjectionLine

Projects the provided line following the provided direction, without TOF. It fills the provided oProjectionLine. It is an implementation of the pure virtual function from the mother class.

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

Implements vProjector.

Definition at line 134 of file iProjectorTemplate.cc.

Here is the call graph for this function:

int iProjectorTemplate::ProjectWithTOFBin ( int  a_direction,
oProjectionLine ap_ProjectionLine 
)
privatevirtual

A function to project with TOF binned information.

Parameters
inta_direction
oProjectionLine*ap_ProjectionLine

Projects the provided line following the provided direction, with TOF information describe as a histogram bin. It fills the provided oProjectionLine. It is an implementation of the pure virtual function from the mother class.

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

Implements vProjector.

Definition at line 221 of file iProjectorTemplate.cc.

int iProjectorTemplate::ProjectWithTOFPos ( int  a_direction,
oProjectionLine ap_ProjectionLine 
)
privatevirtual

A function to project with TOF continuous information.

Parameters
inta_direction
oProjectionLine*ap_ProjectionLine

Projects the provided line following the provided direction, with TOF described as a continuous measurement. It fills the provided oProjectionLine. It is an implementation of the pure virtual function from the mother class.

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

Implements vProjector.

Definition at line 202 of file iProjectorTemplate.cc.

int iProjectorTemplate::ReadConfigurationFile ( const string &  a_configurationFile)
virtual

A function used to read options from a configuration file.

Parameters
conststring& a_configurationFile

This function implements the reading of all options associated to the child projector, from a configuration file. It is the implementation of the pure virtual function inherited from the abstract class vProjector. It checks the reading status but not the options values that will be checked by the CheckSpecificParameters() function.

Returns
An integer reflecting the reading success; 0 if success, another value otherwise.

Implements vProjector.

Definition at line 52 of file iProjectorTemplate.cc.

int iProjectorTemplate::ReadOptionsList ( const string &  a_optionsList)
virtual

A function used to read options from a list of options.

Parameters
conststring& a_configurationFile

This function implements the reading of all options associated to the child projector, from a list of options. It is the implementation of the pure virtual function inherited from the abstract class vProjector. It checks the reading status but not the options values that will be checked by the CheckSpecificParameters() function.

Returns
An integer reflecting the reading success; 0 if success, another value otherwise.

Implements vProjector.

Definition at line 65 of file iProjectorTemplate.cc.

void iProjectorTemplate::ShowHelpSpecific ( )
privatevirtual

A function used to show help about the child module.

This function must describe what the projector does and how to use it. It describes in details the different parameters of the projector, and how to set them through the use of a configuration file or a list of options. It is pure virtual so is implemented by children. It is private because called by the public ShowHelp() function.

Implements vProjector.

Definition at line 78 of file iProjectorTemplate.cc.


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