Inherit from iEventPET. Class for PET histogram mode events. More...

#include <iEventHistoPET.hh>

Inheritance diagram for iEventHistoPET:

Collaboration diagram for iEventHistoPET:

Public Member Functions
	iEventHistoPET ()
	iEventHistoPET constructor. Initialize the member variables to their default values.
	~iEventHistoPET ()
	iEventHistoPET destructor.
int	AllocateSpecificData ()
	Function allowing the allocation of specific data. Instantiate and initialize the mp_eventValue and mp_eventScatIntensity arrays depending of the number of TOF bins.
void	Describe ()
	This function can be used to get a description of the event printed out.
FLTNB	GetEventScatRate (int a_bin)
uint16_t	GetEventNbTOFBins ()
FLTNB	GetEventValue (int a_bin)
void	SetScatterRate (int a_bin, FLTNBDATA a_value)
	Set the scatter rate correction term in 1/s, this is a pure virtual function implemented in the child classes.
void	SetEventNbTOFBins (uint16_t a_value)
void	SetEventValue (int a_bin, FLTNBDATA a_value)
	Cast the FLTNBDATA value passed in parameters in FLTNB, and use it to set the event value of the specific TOF bin.
FLTNB	GetAdditiveCorrections (int a_bin)
Private Attributes
FLTNB *	mp_eventValue
FLTNB *	mp_eventScatRate
uint16_t	m_eventNbTOFBins

Detailed Description

Inherit from iEventPET. Class for PET histogram mode events.

It manages data and functions specific to histo mode PET.

Definition at line 20 of file iEventHistoPET.hh.

Constructor & Destructor Documentation

iEventHistoPET::iEventHistoPET ( )

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

Definition at line 33 of file iEventHistoPET.cc.

iEventHistoPET::~iEventHistoPET ( )

iEventHistoPET destructor.

Definition at line 51 of file iEventHistoPET.cc.

Member Function Documentation

int iEventHistoPET::AllocateSpecificData ( ) [virtual]

Function allowing the allocation of specific data.
Instantiate and initialize the mp_eventValue and mp_eventScatIntensity arrays depending of the number of TOF bins.

Returns:: 0 is success, positive value otherwise

Implements iEventPET.

Definition at line 69 of file iEventHistoPET.cc.

void iEventHistoPET::Describe ( ) [virtual]

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

Reimplemented from iEventPET.

Definition at line 114 of file iEventHistoPET.cc.

FLTNB iEventHistoPET::GetAdditiveCorrections ( int a_bin ) [virtual]

Returns:: the sum of additive correction terms, summed for all the TOF bins

Implements iEventPET.

Definition at line 99 of file iEventHistoPET.cc.

uint16_t iEventHistoPET::GetEventNbTOFBins ( ) [inline]

Returns:: the number of TOF bins in the Event

Definition at line 67 of file iEventHistoPET.hh.

FLTNB iEventHistoPET::GetEventScatRate ( int a_bin ) [inline]

Parameters:

a_bin (0 if noTOF)

Returns:: the scatter correction rate in 1/s for this list-mode event for the specific TOF bin

Parameters:

a_bin	(0 if noTOF)
a_value

Returns:: the scatter correction rate in 1/s for this histo-mode event for the specific TOF bin

Parameters:

a_value

Returns:: the scatter correction rate in 1/s for this histo-mode event for the specific TOF bin

Definition at line 61 of file iEventHistoPET.hh.

Here is the caller graph for this function:

FLTNB iEventHistoPET::GetEventValue ( int a_bin ) [inline, virtual]

Parameters:

a_bin (0 if noTOF)

Returns:: the event value corresponding to the specific TOF bin passed as parameter

Implements iEventPET.

Definition at line 74 of file iEventHistoPET.hh.

Here is the caller graph for this function:

void iEventHistoPET::SetEventNbTOFBins ( uint16_t a_value ) [inline]

Definition at line 89 of file iEventHistoPET.hh.

void iEventHistoPET::SetEventValue	(	int	a_bin,
		FLTNBDATA	a_value
	)		`[inline, virtual]`

Cast the FLTNBDATA value passed in parameters in FLTNB, and use it to set the event value of the specific TOF bin.

Parameters:

a_bin	(0 if noTOF)
a_value

Implements iEventPET.

Definition at line 97 of file iEventHistoPET.hh.

void iEventHistoPET::SetScatterRate	(	int	a_bin,
		FLTNBDATA	a_value
	)		`[inline, 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

Implements iEventPET.

Definition at line 82 of file iEventHistoPET.hh.

Member Data Documentation

uint16_t iEventHistoPET::m_eventNbTOFBins [private]

Number of TOF bins in the Event. Default value =1

Definition at line 116 of file iEventHistoPET.hh.

FLTNB* iEventHistoPET::mp_eventScatRate [private]

Pointer containing the scatter correction term (as a rate in s-1) for each potential TOF bin. Default value =0.0

Definition at line 115 of file iEventHistoPET.hh.

FLTNB* iEventHistoPET::mp_eventValue [private]

Pointer containing the amount of data in each potential TOF bin. Default value =1.0

Definition at line 114 of file iEventHistoPET.hh.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation