This class is designed to generically described any on-the-fly projector. More...

#include <vProjector.hh>

Inheritance diagram for vProjector:

Collaboration diagram for vProjector:

Public Member Functions
	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...

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

virtual int	ReadConfigurationFile (const string &a_configurationFile)=0
	A function used to read options from a configuration file. More...

virtual int	ReadOptionsList (const string &a_optionsList)=0
	A function used to read options from a list of options. 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...

void	SetSensitivityMode (bool a_sensitivityMode)
	Set the sensitivity mode on or off. More...

void	SetApplyTOF (int a_applyTOF)
	Set the TOF mode. More...

void	SetApplyPOI (bool a_applyPOI)
	Set the POI mode. More...

int	SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)
	Set the pointer to the image dimensions in use and copy locally some often use variables. More...

bool	GetCompatibilityWithSPECTAttenuationCorrection ()

bool	GetCompatibilityWithCompression ()

void	SetMask (bool *ap_mask)
	Set a mask for voxels. More...

Static Public Member Functions
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
FLTNB	mp_sizeVox [3]

INTNB	mp_nbVox [3]

INTNB	m_nbVoxXY

FLTNB	mp_halfFOV [3]

oImageDimensionsAndQuantification *	mp_ImageDimensionsAndQuantification

vScanner *	mp_Scanner

int	m_applyTOF

FLTNB	m_TOFnbSigmas

bool	m_applyPOI

bool	m_sensitivityMode

bool	m_compatibleWithSPECTAttenuationCorrection

bool	m_compatibleWithCompression

int	m_verbose

bool	m_checked

bool	m_initialized

bool *	mp_mask

bool	m_hasMask

Private Member Functions
virtual void	ShowHelpSpecific ()=0
	A function used to show help about the child module. More...

virtual int	CheckSpecificParameters ()=0
	A private function used to check the parameters settings specific to the child projector. More...

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

virtual int	ProjectWithoutTOF (int a_direction, oProjectionLine *ap_ProjectionLine)=0
	A function to project without TOF. More...

virtual int	ProjectWithTOFPos (int a_direction, oProjectionLine *ap_ProjectionLine)=0
	A function to project with TOF continuous information. More...

virtual int	ProjectWithTOFBin (int a_direction, oProjectionLine *ap_ProjectionLine)=0
	A function to project with TOF binned information. More...

Detailed Description

This class is designed to generically described any on-the-fly projector.

This class is an abstract 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 on-the-fly projectors. Everywhere in the code, this parent class should be used instead of any of its children. It can be used during the projection/reconstruction process by the oProjectorManager through the use of the Project() function that cannot be overloaded. This function is called from the Project() function of the oProjectionManager to get a oProjectionLine associated to an vEvent.
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 stuff of the projector
ProjectWithoutTOF(): project without the TOF info
ProjectWithTOFPos(): project with TOF info from list-mode data
ProjectWithTOFBin(): project with TOF info from histogram data

Definition at line 76 of file vProjector.hh.

Constructor & Destructor Documentation

vProjector::vProjector ( )

The constructor of vProjector.

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 40 of file vProjector.cc.

vProjector::~vProjector ( )

virtual

The destructor of vProjector.

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. It is virtual, so that it is automatically called when a child object is deleted.

Definition at line 73 of file vProjector.cc.

Member Function Documentation

int vProjector::CheckParameters ( )

A public function used to check the parameters settings.

This function does not take any parameter and is used to check that all mandatory members were correctly parameterized. At the end, it calls the pure virtual CheckSpecificParameters() function implemented by children.

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

Definition at line 170 of file vProjector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

private virtual int vProjector::CheckSpecificParameters ( )

privatepure virtual

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. It is pure virtual so is implemented by children.

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

Implemented in iProjectorDistanceDriven, iProjectorClassicSiddon, iProjectorIRIS, iProjectorJoseph, iProjectorIncrementalSiddon, iProjectorTemplate, and iProjectorIncrementalSiddonMulti.

Here is the caller graph for this function:

INTNB vProjector::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.

The vProjector implementation simply returns the total image's number of voxels, but it can be overloaded by children to provide a better estimate in order to optimize and reduce memory requirements of the oProjectionLine buffers when using the FIXED_LIST_STRATEGY.

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

Reimplemented in iProjectorDistanceDriven, iProjectorClassicSiddon, iProjectorIncrementalSiddon, iProjectorIRIS, iProjectorJoseph, iProjectorIncrementalSiddonMulti, and iProjectorTemplate.

Definition at line 253 of file vProjector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

public bool vProjector::GetCompatibilityWithCompression ( )

inline

Returns: m_compatibleWithCompression

Definition at line 325 of file vProjector.hh.

Here is the caller graph for this function:

public bool vProjector::GetCompatibilityWithSPECTAttenuationCorrection ( )

inline

Returns: m_compatibleWithSPECTAttenuationCorrection

Definition at line 319 of file vProjector.hh.

Here is the caller graph for this function:

int vProjector::Initialize ( )

A public function used to initialize the projector.

This function does not take any parameter and is used to initialize everything that should be initialized. At the end, it calls the pure virtual InitializeSpecific() function implemented by children.

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

Definition at line 228 of file vProjector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

private virtual int vProjector::InitializeSpecific ( )

privatepure virtual

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

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

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

Implemented in iProjectorDistanceDriven, iProjectorClassicSiddon, iProjectorIRIS, iProjectorJoseph, iProjectorIncrementalSiddon, iProjectorTemplate, and iProjectorIncrementalSiddonMulti.

Here is the caller graph for this function:

int vProjector::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.

Parameters

int	a_direction
oProjectionLine*	ap_ProjectionLine
int*	ap_index1
int*	ap_index2
int	a_nbIndices

This function is used to fill the provided oProjectionLine with the system matrix elements associated to the provided indices. The filling is done by calling one of the three projection functions (w/o TOF) implemented by its children. This function cannot be overloaded. From a collection of scanner elements indices associated to a oProjectionLine and to a projection direction (FORWARD or BACKWARD), it first uses the scanner to get associated cartesian coordinates taking compression, mean depth of interaction or POI into account, it then applies offsets (general one from oImageDimensionsAndQuantification), LOR displacement (associated to each event). The computed coordinates are embedded into the oProjectionLine which are passed to the different pure virtual projection functions (w/o TOF). If the number of provided indices is one (no compression), then the provided indices are also passed to the oProjectionLine if needed by a highly specified projector. In the case of compression, the indices are set to -1 in the oProjectionLine, while the positions and orientations are averaged.

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

Definition at line 263 of file vProjector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

private virtual int vProjector::ProjectWithoutTOF	(	int	a_direction,
		oProjectionLine *	ap_ProjectionLine
	)

privatepure virtual

A function to project without TOF.

Parameters

int	a_direction
oProjectionLine*	ap_ProjectionLine

Projects the provided line following the provided direction, without TOF. It fills the provided oProjectionLine. This is a pure virtual function that must be implemented by children.

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

Implemented in iProjectorDistanceDriven, iProjectorClassicSiddon, iProjectorIRIS, iProjectorJoseph, iProjectorIncrementalSiddon, iProjectorTemplate, and iProjectorIncrementalSiddonMulti.

Here is the caller graph for this function:

private virtual int vProjector::ProjectWithTOFBin	(	int	a_direction,
		oProjectionLine *	ap_ProjectionLine
	)

privatepure virtual

A function to project with TOF binned information.

Parameters

int	a_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. This is a pure virtual function that must be implemented by children.

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

Implemented in iProjectorDistanceDriven, iProjectorClassicSiddon, iProjectorIRIS, iProjectorJoseph, iProjectorIncrementalSiddon, iProjectorTemplate, and iProjectorIncrementalSiddonMulti.

Here is the caller graph for this function:

private virtual int vProjector::ProjectWithTOFPos	(	int	a_direction,
		oProjectionLine *	ap_ProjectionLine
	)

privatepure virtual

A function to project with TOF continuous information.

Parameters

int	a_direction
oProjectionLine*	ap_ProjectionLine

Projects the provided line following the provided direction, with TOF described as a continuous measurement. It fills the provided oProjectionLine. This is a pure virtual function that must be implemented by children.

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

Implemented in iProjectorDistanceDriven, iProjectorClassicSiddon, iProjectorIRIS, iProjectorJoseph, iProjectorIncrementalSiddon, iProjectorTemplate, and iProjectorIncrementalSiddonMulti.

Here is the caller graph for this function:

int vProjector::ReadCommonOptionsList ( const string & a_optionsList )

This function is used to read options common to all projectors given as a string.

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

Definition at line 147 of file vProjector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

public virtual int vProjector::ReadConfigurationFile ( const string & a_configurationFile )

pure virtual

A function used to read options from a configuration file.

Parameters

const string& a_configurationFile

This function implements the reading of all options associated to a child projector, from a configuration file. It is pure virtual so is implemented by children. 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.

Implemented in iProjectorDistanceDriven, iProjectorClassicSiddon, iProjectorIncrementalSiddon, iProjectorIRIS, iProjectorJoseph, iProjectorIncrementalSiddonMulti, and iProjectorTemplate.

Here is the caller graph for this function:

public virtual int vProjector::ReadOptionsList ( const string & a_optionsList )

pure virtual

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

Parameters

const string& a_optionsList

This function implements the reading of all options associated to a child projector, from a list of options. It is pure virtual so is implemented by children. 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.

Implemented in iProjectorDistanceDriven, iProjectorClassicSiddon, iProjectorIncrementalSiddon, iProjectorIRIS, iProjectorJoseph, iProjectorIncrementalSiddonMulti, and iProjectorTemplate.

Here is the caller graph for this function:

public inline void vProjector::SetApplyPOI ( bool a_applyPOI )

inline

Set the POI mode.

Parameters

bool	a_applyPOI

Definition at line 306 of file vProjector.hh.

Here is the caller graph for this function:

public inline void vProjector::SetApplyTOF ( int a_applyTOF )

inline

Set the TOF mode.

Parameters

int	a_applyTOF

Definition at line 299 of file vProjector.hh.

Here is the caller graph for this function:

int vProjector::SetImageDimensionsAndQuantification ( oImageDimensionsAndQuantification * ap_ImageDimensionsAndQuantification )

Set the pointer to the image dimensions in use and copy locally some often use variables.

Parameters

oImageDimensionsAndQuantification* ap_ImageDimensionsAndQuantification

Returns: 0 if success, other value otherwise.

Definition at line 83 of file vProjector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

public bool vProjector::SetMask ( bool * ap_mask )

inline

Set a mask for voxels.

Parameters

bool* ap_mask

Definition at line 332 of file vProjector.hh.

Here is the caller graph for this function:

public inline void vProjector::SetScanner ( vScanner * ap_Scanner )

inline

Set the pointer to the scanner in use.

Parameters

vScanner* ap_Scanner

Definition at line 285 of file vProjector.hh.

Here is the caller graph for this function:

public inline void vProjector::SetSensitivityMode ( bool a_sensitivityMode )

inline

Set the sensitivity mode on or off.

Parameters

bool	a_sensitivityMode

Definition at line 292 of file vProjector.hh.

Here is the caller graph for this function:

public inline void vProjector::SetVerbose ( int a_verbose )

inline

Set the verbose level.

Parameters

int	a_verboseLevel

Definition at line 278 of file vProjector.hh.

Here is the caller graph for this function:

void vProjector::ShowCommonHelp ( )

static

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.

Definition at line 112 of file vProjector.cc.

Here is the caller graph for this function:

void vProjector::ShowHelp ( )

A function used to show help about the projector.

This function simply calls the ShowHelpSpecific() function implemented by children.

Definition at line 133 of file vProjector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

private virtual void vProjector::ShowHelpSpecific ( )

privatepure virtual

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.

Implemented in iProjectorDistanceDriven, iProjectorClassicSiddon, iProjectorIRIS, iProjectorJoseph, iProjectorIncrementalSiddon, iProjectorTemplate, and iProjectorIncrementalSiddonMulti.

Here is the caller graph for this function:

Member Data Documentation

bool vProjector::m_applyPOI

protected

Boolean that says if we apply POI info or not

Definition at line 351 of file vProjector.hh.

int vProjector::m_applyTOF

protected

Integer tagging the use of type of TOF use

Definition at line 348 of file vProjector.hh.

bool vProjector::m_checked

protected

Boolean that says if the parameters were checked or not

Definition at line 362 of file vProjector.hh.

bool vProjector::m_compatibleWithCompression

protected

Boolean that says if the projector is compatible with compression

Definition at line 358 of file vProjector.hh.

bool vProjector::m_compatibleWithSPECTAttenuationCorrection

protected

Boolean that says if the projector is compatible with SPECT attenuation correction

Definition at line 355 of file vProjector.hh.

bool vProjector::m_hasMask

protected

Is there a mask for voxels

Definition at line 366 of file vProjector.hh.

bool vProjector::m_initialized

protected

Boolean that says if the projector was initialized or not

Definition at line 364 of file vProjector.hh.

INTNB vProjector::m_nbVoxXY

protected

Local copy of the number of voxels per slice

Definition at line 340 of file vProjector.hh.

bool vProjector::m_sensitivityMode

protected

Boolean that says if we are computing the global sensitivity or not

Definition at line 353 of file vProjector.hh.

FLTNB vProjector::m_TOFnbSigmas

protected

The TOF distribution truncation factor (number of standard deviations)

Definition at line 349 of file vProjector.hh.

int vProjector::m_verbose

protected

The verbose level

Definition at line 360 of file vProjector.hh.

FLTNB vProjector::mp_halfFOV[3]

protected

Local copy of the FOV half dimensions

Definition at line 341 of file vProjector.hh.

oImageDimensionsAndQuantification* vProjector::mp_ImageDimensionsAndQuantification

protected

Pointer to the oImageDimensionsAndQuantification object in use

Definition at line 344 of file vProjector.hh.

bool* vProjector::mp_mask

protected

Mask for voxels: only true voxels will be taken into account for projector coefficients computation (currently 3D - XYZ)

Definition at line 365 of file vProjector.hh.

INTNB vProjector::mp_nbVox[3]

protected

Local copy of the number of voxels

Definition at line 339 of file vProjector.hh.

vScanner* vProjector::mp_Scanner

protected

Pointer to the vScanner object in use

Definition at line 346 of file vProjector.hh.

FLTNB vProjector::mp_sizeVox[3]

protected

Local copy of the voxels' size

Definition at line 338 of file vProjector.hh.

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation