Inherit from vEvent. Main PET class for the Event objects. More...

#include <iEventPET.hh>

Inheritance diagram for iEventPET:

Collaboration diagram for iEventPET:

Public Member Functions
	iEventPET ()
	iEventPET constructor. Initialize the member variables to their default values.
virtual	~iEventPET ()
	iEventPET destructor
virtual int	AllocateSpecificData ()=0
	Pure virtual function implemented in the child classes, dedicated to the allocation of specific data in the child classes.
virtual void	Describe ()
	This function can be used to get a description of the event printed out.
FLTNB	GetEventRdmRate ()
FLTNB	GetNormFactor ()
FLTNB	GetAtnCorrFactor ()
void	SetRandomRate (FLTNBDATA a_value)
	Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the random correction term.
void	SetNormalizationFactor (FLTNBDATA a_value)
	Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the normalization term.
void	SetAttenuationCorrectionFactor (FLTNBDATA a_value)
	Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the attenuation correction term.
FLTNB	GetMultiplicativeCorrections ()
virtual FLTNB	GetEventValue (int a_bin)=0
	Pure virtual function implemented in the child classes.
virtual FLTNB	GetAdditiveCorrections (int a_bin)=0
	Pure virtual function implemented in the child classes.
virtual void	SetEventValue (int a_bin, FLTNBDATA a_value)=0
	Set the event value, this is a pure virtual function implemented in the child classes.
virtual void	SetScatterRate (int a_bin, FLTNBDATA a_value)=0
	Set the scatter rate correction term in 1/s, this is a pure virtual function implemented in the child classes.
Protected Attributes
FLTNB	m_eventRdmRate
FLTNB	m_eventNormFactor
FLTNB	m_atnCorrFactor

Detailed Description

Inherit from vEvent. Main PET class for the Event objects.

This class is designed to be an abstract class that should not be used on its own; only its children are used.
It manages data and functions common to both class decicated to histogram and list mode PET.

Definition at line 22 of file iEventPET.hh.

Constructor & Destructor Documentation

iEventPET::iEventPET ( )

iEventPET constructor. Initialize the member variables to their default values.

Definition at line 32 of file iEventPET.cc.

iEventPET::~iEventPET ( ) [virtual]

iEventPET destructor

Definition at line 51 of file iEventPET.cc.

Member Function Documentation

int iEventPET::AllocateSpecificData ( ) [pure virtual]

Pure virtual function implemented in the child classes, dedicated to the allocation of specific data in the child classes.

Returns:: 0 is success, positive value otherwise

Implements vEvent.

Implemented in iEventListPET, and iEventHistoPET.

void iEventPET::Describe ( ) [virtual]

This function can be used to get a description of the event printed out.

Implements vEvent.

Reimplemented in iEventListPET, and iEventHistoPET.

Definition at line 62 of file iEventPET.cc.

FLTNB iEventPET::GetAdditiveCorrections ( int a_bin ) [pure virtual]

Pure virtual function implemented in the child classes.

Parameters:

a	bin (0 if only one line)

Returns:: the sum of the additive corrections terms for this event

Implements vEvent.

Implemented in iEventListPET, and iEventHistoPET.

FLTNB iEventPET::GetAtnCorrFactor ( ) [inline]

Returns:: the correction term for attenuation

Definition at line 72 of file iEventPET.hh.

Here is the caller graph for this function:

FLTNB iEventPET::GetEventRdmRate ( ) [inline]

Returns:: the correction term for randoms given as a rate in 1/s

Definition at line 60 of file iEventPET.hh.

Here is the caller graph for this function:

FLTNB iEventPET::GetEventValue ( int a_bin ) [pure virtual]

Pure virtual function implemented in the child classes.

Parameters:

a	bin (0 if only one line)

Returns:: the value of the event

Implements vEvent.

Implemented in iEventListPET, and iEventHistoPET.

FLTNB iEventPET::GetMultiplicativeCorrections ( ) [inline, virtual]

Returns:: the product of the multiplicative corrections terms for this event

Implements vEvent.

Definition at line 99 of file iEventPET.hh.

FLTNB iEventPET::GetNormFactor ( ) [inline]

Returns:: the normalization term

Definition at line 66 of file iEventPET.hh.

Here is the caller graph for this function:

void iEventPET::SetAttenuationCorrectionFactor ( FLTNBDATA a_value ) [inline]

Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the attenuation correction term.

Parameters:

an	attenuation correction factor

Definition at line 93 of file iEventPET.hh.

void iEventPET::SetEventValue	(	int	a_bin,
		FLTNBDATA	a_value
	)		`[pure virtual]`

Set the event value, this is a pure virtual function implemented in the child classes.

Parameters:

a	bin (0 if only one line)
a_value

Implements vEvent.

Implemented in iEventListPET, and iEventHistoPET.

void iEventPET::SetNormalizationFactor ( FLTNBDATA a_value ) [inline]

Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the normalization term.

Parameters:

a	normalization term

Definition at line 86 of file iEventPET.hh.

void iEventPET::SetRandomRate ( FLTNBDATA a_value ) [inline]

Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the random correction term.

Parameters:

a	random rate value in 1/s

Definition at line 79 of file iEventPET.hh.

void iEventPET::SetScatterRate	(	int	a_bin,
		FLTNBDATA	a_value
	)		`[pure virtual]`

Set the scatter rate correction term in 1/s, this is a pure virtual function implemented in the child classes.

Parameters:

a	bin (0 if only one line)
a_value

Implemented in iEventListPET, and iEventHistoPET.

Member Data Documentation

FLTNB iEventPET::m_atnCorrFactor [protected]

Correction term for attenuation. Default value =1.0

Definition at line 141 of file iEventPET.hh.

FLTNB iEventPET::m_eventNormFactor [protected]

Normalization term. Default value =1.0

Definition at line 140 of file iEventPET.hh.

FLTNB iEventPET::m_eventRdmRate [protected]

Correction term for randoms rate (unit: s-1). Default value =0.0

Definition at line 139 of file iEventPET.hh.

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation