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)

void	SetEventNbTOFBins (uint16_t a_value)

void	SetEventValue (int a_bin, FLTNBDATA a_value)

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

FLTNB	GetAdditiveCorrections (int a_bin)

void	MultiplyAdditiveCorrections (FLTNB a_factor)

	iEventHistoPET ()
	iEventHistoPET constructor. Initialize the member variables to their default values. More...

	~iEventHistoPET ()
	iEventHistoPET 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...

FLTNB	GetEventScatRate (int a_bin)

uint16_t	GetEventNbTOFBins ()

FLTNB	GetEventValue (int a_bin)

void	SetScatterRate (int a_bin, FLTNBDATA a_value)

void	SetEventNbTOFBins (uint16_t a_value)

void	SetEventValue (int a_bin, FLTNBDATA a_value)

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

FLTNB	GetAdditiveCorrections (int a_bin)

void	MultiplyAdditiveCorrections (FLTNB a_factor)

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

int64_t	m_eventIndex

EVTFLTDATA *	mp_customFLTData

EVTINTDATA *	mp_customINTData

int	m_nbCustomFLTData

int	m_nbCustomINTData

Detailed Description

Inherit from iEventPET. Class for PET histogram mode events.

It manages data and functions specific to histo mode PET.

Definition at line 18 of file code/include/datafile/iEventHistoPET.hh.

Constructor & Destructor Documentation

◆ iEventHistoPET() [1/2]

iEventHistoPET::iEventHistoPET ( )

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

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

◆ ~iEventHistoPET() [1/2]

iEventHistoPET::~iEventHistoPET ( )

iEventHistoPET destructor.

Definition at line 34 of file code/src/datafile/iEventHistoPET.cc.

◆ iEventHistoPET() [2/2]

iEventHistoPET::iEventHistoPET ( )

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

◆ ~iEventHistoPET() [2/2]

iEventHistoPET::~iEventHistoPET ( )

iEventHistoPET destructor.

Member Function Documentation

◆ AllocateSpecificData() [1/2]

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 45 of file code/src/datafile/iEventHistoPET.cc.

◆ AllocateSpecificData() [2/2]

int iEventHistoPET::AllocateSpecificData ( )

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

◆ Describe() [1/2]

void iEventHistoPET::Describe ( )

virtual

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

Reimplemented from iEventPET.

Definition at line 83 of file code/src/datafile/iEventHistoPET.cc.

◆ Describe() [2/2]

void iEventHistoPET::Describe ( )

virtual

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

Reimplemented from iEventPET.

◆ GetAdditiveCorrections() [1/2]

FLTNB iEventHistoPET::GetAdditiveCorrections ( int a_bin )

virtual

Implements iEventPET.

Definition at line 72 of file code/src/datafile/iEventHistoPET.cc.

Here is the caller graph for this function:

◆ GetAdditiveCorrections() [2/2]

FLTNB iEventHistoPET::GetAdditiveCorrections ( int a_bin )

virtual

Implements iEventPET.

◆ GetEventNbTOFBins() [1/2]

uint16_t iEventHistoPET::GetEventNbTOFBins ( )

inline

Returns: the number of TOF bins in the Event

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

◆ GetEventNbTOFBins() [2/2]

uint16_t iEventHistoPET::GetEventNbTOFBins ( )

inline

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

◆ GetEventScatRate() [1/2]

FLTNB iEventHistoPET::GetEventScatRate ( int a_bin )

inline

Definition at line 57 of file code/include/datafile/iEventHistoPET.hh.

Here is the caller graph for this function:

◆ GetEventScatRate() [2/2]

FLTNB iEventHistoPET::GetEventScatRate ( int a_bin )

inline

Definition at line 57 of file include/datafile/iEventHistoPET.hh.

◆ GetEventValue() [1/2]

FLTNB iEventHistoPET::GetEventValue ( int a_bin )

inlinevirtual

Implements iEventPET.

Definition at line 70 of file include/datafile/iEventHistoPET.hh.

◆ GetEventValue() [2/2]

FLTNB iEventHistoPET::GetEventValue ( int a_bin )

inlinevirtual

Implements iEventPET.

Definition at line 70 of file code/include/datafile/iEventHistoPET.hh.

Here is the caller graph for this function:

◆ GetNbValueBins() [1/2]

INTNB iEventHistoPET::GetNbValueBins ( )

inlinevirtual

Get the number of event value bins.

Returns: the number of value bins

Implements iEventPET.

Definition at line 100 of file code/include/datafile/iEventHistoPET.hh.

Here is the call graph for this function:

◆ GetNbValueBins() [2/2]

INTNB iEventHistoPET::GetNbValueBins ( )

inlinevirtual

Get the number of event value bins.

Returns: the number of value bins

Implements iEventPET.

Definition at line 100 of file include/datafile/iEventHistoPET.hh.

Here is the call graph for this function:

◆ MultiplyAdditiveCorrections() [1/2]

void iEventHistoPET::MultiplyAdditiveCorrections ( FLTNB a_factor )

inlinevirtual

Implements vEvent.

Definition at line 112 of file code/include/datafile/iEventHistoPET.hh.

◆ MultiplyAdditiveCorrections() [2/2]

void iEventHistoPET::MultiplyAdditiveCorrections ( FLTNB a_factor )

inlinevirtual

Implements vEvent.

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

◆ SetEventNbTOFBins() [1/2]

void iEventHistoPET::SetEventNbTOFBins ( uint16_t a_value )

inline

Definition at line 85 of file include/datafile/iEventHistoPET.hh.

◆ SetEventNbTOFBins() [2/2]

void iEventHistoPET::SetEventNbTOFBins ( uint16_t a_value )

inline

Definition at line 85 of file code/include/datafile/iEventHistoPET.hh.

◆ SetEventValue() [1/2]

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

inlinevirtual

Implements iEventPET.

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

Here is the caller graph for this function:

◆ SetEventValue() [2/2]

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

inlinevirtual

Implements iEventPET.

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

◆ SetScatterRate() [1/2]

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

inlinevirtual

Implements iEventPET.

Definition at line 78 of file include/datafile/iEventHistoPET.hh.

◆ SetScatterRate() [2/2]

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

inlinevirtual

Implements iEventPET.

Definition at line 78 of file code/include/datafile/iEventHistoPET.hh.

Here is the caller graph for this function:

Member Data Documentation

◆ m_eventNbTOFBins

uint16_t iEventHistoPET::m_eventNbTOFBins

private

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

Definition at line 124 of file code/include/datafile/iEventHistoPET.hh.

◆ mp_eventScatRate

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 123 of file code/include/datafile/iEventHistoPET.hh.

◆ mp_eventValue

FLTNB * iEventHistoPET::mp_eventValue

private

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

Definition at line 122 of file code/include/datafile/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

◆ iEventHistoPET() [1/2]

◆ ~iEventHistoPET() [1/2]

◆ iEventHistoPET() [2/2]

◆ ~iEventHistoPET() [2/2]

Member Function Documentation

◆ AllocateSpecificData() [1/2]

◆ AllocateSpecificData() [2/2]

◆ Describe() [1/2]

◆ Describe() [2/2]

◆ GetAdditiveCorrections() [1/2]

◆ GetAdditiveCorrections() [2/2]

◆ GetEventNbTOFBins() [1/2]

◆ GetEventNbTOFBins() [2/2]

◆ GetEventScatRate() [1/2]

◆ GetEventScatRate() [2/2]

◆ GetEventValue() [1/2]

◆ GetEventValue() [2/2]

◆ GetNbValueBins() [1/2]

◆ GetNbValueBins() [2/2]

◆ MultiplyAdditiveCorrections() [1/2]

◆ MultiplyAdditiveCorrections() [2/2]

◆ SetEventNbTOFBins() [1/2]

◆ SetEventNbTOFBins() [2/2]

◆ SetEventValue() [1/2]

◆ SetEventValue() [2/2]

◆ SetScatterRate() [1/2]

◆ SetScatterRate() [2/2]

Member Data Documentation

◆ m_eventNbTOFBins

◆ mp_eventScatRate

◆ mp_eventValue