iEventListPET Class Reference

Inherit from iEventPET. Class for PET list-mode events. More...

#include <iEventListPET.hh>

Inheritance diagram for iEventListPET:

Collaboration diagram for iEventListPET:

Public Member Functions
	iEventListPET ()
	iEventListPET constructor. Initialize the member variables to their default values. More...
	~iEventListPET ()
	iEventListPET destructor. More...
int	AllocateSpecificData ()
	Function allowing the allocation of specific data. Return 0 by default for iEventListPET. More...
void	Describe ()
	This function can be used to get a description of the event printed out. More...
uint8_t	GetKind ()
FLTNB	GetEventScatRate (int a_bin)
FLTNB	GetTOFMeasurementInPs ()
FLTNB	GetEventTOFResolutionInPs ()
FLTNB *	GetPOI1 ()
FLTNB *	GetPOI2 ()
FLTNB	GetPOI1 (uint8_t axis)
FLTNB	GetPOI2 (uint8_t axis)
FLTNB	GetEventValue (int a_bin)
void	SetKind (uint8_t a_value)
void	SetScatterRate (int a_bin, FLTNBDATA a_value)
void	SetTOFMeasurementInPs (FLTNB a_value)
void	SetTOFMeasurementRangeInPs (FLTNB a_value)
void	SetEventTOFResolutionInPs (FLTNB a_value)
void	SetPOI1 (int a_axis, FLTNBDATA a_value)
void	SetPOI2 (int a_axis, FLTNBDATA a_value)
void	SetEventValue (int a_bin, FLTNBDATA a_value)
FLTNB	GetAdditiveCorrections (int a_bin)
INTNB	GetNbValueBins ()
	Get the number of event value bins. More...
void	SetHasTOFInfo (bool a_hasTOFInfo)
void	MultiplyAdditiveCorrections (FLTNB a_factor)
	iEventListPET ()
	iEventListPET constructor. Initialize the member variables to their default values. More...
	~iEventListPET ()
	iEventListPET destructor. More...
int	AllocateSpecificData ()
	Pure virtual function implemented in the child classes, dedicated to the allocation of specific data in the child classes. More...
void	Describe ()
	This function can be used to get a description of the event printed out. More...
uint8_t	GetKind ()
FLTNB	GetEventScatRate (int a_bin)
FLTNB	GetTOFMeasurementInPs ()
FLTNB *	GetPOI1 ()
FLTNB *	GetPOI2 ()
FLTNB	GetPOI1 (uint8_t axis)
FLTNB	GetPOI2 (uint8_t axis)
FLTNB	GetEventValue (int a_bin)
void	SetKind (uint8_t a_value)
void	SetScatterRate (int a_bin, FLTNBDATA a_value)
void	SetTOFMeasurementInPs (FLTNB a_value)
void	SetTOFMeasurementRangeInPs (FLTNB a_value)
void	SetPOI1 (int a_axis, FLTNBDATA a_value)
void	SetPOI2 (int a_axis, FLTNBDATA a_value)
void	SetEventValue (int a_bin, FLTNBDATA a_value)
FLTNB	GetAdditiveCorrections (int a_bin)
INTNB	GetNbValueBins ()
	Get the number of event value bins. More...
void	SetHasTOFInfo (bool a_hasTOFInfo)
void	MultiplyAdditiveCorrections (FLTNB a_factor)
void	SetTOFEventResolutionInPs (FLTNBDATA resolutionInPs)
FLTNB	GetTOFEventResolutionInPs () const
	Get TOF resolution in ps. 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)
void	SetNormalizationFactor (FLTNBDATA a_value)
void	SetAttenuationCorrectionFactor (FLTNBDATA a_value)
FLTNB	GetMultiplicativeCorrections ()
	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)
void	SetNormalizationFactor (FLTNBDATA a_value)
void	SetAttenuationCorrectionFactor (FLTNBDATA a_value)
FLTNB	GetMultiplicativeCorrections ()
	This is a pure virtual function implemented in the child classes. More...
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)
void	SetNbLines (uint16_t a_value)
void	SetID1 (int a_line, uint32_t a_value)
void	SetID2 (int a_line, uint32_t a_value)
void	SetVerbose (int a_verbose)
virtual FLTNB	GetBlankValue ()
	This is a pure virtual function implemented in the child classes. More...
	vEvent ()
	vEvent constructor. Initialize the member variables to their default values. More...
virtual	~vEvent ()
	vEvent destructor More...
int	AllocateID ()
int	AllocateCustomINTData ()
	Instantiate the m_nbCustomINTData array. More...
int	AllocateCustomFLTData ()
	Instantiate the m_nbCustomFLTData array. 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)
void	SetNbLines (uint16_t a_value)
void	SetID1 (int a_line, uint32_t a_value)
void	SetID2 (int a_line, uint32_t a_value)
void	SetVerbose (int a_verbose)
virtual FLTNB	GetBlankValue ()
void	SetEventIndex (int a_eventIndex)
	Set current index associated to the event. More...
int64_t	GetEventIndex ()
	Get current index associated to the event. More...
virtual int	GetNbCustomFLTData ()
virtual int	GetNbCustomINTData ()
virtual void	SetNbCustomFLTData (int a_value)
	initialize the number of custom INT data with a_value More...
virtual void	SetNbCustomINTData (int a_value)
	initialize the number of custom INT data with a_value More...
virtual EVTFLTDATA *	GetCustomFLTData ()
virtual EVTINTDATA *	GetCustomINTData ()
virtual EVTFLTDATA	GetCustomFLTData (int a_idx)
virtual EVTINTDATA	GetCustomINTData (int a_idx)
virtual int	SetCustomFLTData (int a_idx, EVTFLTDATA a_value)
virtual int	SetCustomINTData (int a_idx, EVTINTDATA a_value)

Private Attributes
uint8_t	m_kind
FLTNB	m_eventScatRate
FLTNB	m_TOFMeasurementInPs
FLTNB	mp_POI1 [3]
FLTNB	mp_POI2 [3]
FLTNB	m_TOFMeasurementRangeInPs
FLTNB	m_eventTOFResolutionInPs
bool	m_hasTOFInfo
FLTNB	m_TOFEventResolutionInPs

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
int64_t	m_eventIndex
EVTFLTDATA *	mp_customFLTData
EVTINTDATA *	mp_customINTData
int	m_nbCustomFLTData
int	m_nbCustomINTData

Detailed Description

Inherit from iEventPET. Class for PET list-mode events.

It manages data and functions specific to list mode PET.

Definition at line 40 of file code/include/datafile/iEventListPET.hh.

Constructor & Destructor Documentation

iEventListPET() [1/2]

iEventListPET::iEventListPET

(

)

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

Definition at line 18 of file code/src/datafile/iEventListPET.cc.

~iEventListPET() [1/2]

iEventListPET::~iEventListPET

(

)

iEventListPET destructor.

Definition at line 44 of file code/src/datafile/iEventListPET.cc.

iEventListPET() [2/2]

iEventListPET::iEventListPET

(

)

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

~iEventListPET() [2/2]

iEventListPET::~iEventListPET

(

)

iEventListPET destructor.

Member Function Documentation

AllocateSpecificData() [1/2]

int iEventListPET::AllocateSpecificData ( )

inlinevirtual

Function allowing the allocation of specific data. Return 0 by default for iEventListPET.

Returns

0 is success, positive value otherwise

Implements iEventPET.

Definition at line 63 of file code/include/datafile/iEventListPET.hh.

Here is the call graph for this function:

AllocateSpecificData() [2/2]

int iEventListPET::AllocateSpecificData ( )

inlinevirtual

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

Definition at line 63 of file include/datafile/iEventListPET.hh.

Here is the call graph for this function:

Describe() [1/2]

void iEventListPET::Describe ( )

virtual

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

Reimplemented from iEventPET.

Definition at line 63 of file code/src/datafile/iEventListPET.cc.

Here is the caller graph for this function:

Describe() [2/2]

void iEventListPET::Describe ( )

virtual

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

Reimplemented from iEventPET.

GetAdditiveCorrections() [1/2]

FLTNB iEventListPET::GetAdditiveCorrections ( int  a_bin )

virtual

Implements iEventPET.

GetAdditiveCorrections() [2/2]

FLTNB iEventListPET::GetAdditiveCorrections ( int  a_bin )

virtual

Implements iEventPET.

Definition at line 88 of file code/src/datafile/iEventListPET.cc.

Here is the caller graph for this function:

GetEventScatRate() [1/2]

FLTNB iEventListPET::GetEventScatRate ( int  a_bin )

inline

Definition at line 84 of file code/include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

GetEventScatRate() [2/2]

FLTNB iEventListPET::GetEventScatRate ( int  a_bin )

inline

Definition at line 84 of file include/datafile/iEventListPET.hh.

GetEventTOFResolutionInPs()

FLTNB iEventListPET::GetEventTOFResolutionInPs ( )

inline

Returns

the event specific TOF resolution value in ps

Definition at line 99 of file code/include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

GetEventValue() [1/2]

FLTNB iEventListPET::GetEventValue ( int  a_bin )

inlinevirtual

Implements iEventPET.

Definition at line 126 of file include/datafile/iEventListPET.hh.

GetEventValue() [2/2]

FLTNB iEventListPET::GetEventValue ( int  a_bin )

inlinevirtual

Implements iEventPET.

Definition at line 132 of file code/include/datafile/iEventListPET.hh.

GetKind() [1/2]

uint8_t iEventListPET::GetKind ( )

inline

Returns

the kind of coincidence

Definition at line 77 of file code/include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

GetKind() [2/2]

uint8_t iEventListPET::GetKind ( )

inline

Definition at line 77 of file include/datafile/iEventListPET.hh.

GetNbValueBins() [1/2]

INTNB iEventListPET::GetNbValueBins ( )

inlinevirtual

Get the number of event value bins.

Returns

the number of value bins

Implements iEventPET.

Definition at line 198 of file include/datafile/iEventListPET.hh.

GetNbValueBins() [2/2]

INTNB iEventListPET::GetNbValueBins ( )

inlinevirtual

Get the number of event value bins.

Returns

the number of value bins

Implements iEventPET.

Definition at line 211 of file code/include/datafile/iEventListPET.hh.

GetPOI1() [1/4]

FLTNB* iEventListPET::GetPOI1 ( )

inline

Definition at line 99 of file include/datafile/iEventListPET.hh.

GetPOI1() [2/4]

FLTNB iEventListPET::GetPOI1 ( )

inline

Returns

the pointer containing the 3 indices for the Point Of Interaction of the 1st crystal

Parameters

axis

Returns

the Point of interaction of the 1st crystal along the axis specified in parameter

Definition at line 105 of file code/include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

GetPOI1() [3/4]

FLTNB iEventListPET::GetPOI1 ( uint8_t  axis )

inline

Definition at line 112 of file include/datafile/iEventListPET.hh.

GetPOI1() [4/4]

FLTNB iEventListPET::GetPOI1 ( uint8_t  axis )

inline

Definition at line 118 of file code/include/datafile/iEventListPET.hh.

GetPOI2() [1/4]

FLTNB* iEventListPET::GetPOI2 ( )

inline

Definition at line 105 of file include/datafile/iEventListPET.hh.

GetPOI2() [2/4]

FLTNB iEventListPET::GetPOI2 ( )

inline

Returns

the pointer containing the 3 indices for the Point Of Interaction of the 2nd crystal

Parameters

axis

Returns

the Point of interaction of the 2nd crystal along the axis specified in parameter

Definition at line 111 of file code/include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

GetPOI2() [3/4]

FLTNB iEventListPET::GetPOI2 ( uint8_t  axis )

inline

Definition at line 119 of file include/datafile/iEventListPET.hh.

GetPOI2() [4/4]

FLTNB iEventListPET::GetPOI2 ( uint8_t  axis )

inline

Definition at line 125 of file code/include/datafile/iEventListPET.hh.

GetTOFEventResolutionInPs()

FLTNB iEventListPET::GetTOFEventResolutionInPs ( ) const

inline

Get TOF resolution in ps.

Returns

TOF resolution in ps

Definition at line 229 of file include/datafile/iEventListPET.hh.

GetTOFMeasurementInPs() [1/2]

FLTNB iEventListPET::GetTOFMeasurementInPs ( )

inline

Returns

the TOF measurement value in ps

Definition at line 93 of file code/include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

GetTOFMeasurementInPs() [2/2]

FLTNB iEventListPET::GetTOFMeasurementInPs ( )

inline

Definition at line 93 of file include/datafile/iEventListPET.hh.

MultiplyAdditiveCorrections() [1/2]

void iEventListPET::MultiplyAdditiveCorrections ( FLTNB  a_factor )

inlinevirtual

Implements vEvent.

Definition at line 213 of file include/datafile/iEventListPET.hh.

MultiplyAdditiveCorrections() [2/2]

void iEventListPET::MultiplyAdditiveCorrections ( FLTNB  a_factor )

inlinevirtual

Implements vEvent.

Definition at line 226 of file code/include/datafile/iEventListPET.hh.

SetEventTOFResolutionInPs()

void iEventListPET::SetEventTOFResolutionInPs ( FLTNB  a_value )

inline

Definition at line 175 of file code/include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

SetEventValue() [1/2]

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

virtual

Implements iEventPET.

SetEventValue() [2/2]

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

virtual

Implements iEventPET.

Definition at line 51 of file code/src/datafile/iEventListPET.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

SetHasTOFInfo() [1/2]

void iEventListPET::SetHasTOFInfo ( bool  a_hasTOFInfo )

inline

Definition at line 206 of file include/datafile/iEventListPET.hh.

SetHasTOFInfo() [2/2]

void iEventListPET::SetHasTOFInfo ( bool  a_hasTOFInfo )

inline

Definition at line 219 of file code/include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

SetKind() [1/2]

void iEventListPET::SetKind ( uint8_t  a_value )

inline

Definition at line 136 of file include/datafile/iEventListPET.hh.

SetKind() [2/2]

void iEventListPET::SetKind ( uint8_t  a_value )

inline

Definition at line 142 of file code/include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

SetPOI1() [1/2]

void iEventListPET::SetPOI1 ( int  a_axis, FLTNBDATA  a_value  )

inline

Definition at line 170 of file include/datafile/iEventListPET.hh.

SetPOI1() [2/2]

void iEventListPET::SetPOI1 ( int  a_axis, FLTNBDATA  a_value  )

inline

Definition at line 183 of file code/include/datafile/iEventListPET.hh.

SetPOI2() [1/2]

void iEventListPET::SetPOI2 ( int  a_axis, FLTNBDATA  a_value  )

inline

Definition at line 178 of file include/datafile/iEventListPET.hh.

Here is the call graph for this function:

SetPOI2() [2/2]

void iEventListPET::SetPOI2 ( int  a_axis, FLTNBDATA  a_value  )

inline

Definition at line 191 of file code/include/datafile/iEventListPET.hh.

Here is the call graph for this function:

SetScatterRate() [1/2]

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

inlinevirtual

Implements iEventPET.

Definition at line 145 of file include/datafile/iEventListPET.hh.

SetScatterRate() [2/2]

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

inlinevirtual

Implements iEventPET.

Definition at line 151 of file code/include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

SetTOFEventResolutionInPs()

void iEventListPET::SetTOFEventResolutionInPs ( FLTNBDATA  resolutionInPs )

inline

Definition at line 221 of file include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

SetTOFMeasurementInPs() [1/2]

void iEventListPET::SetTOFMeasurementInPs ( FLTNB  a_value )

inline

Definition at line 155 of file include/datafile/iEventListPET.hh.

SetTOFMeasurementInPs() [2/2]

void iEventListPET::SetTOFMeasurementInPs ( FLTNB  a_value )

inline

Definition at line 161 of file code/include/datafile/iEventListPET.hh.

Here is the caller graph for this function:

SetTOFMeasurementRangeInPs() [1/2]

void iEventListPET::SetTOFMeasurementRangeInPs ( FLTNB  a_value )

inline

Definition at line 162 of file include/datafile/iEventListPET.hh.

SetTOFMeasurementRangeInPs() [2/2]

void iEventListPET::SetTOFMeasurementRangeInPs ( FLTNB  a_value )

inline

Definition at line 168 of file code/include/datafile/iEventListPET.hh.

Member Data Documentation

m_eventScatRate

FLTNB iEventListPET::m_eventScatRate

private

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

Definition at line 237 of file code/include/datafile/iEventListPET.hh.

m_eventTOFResolutionInPs

FLTNB iEventListPET::m_eventTOFResolutionInPs

private

Event-specific TOF resolution (in ps). Default value = -1 (non existent)

Definition at line 242 of file code/include/datafile/iEventListPET.hh.

m_hasTOFInfo

bool iEventListPET::m_hasTOFInfo

private

Flag indicating whether TOF information exists or not

Definition at line 243 of file code/include/datafile/iEventListPET.hh.

m_kind

uint8_t iEventListPET::m_kind

private

Coincidence type : unknown (=0), true(=1), single scat(=2), multiple scat(=3), random(=4)) Default value =KIND_UNKNOWN

Definition at line 236 of file code/include/datafile/iEventListPET.hh.

m_TOFEventResolutionInPs

FLTNB iEventListPET::m_TOFEventResolutionInPs

private

Event-specific TOF resolution in ps

Definition at line 246 of file include/datafile/iEventListPET.hh.

m_TOFMeasurementInPs

FLTNB iEventListPET::m_TOFMeasurementInPs

private

TOF measurement in ps, corresponding to the difference in arrival time between two coincident photons. Default value = 0.0

Definition at line 238 of file code/include/datafile/iEventListPET.hh.

m_TOFMeasurementRangeInPs

FLTNB iEventListPET::m_TOFMeasurementRangeInPs

private

Maximum range of values for TOF delta time measurements (in ps)

Definition at line 241 of file code/include/datafile/iEventListPET.hh.

mp_POI1

FLTNB iEventListPET::mp_POI1

private

Position of interaction in the crystal #1 along each axis (mm). Default value =0.0;0.0;-1.0

Definition at line 239 of file code/include/datafile/iEventListPET.hh.

mp_POI2

FLTNB iEventListPET::mp_POI2

private

Position of interaction in the crystal #2 along each axis (mm). Default value =0.0;0.0;-1.0

Definition at line 240 of file code/include/datafile/iEventListPET.hh.

---

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

• code/include/datafile/iEventListPET.hh
• code/src/datafile/iEventListPET.cc