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

#include <iProjectorJoseph.hh>

Inheritance diagram for iProjectorJoseph:

Collaboration diagram for iProjectorJoseph:

Public Member Functions
	iProjectorJoseph ()
	The constructor of iProjectorJoseph.
	~iProjectorJoseph ()
	The destructor of iProjectorJoseph.
int	ReadConfigurationFile (const string &a_configurationFile)
	A function used to read options from a configuration file.
int	ReadOptionsList (const string &a_optionsList)
	A function used to read options from a list of options.
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.
Private Member Functions
void	ShowHelpSpecific ()
	A function used to show help about the child module.
int	CheckSpecificParameters ()
	A private function used to check the parameters settings specific to the child projector.
int	InitializeSpecific ()
	This function is used to initialize specific stuff to the child projector.
int	ProjectWithoutTOF (int a_direction, oProjectionLine *ap_ProjectionLine)
	A function to project without TOF.
int	ProjectWithTOFPos (int a_direction, oProjectionLine *ap_ProjectionLine)
	A function to project with TOF continuous information.
int	ProjectWithTOFBin (int a_direction, oProjectionLine *ap_ProjectionLine)
	A function to project with TOF binned information.
Private Attributes
FLTNB *	mp_boundariesX
FLTNB *	mp_boundariesY
FLTNB *	mp_boundariesZ

Detailed Description

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

This class implements the Joseph algorithm which is a ray-tracer using bi-linear interpolations. Reference: P. M. Joseph, "An improved algorithm for reprojecting rays through pixel images", IEEE Trans. Med. Imaging, vol. 1, pp. 192-6, 1982.

Definition at line 23 of file iProjectorJoseph.hh.

Constructor & Destructor Documentation

iProjectorJoseph::iProjectorJoseph ( )

The constructor of iProjectorJoseph.

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

iProjectorJoseph::~iProjectorJoseph ( )

The destructor of iProjectorJoseph.

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 39 of file iProjectorJoseph.cc.

Member Function Documentation

int iProjectorJoseph::CheckSpecificParameters ( ) [private, 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 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 103 of file iProjectorJoseph.cc.

INTNB iProjectorJoseph::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 136 of file iProjectorJoseph.cc.

Here is the call graph for this function:

int iProjectorJoseph::InitializeSpecific ( ) [private, virtual]

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 116 of file iProjectorJoseph.cc.

int iProjectorJoseph::ProjectWithoutTOF	(	int	a_direction,
		oProjectionLine *	ap_ProjectionLine
	)		`[private, 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. 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 153 of file iProjectorJoseph.cc.

Here is the call graph for this function:

int iProjectorJoseph::ProjectWithTOFBin	(	int	a_direction,
		oProjectionLine *	ap_ProjectionLine
	)		`[private, 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. 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 478 of file iProjectorJoseph.cc.

int iProjectorJoseph::ProjectWithTOFPos	(	int	a_direction,
		oProjectionLine *	ap_ProjectionLine
	)		`[private, 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. 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 467 of file iProjectorJoseph.cc.

int iProjectorJoseph::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 65 of file iProjectorJoseph.cc.

int iProjectorJoseph::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 78 of file iProjectorJoseph.cc.

void iProjectorJoseph::ShowHelpSpecific ( ) [private, 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.

Implements vProjector.

Definition at line 91 of file iProjectorJoseph.cc.