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)
	Set the kind of coincidence. More...

void	SetPOI (int a_axis, FLTNBDATA a_value)
	Initialize the POI of the crystal with a value for the specific axis. More...

void	SetEventValue (int a_bin, FLTNBDATA a_value)
	Throw a warning (depending of verbosity) as the event value of a list-mode Event should be equal to 1 and not modified. More...

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

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

virtual FLTNB	GetBlankValue ()
	This is a pure virtual function implemented in the child classes. More...

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

Detailed Description

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

It manages data and functions specific to list mode SPECT.

Definition at line 41 of file iEventListSPECT.hh.

Constructor & Destructor Documentation

iEventListSPECT::iEventListSPECT ( )

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

Definition at line 41 of file iEventListSPECT.cc.

iEventListSPECT::~iEventListSPECT ( )

iEventListSPECT destructor.

Definition at line 58 of file iEventListSPECT.cc.

Member Function Documentation

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 64 of file iEventListSPECT.hh.

void iEventListSPECT::Describe ( )

virtual

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

Reimplemented from iEventSPECT.

Definition at line 77 of file iEventListSPECT.cc.

FLTNB iEventListSPECT::GetEventValue ( int a_bin )

inlinevirtual

Returns: 1 as default for a list-mode Event (a_bin is dedicated to histogram mode, and ignored for list-mode)

Implements iEventSPECT.

Definition at line 98 of file iEventListSPECT.hh.

uint8_t iEventListSPECT::GetKind ( )

inline

Returns: the kind of event

Definition at line 79 of file iEventListSPECT.hh.

Here is the caller graph for this function:

INTNB iEventListSPECT::GetNbValueBins ( )

inlinevirtual

Get the number of event value bins.

Returns: the number of value bins

Implements iEventSPECT.

Definition at line 127 of file iEventListSPECT.hh.

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 85 of file iEventListSPECT.hh.

Here is the caller graph for this function:

FLTNB iEventListSPECT::GetPOI ( int a_axis )

inline

Definition at line 92 of file iEventListSPECT.hh.

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

virtual

Throw a warning (depending of verbosity) as the event value of a list-mode Event should be equal to 1 and not modified.

Parameters

a_bin
a_value

Implements iEventSPECT.

Definition at line 65 of file iEventListSPECT.cc.

Here is the call graph for this function:

void iEventListSPECT::SetKind ( uint8_t a_value )

inline

Set the kind of coincidence.

Parameters

a_value

Definition at line 105 of file iEventListSPECT.hh.

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

inline

Initialize the POI of the crystal with a value for the specific axis.

Parameters

a_axis
a_value

Definition at line 113 of file iEventListSPECT.hh.

Member Data Documentation

uint8_t iEventListSPECT::m_kind

private

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

Definition at line 137 of file iEventListSPECT.hh.

FLTNB iEventListSPECT::mp_POI[3]

private

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

Definition at line 138 of file 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

Member Function Documentation

Member Data Documentation