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)
	Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the blank value. More...

void	SetScatterRate (FLTNBDATA a_value)
	Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the scatter correction rate. More...

FLTNB	GetAdditiveCorrections (int a_bin)

FLTNB	GetMultiplicativeCorrections ()

virtual FLTNB	GetEventValue (int a_bin)=0
	Pure virtual function implemented in the child classes. More...

virtual void	SetEventValue (int a_bin, FLTNBDATA a_value)=0
	Set the event value, this is a pure virtual function implemented in the child classes. More...

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

void	MultiplyAdditiveCorrections (FLTNB a_factor)
	Divide additive corrections by the provided factor (scatters) 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)
	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...

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

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 42 of file iEventCT.hh.

Constructor & Destructor Documentation

iEventCT::iEventCT ( )

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

Definition at line 41 of file iEventCT.cc.

iEventCT::~iEventCT ( )

virtual

iEventCT destructor.

Definition at line 55 of file iEventCT.cc.

Member Function Documentation

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, and iEventListCT.

void iEventCT::Describe ( )

virtual

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

Implements vEvent.

Reimplemented in iEventHistoCT, and iEventListCT.

Definition at line 62 of file iEventCT.cc.

FLTNB iEventCT::GetAdditiveCorrections ( int a_bin )

inlinevirtual

Parameters

a	bin (0 if only one line)

Returns: Just return the scatter rate (the TOF bin parameter is ignored for SPECT)

Implements vEvent.

Definition at line 107 of file iEventCT.hh.

FLTNB iEventCT::GetBlankValue ( )

inlinevirtual

Overload of the vEvent function which simply returns 0.

Returns: the blank value

Reimplemented from vEvent.

Definition at line 80 of file iEventCT.hh.

Here is the caller graph for this function:

FLTNB iEventCT::GetEventScatRate ( )

inline

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

Definition at line 86 of file iEventCT.hh.

Here is the caller graph for this function:

FLTNB iEventCT::GetEventValue ( int a_bin )

pure virtual

Pure virtual function implemented in the child classes.

Parameters

a	bin (0 if only one line)

Returns: the value of the event

Implements vEvent.

Implemented in iEventListCT, and iEventHistoCT.

FLTNB iEventCT::GetMultiplicativeCorrections ( )

inlinevirtual

Returns: 1 as there are no multiplicative corrections yet for this implementation

Implements vEvent.

Definition at line 113 of file iEventCT.hh.

virtual INTNB iEventCT::GetNbValueBins ( )

pure virtual

Get the number of event value bins.

Returns: the number of value bins

Implements vEvent.

Implemented in iEventListCT, and iEventHistoCT.

void iEventCT::MultiplyAdditiveCorrections ( FLTNB a_factor )

inlinevirtual

Divide additive corrections by the provided factor (scatters)

Parameters

FLTNB a_factor

Implements vEvent.

Definition at line 140 of file iEventCT.hh.

void iEventCT::SetBlankValue ( FLTNBDATA a_value )

inline

Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the blank value.

Parameters

a	blank value

Definition at line 93 of file iEventCT.hh.

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

pure virtual

Set the event value, this is a pure virtual function implemented in the child classes.

Parameters

a	bin (0 if only one line)
a_value

Implements vEvent.

Implemented in iEventListCT, and iEventHistoCT.

void iEventCT::SetScatterRate ( FLTNBDATA a_value )

inline

Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the scatter correction rate.

Parameters

a_value

Definition at line 100 of file iEventCT.hh.

Member Data Documentation

FLTNB iEventCT::m_eventBlankValue

protected

Blank term. Default value =1.0

Definition at line 151 of file iEventCT.hh.

FLTNB iEventCT::m_eventScatRate

protected

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

Definition at line 150 of file iEventCT.hh.

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation