This class is a child of the vProjector class implementing the classic Siddon ray tracer. More...

#include <iProjectorClassicSiddon.hh>

Inheritance diagram for iProjectorClassicSiddon:

Collaboration diagram for iProjectorClassicSiddon:

Public Member Functions
	iProjectorClassicSiddon ()
	The constructor of iProjectorClassicSiddon. More...

	~iProjectorClassicSiddon ()
	The destructor of iProjectorClassicSiddon. 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...

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

Private Member Functions
void	ShowHelpSpecific ()
	A function used to show help about the child projector. 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]

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

Detailed Description

This class is a child of the vProjector class implementing the classic Siddon ray tracer.

This class implements the classic Siddon algorithm which is a ray-tracer algorithm calculating the exact length of a line through each voxel it crosses. Reference: R. L. Siddon, "Fast calculation of the exact radiological path for a three-dimensional CT array", Med. Phys., vol. 12, pp. 252-5, 1985.

Definition at line 45 of file iProjectorClassicSiddon.hh.

Constructor & Destructor Documentation

iProjectorClassicSiddon::iProjectorClassicSiddon ( )

The constructor of iProjectorClassicSiddon.

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 43 of file iProjectorClassicSiddon.cc.

iProjectorClassicSiddon::~iProjectorClassicSiddon ( )

The destructor of iProjectorClassicSiddon.

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 59 of file iProjectorClassicSiddon.cc.

Member Function Documentation

int iProjectorClassicSiddon::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 107 of file iProjectorClassicSiddon.cc.

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

Definition at line 133 of file iProjectorClassicSiddon.cc.

Here is the call graph for this function:

int iProjectorClassicSiddon::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 120 of file iProjectorClassicSiddon.cc.

int iProjectorClassicSiddon::ProjectWithoutTOF	(	int	a_direction,
		oProjectionLine *	ap_ProjectionLine
	)

privatevirtual

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. 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 151 of file iProjectorClassicSiddon.cc.

Here is the call graph for this function:

int iProjectorClassicSiddon::ProjectWithTOFBin	(	int	a_direction,
		oProjectionLine *	ap_ProjectionLine
	)

privatevirtual

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. 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 717 of file iProjectorClassicSiddon.cc.

Here is the call graph for this function:

int iProjectorClassicSiddon::ProjectWithTOFPos	(	int	a_direction,
		oProjectionLine *	ap_ProjectionLine
	)

privatevirtual

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. 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 407 of file iProjectorClassicSiddon.cc.

Here is the call graph for this function:

int iProjectorClassicSiddon::ReadConfigurationFile ( const string & a_configurationFile )

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 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 68 of file iProjectorClassicSiddon.cc.

int iProjectorClassicSiddon::ReadOptionsList ( const string & a_optionsList )

virtual

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

Parameters

const string& 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 81 of file iProjectorClassicSiddon.cc.

void iProjectorClassicSiddon::ShowHelpSpecific ( )

privatevirtual

A function used to show help about the child projector.

This function must describe what the module 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 the implementation of the pure virtual function inherited from the abstract class vProjector.

Implements vProjector.

Definition at line 94 of file iProjectorClassicSiddon.cc.

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

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation