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

	~iEventHistoPET ()
	iEventHistoPET destructor. More...

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

void	Describe ()
	This function can be used to get a description of the event printed out. More...

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

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

INTNB	GetNbValueBins ()
	Get the number of event value bins. More...

FLTNB	GetAdditiveCorrections (int a_bin)

void	MultiplyAdditiveCorrections (FLTNB a_factor)
	Divide additive corrections by the provided factor (scatters and randoms) More...

Public Member Functions inherited from iEventPET
	iEventPET ()
	iEventPET constructor. Initialize the member variables to their default values. More...

virtual	~iEventPET ()
	iEventPET destructor More...

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

void	SetNormalizationFactor (FLTNBDATA a_value)
	Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the normalization term. More...

void	SetAttenuationCorrectionFactor (FLTNBDATA a_value)
	Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the attenuation correction term. More...

FLTNB	GetMultiplicativeCorrections ()

Public Member Functions inherited from vEvent
	vEvent ()
	vEvent constructor. Initialize the member variables to their default values. More...

virtual	~vEvent ()
	vEvent destructor More...

int	AllocateID ()
	Instantiate the mp_ID1 and mp_ID2 indices arrays. More...

uint32_t	GetTimeInMs ()

uint16_t	GetNbLines ()

uint32_t	GetID1 (int a_line)

uint32_t	GetID2 (int a_line)

uint32_t *	GetEventID1 ()

uint32_t *	GetEventID2 ()

int	GetDataType ()

int	GetDataMode ()

void	SetTimeInMs (uint32_t a_value)
	Set the timestamp of the Event. More...

void	SetNbLines (uint16_t a_value)
	Set the number of lines of the Event. More...

void	SetID1 (int a_line, uint32_t a_value)
	Set the indice associated with the line index for the 1st ID of the Event. More...

void	SetID2 (int a_line, uint32_t a_value)
	Set the indice associated with the line index for the 2nd ID of the Event. More...

void	SetVerbose (int a_verbose)
	Set verbosity. More...

virtual FLTNB	GetBlankValue ()
	This is a pure virtual function implemented in the child classes. More...

Private Attributes
FLTNB *	mp_eventValue

FLTNB *	mp_eventScatRate

uint16_t	m_eventNbTOFBins

Additional Inherited Members
Protected Attributes inherited from iEventPET
FLTNB	m_eventRdmRate

FLTNB	m_eventNormFactor

FLTNB	m_atnCorrFactor

Protected Attributes inherited from vEvent
uint32_t	m_timeInMs

uint16_t	m_nbLines

uint32_t *	mp_ID1

uint32_t *	mp_ID2

FLTNB	m_eventValue

int	m_dataType

int	m_dataMode

int	m_dataSpec

int	m_verbose

Detailed Description

Inherit from iEventPET. Class for PET histogram mode events.

It manages data and functions specific to histo mode PET.

Definition at line 41 of file iEventHistoPET.hh.

Constructor & Destructor Documentation

iEventHistoPET::iEventHistoPET ( )

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

Definition at line 41 of file iEventHistoPET.cc.

iEventHistoPET::~iEventHistoPET ( )

iEventHistoPET destructor.

Definition at line 57 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 68 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 106 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 95 of file iEventHistoPET.cc.

uint16_t iEventHistoPET::GetEventNbTOFBins ( )

inline

Returns: the number of TOF bins in the Event

Definition at line 86 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 80 of file iEventHistoPET.hh.

Here is the caller graph for this function:

FLTNB iEventHistoPET::GetEventValue ( int a_bin )

inlinevirtual

Parameters

a_bin (0 if noTOF)

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

Implements iEventPET.

Definition at line 93 of file iEventHistoPET.hh.

Here is the caller graph for this function:

INTNB iEventHistoPET::GetNbValueBins ( )

inlinevirtual

Get the number of event value bins.

Returns: the number of value bins

Implements iEventPET.

Definition at line 123 of file iEventHistoPET.hh.

void iEventHistoPET::MultiplyAdditiveCorrections ( FLTNB a_factor )

inlinevirtual

Divide additive corrections by the provided factor (scatters and randoms)

Parameters

FLTNB a_factor

Implements vEvent.

Definition at line 135 of file iEventHistoPET.hh.

void iEventHistoPET::SetEventNbTOFBins ( uint16_t a_value )

inline

Definition at line 108 of file iEventHistoPET.hh.

void iEventHistoPET::SetEventValue	(	int	a_bin,
		FLTNBDATA	a_value
	)

inlinevirtual

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 116 of file iEventHistoPET.hh.

void iEventHistoPET::SetScatterRate	(	int	a_bin,
		FLTNBDATA	a_value
	)

inlinevirtual

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 101 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 147 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 146 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 145 of file iEventHistoPET.hh.

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation