Inherit from iEventSPECT. Class for SPECT list-mode events. More...

#include <iEventListSPECT.hh>

Inheritance diagram for iEventListSPECT:

Collaboration diagram for iEventListSPECT:

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

	~iEventListSPECT ()
	iEventListSPECT destructor. More...

int	AllocateSpecificData ()
	Function allowing the allocation of specific data. Return 0 by default for iEventListSPECT. More...

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

uint8_t	GetKind ()

FLTNB *	GetPOI ()

FLTNB	GetPOI (int a_axis)

FLTNB	GetEventValue (int a_bin)

void	SetKind (uint8_t a_value)

void	SetPOI (int a_axis, FLTNBDATA a_value)

void	SetEventValue (int a_bin, FLTNBDATA a_value)

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

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

	~iEventListSPECT ()
	iEventListSPECT 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 *	GetPOI ()

FLTNB	GetPOI (int a_axis)

FLTNB	GetEventValue (int a_bin)

void	SetKind (uint8_t a_value)

void	SetPOI (int a_axis, FLTNBDATA a_value)

void	SetEventValue (int a_bin, FLTNBDATA a_value)

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

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

virtual	~iEventSPECT ()
	iEventSPECT destructor. More...

FLTNB	GetNormFactor ()

FLTNB	GetEventScatRate ()

void	SetNormalizationFactor (FLTNBDATA a_value)

void	SetScatterRate (FLTNBDATA a_value)

FLTNB	GetAdditiveCorrections (int a_bin)

FLTNB	GetMultiplicativeCorrections ()

void	MultiplyAdditiveCorrections (FLTNB a_factor)

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

virtual	~iEventSPECT ()
	iEventSPECT destructor. More...

FLTNB	GetNormFactor ()

FLTNB	GetEventScatRate ()

void	SetNormalizationFactor (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...

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)

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	mp_POI [3]

Additional Inherited Members
Protected Attributes inherited from iEventSPECT
FLTNB	m_eventScatRate

FLTNB	m_eventNormFactor

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 iEventSPECT. Class for SPECT list-mode events.

It manages data and functions specific to list mode SPECT.

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

Constructor & Destructor Documentation

◆ iEventListSPECT() [1/2]

iEventListSPECT::iEventListSPECT ( )

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

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

◆ ~iEventListSPECT() [1/2]

iEventListSPECT::~iEventListSPECT ( )

iEventListSPECT destructor.

Definition at line 35 of file code/src/datafile/iEventListSPECT.cc.

◆ iEventListSPECT() [2/2]

iEventListSPECT::iEventListSPECT ( )

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

◆ ~iEventListSPECT() [2/2]

iEventListSPECT::~iEventListSPECT ( )

iEventListSPECT destructor.

Member Function Documentation

◆ AllocateSpecificData() [1/2]

int iEventListSPECT::AllocateSpecificData ( )

inlinevirtual

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

Returns: 0 is success, positive value otherwise

Implements iEventSPECT.

Definition at line 41 of file code/include/datafile/iEventListSPECT.hh.

Here is the call graph for this function:

◆ AllocateSpecificData() [2/2]

int iEventListSPECT::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 iEventSPECT.

Definition at line 41 of file include/datafile/iEventListSPECT.hh.

Here is the call graph for this function:

◆ Describe() [1/2]

void iEventListSPECT::Describe ( )

virtual

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

Reimplemented from iEventSPECT.

Definition at line 54 of file code/src/datafile/iEventListSPECT.cc.

Here is the caller graph for this function:

◆ Describe() [2/2]

void iEventListSPECT::Describe ( )

virtual

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

Reimplemented from iEventSPECT.

◆ GetEventValue() [1/2]

FLTNB iEventListSPECT::GetEventValue ( int a_bin )

inlinevirtual

Implements iEventSPECT.

Definition at line 75 of file include/datafile/iEventListSPECT.hh.

◆ GetEventValue() [2/2]

FLTNB iEventListSPECT::GetEventValue ( int a_bin )

inlinevirtual

Implements iEventSPECT.

Definition at line 75 of file code/include/datafile/iEventListSPECT.hh.

◆ GetKind() [1/2]

uint8_t iEventListSPECT::GetKind ( )

inline

Returns: the kind of event

Definition at line 56 of file code/include/datafile/iEventListSPECT.hh.

Here is the caller graph for this function:

◆ GetKind() [2/2]

uint8_t iEventListSPECT::GetKind ( )

inline

Definition at line 56 of file include/datafile/iEventListSPECT.hh.

◆ GetNbValueBins() [1/2]

INTNB iEventListSPECT::GetNbValueBins ( )

inlinevirtual

Get the number of event value bins.

Returns: the number of value bins

Implements iEventSPECT.

Definition at line 104 of file include/datafile/iEventListSPECT.hh.

◆ GetNbValueBins() [2/2]

INTNB iEventListSPECT::GetNbValueBins ( )

inlinevirtual

Get the number of event value bins.

Returns: the number of value bins

Implements iEventSPECT.

Definition at line 104 of file code/include/datafile/iEventListSPECT.hh.

◆ GetPOI() [1/4]

FLTNB * iEventListSPECT::GetPOI ( )

inline

Returns: the pointer containing the 3 indices for the Point Of Interaction of the crystal

Parameters

a_axis

Returns: the POI value for the specific axis

Definition at line 62 of file code/include/datafile/iEventListSPECT.hh.

Here is the caller graph for this function:

◆ GetPOI() [2/4]

FLTNB* iEventListSPECT::GetPOI ( )

inline

Definition at line 62 of file include/datafile/iEventListSPECT.hh.

◆ GetPOI() [3/4]

FLTNB iEventListSPECT::GetPOI ( int a_axis )

inline

Definition at line 69 of file code/include/datafile/iEventListSPECT.hh.

◆ GetPOI() [4/4]

FLTNB iEventListSPECT::GetPOI ( int a_axis )

inline

Definition at line 69 of file include/datafile/iEventListSPECT.hh.

◆ SetEventValue() [1/2]

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

virtual

Implements iEventSPECT.

Definition at line 42 of file code/src/datafile/iEventListSPECT.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetEventValue() [2/2]

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

virtual

Implements iEventSPECT.

◆ SetKind() [1/2]

void iEventListSPECT::SetKind ( uint8_t a_value )

inline

Definition at line 82 of file include/datafile/iEventListSPECT.hh.

◆ SetKind() [2/2]

void iEventListSPECT::SetKind ( uint8_t a_value )

inline

Definition at line 82 of file code/include/datafile/iEventListSPECT.hh.

Here is the caller graph for this function:

◆ SetPOI() [1/2]

void iEventListSPECT::SetPOI	(	int	a_axis,
		FLTNBDATA	a_value
	)

inline

Definition at line 90 of file include/datafile/iEventListSPECT.hh.

Here is the call graph for this function:

◆ SetPOI() [2/2]

void iEventListSPECT::SetPOI	(	int	a_axis,
		FLTNBDATA	a_value
	)

inline

Definition at line 90 of file code/include/datafile/iEventListSPECT.hh.

Here is the call graph for this function:

Member Data Documentation

◆ m_kind

uint8_t iEventListSPECT::m_kind

private

Event type : unknown (=0), true(=1), single scat(=2), multiple scat(=3)) Default value =0

Definition at line 114 of file code/include/datafile/iEventListSPECT.hh.

◆ mp_POI

FLTNB iEventListSPECT::mp_POI

private

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

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

◆ iEventListSPECT() [1/2]

◆ ~iEventListSPECT() [1/2]

◆ iEventListSPECT() [2/2]

◆ ~iEventListSPECT() [2/2]

Member Function Documentation

◆ AllocateSpecificData() [1/2]

◆ AllocateSpecificData() [2/2]

◆ Describe() [1/2]

◆ Describe() [2/2]

◆ GetEventValue() [1/2]

◆ GetEventValue() [2/2]

◆ GetKind() [1/2]

◆ GetKind() [2/2]

◆ GetNbValueBins() [1/2]

◆ GetNbValueBins() [2/2]

◆ GetPOI() [1/4]

◆ GetPOI() [2/4]

◆ GetPOI() [3/4]

◆ GetPOI() [4/4]

◆ SetEventValue() [1/2]

◆ SetEventValue() [2/2]

◆ SetKind() [1/2]

◆ SetKind() [2/2]

◆ SetPOI() [1/2]

◆ SetPOI() [2/2]

Member Data Documentation

◆ m_kind

◆ mp_POI