iEventCT Class Reference

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

#include <iEventCT.hh>

Inheritance diagram for iEventCT:

Collaboration diagram for iEventCT:

Public Member Functions
	iEventCT ()
	iEventCT constructor. Initialize the member variables to their default values. More...
virtual	~iEventCT ()
	iEventCT destructor. More...
virtual int	AllocateSpecificData ()=0
	Pure virtual function implemented in the child classes, dedicated to the allocation of specific data in the child classes. More...
virtual void	Describe ()
	This function can be used to get a description of the event printed out. More...
FLTNB	GetBlankValue ()
FLTNB	GetEventScatRate ()
void	SetBlankValue (FLTNBDATA a_value)
void	SetScatterRate (FLTNBDATA a_value)
FLTNB	GetAdditiveCorrections (int a_bin)
FLTNB	GetMultiplicativeCorrections ()
virtual FLTNB	GetEventValue (int a_bin)=0
virtual void	SetEventValue (int a_bin, FLTNBDATA a_value)=0
virtual INTNB	GetNbValueBins ()=0
	Get the number of event value bins. More...
void	MultiplyAdditiveCorrections (FLTNB a_factor)
	iEventCT ()
	iEventCT constructor. Initialize the member variables to their default values. More...
virtual	~iEventCT ()
	iEventCT destructor. More...
virtual int	AllocateSpecificData ()=0
	Pure virtual function implemented in the child classes, dedicated to the allocation of specific data in the child classes. More...
virtual void	Describe ()
	This function can be used to get a description of the event printed out. More...
FLTNB	GetBlankValue ()
	This is a pure virtual function implemented in the child classes. More...
FLTNB	GetEventScatRate ()
void	SetBlankValue (FLTNBDATA a_value)
void	SetScatterRate (FLTNBDATA a_value)
FLTNB	GetAdditiveCorrections (int a_bin)
FLTNB	GetMultiplicativeCorrections ()
	This is a pure virtual function implemented in the child classes. More...
virtual FLTNB	GetEventValue (int a_bin)=0
virtual void	SetEventValue (int a_bin, FLTNBDATA a_value)=0
virtual INTNB	GetNbValueBins ()=0
	Get the number of event value bins. More...
void	MultiplyAdditiveCorrections (FLTNB a_factor)
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)
	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)
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)

Protected Attributes
FLTNB	m_eventScatRate
FLTNB	m_eventBlankValue
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 vEvent. Main CT 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 dedicated to histogram and list mode SPECT.

Definition at line 19 of file code/include/datafile/iEventCT.hh.

Constructor & Destructor Documentation

iEventCT() [1/2]

iEventCT::iEventCT

(

)

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

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

~iEventCT() [1/2]

iEventCT::~iEventCT ( )

virtual

iEventCT destructor.

Definition at line 32 of file code/src/datafile/iEventCT.cc.

iEventCT() [2/2]

iEventCT::iEventCT

(

)

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

~iEventCT() [2/2]

virtual iEventCT::~iEventCT ( )

virtual

iEventCT destructor.

Member Function Documentation

AllocateSpecificData() [1/2]

int iEventCT::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 iEventHistoCT, iEventListCT, iEventHistoCT, and iEventListCT.

AllocateSpecificData() [2/2]

virtual int iEventCT::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 iEventHistoCT, iEventListCT, iEventHistoCT, and iEventListCT.

Describe() [1/2]

void iEventCT::Describe ( )

virtual

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

Implements vEvent.

Reimplemented in iEventHistoCT, iEventListCT, iEventHistoCT, and iEventListCT.

Definition at line 39 of file code/src/datafile/iEventCT.cc.

Describe() [2/2]

virtual void iEventCT::Describe ( )

virtual

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

Implements vEvent.

Reimplemented in iEventHistoCT, iEventListCT, iEventHistoCT, and iEventListCT.

GetAdditiveCorrections() [1/2]

FLTNB iEventCT::GetAdditiveCorrections ( int  a_bin )

inlinevirtual

Implements vEvent.

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

GetAdditiveCorrections() [2/2]

FLTNB iEventCT::GetAdditiveCorrections ( int  a_bin )

inlinevirtual

Implements vEvent.

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

GetBlankValue() [1/2]

FLTNB iEventCT::GetBlankValue ( )

inlinevirtual

Overload of the vEvent function which simply returns 0.

Returns

the blank value

Reimplemented from vEvent.

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

Here is the caller graph for this function:

GetBlankValue() [2/2]

FLTNB iEventCT::GetBlankValue ( )

inlinevirtual

This is a pure virtual function implemented in the child classes.

Returns

the blank measurement if relevant, 0. otherwise

Reimplemented from vEvent.

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

GetEventScatRate() [1/2]

FLTNB iEventCT::GetEventScatRate ( )

inline

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

GetEventScatRate() [2/2]

FLTNB iEventCT::GetEventScatRate ( )

inline

Returns

the correction term for scatters as a rate in 1/s

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

Here is the caller graph for this function:

GetEventValue() [1/2]

virtual FLTNB iEventCT::GetEventValue ( int  a_bin )

pure virtual

Implements vEvent.

Implemented in iEventListCT, iEventListCT, iEventHistoCT, and iEventHistoCT.

Here is the caller graph for this function:

GetEventValue() [2/2]

virtual FLTNB iEventCT::GetEventValue ( int  a_bin )

pure virtual

Implements vEvent.

Implemented in iEventListCT, iEventListCT, iEventHistoCT, and iEventHistoCT.

GetMultiplicativeCorrections() [1/2]

FLTNB iEventCT::GetMultiplicativeCorrections ( )

inlinevirtual

Returns

1 as there are no multiplicative corrections yet for this implementation

Implements vEvent.

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

Here is the call graph for this function:

GetMultiplicativeCorrections() [2/2]

FLTNB iEventCT::GetMultiplicativeCorrections ( )

inlinevirtual

This is a pure virtual function implemented in the child classes.

Returns

the product of the multiplicative corrections terms for this event

Implements vEvent.

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

Here is the call graph for this function:

GetNbValueBins() [1/2]

virtual INTNB iEventCT::GetNbValueBins ( )

pure virtual

Get the number of event value bins.

Returns

the number of value bins

Implements vEvent.

Implemented in iEventListCT, iEventListCT, iEventHistoCT, and iEventHistoCT.

GetNbValueBins() [2/2]

virtual INTNB iEventCT::GetNbValueBins ( )

pure virtual

Get the number of event value bins.

Returns

the number of value bins

Implements vEvent.

Implemented in iEventListCT, iEventListCT, iEventHistoCT, and iEventHistoCT.

Here is the caller graph for this function:

MultiplyAdditiveCorrections() [1/2]

void iEventCT::MultiplyAdditiveCorrections ( FLTNB  a_factor )

inlinevirtual

Implements vEvent.

Definition at line 120 of file code/include/datafile/iEventCT.hh.

MultiplyAdditiveCorrections() [2/2]

void iEventCT::MultiplyAdditiveCorrections ( FLTNB  a_factor )

inlinevirtual

Implements vEvent.

Definition at line 120 of file include/datafile/iEventCT.hh.

SetBlankValue() [1/2]

void iEventCT::SetBlankValue ( FLTNBDATA  a_value )

inline

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

SetBlankValue() [2/2]

void iEventCT::SetBlankValue ( FLTNBDATA  a_value )

inline

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

SetEventValue() [1/2]

virtual void iEventCT::SetEventValue ( int  a_bin, FLTNBDATA  a_value  )

pure virtual

Implements vEvent.

Implemented in iEventListCT, iEventListCT, iEventHistoCT, and iEventHistoCT.

SetEventValue() [2/2]

virtual void iEventCT::SetEventValue ( int  a_bin, FLTNBDATA  a_value  )

pure virtual

Implements vEvent.

Implemented in iEventListCT, iEventListCT, iEventHistoCT, and iEventHistoCT.

Here is the caller graph for this function:

SetScatterRate() [1/2]

void iEventCT::SetScatterRate ( FLTNBDATA  a_value )

inline

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

SetScatterRate() [2/2]

void iEventCT::SetScatterRate ( FLTNBDATA  a_value )

inline

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

Member Data Documentation

m_eventBlankValue

FLTNB iEventCT::m_eventBlankValue

protected

Blank term. Default value =1.0

Definition at line 131 of file code/include/datafile/iEventCT.hh.

m_eventScatRate

FLTNB iEventCT::m_eventScatRate

protected

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

Definition at line 130 of file code/include/datafile/iEventCT.hh.

---

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

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