CASToR  1.0
Tomographic Reconstruction (PET/SPECT)
Public Member Functions | Private Attributes
iEventListPET Class Reference

Inherit from iEventPET. Class for PET list-mode events. More...

#include <iEventListPET.hh>

Inheritance diagram for iEventListPET:
Inheritance graph
[legend]
Collaboration diagram for iEventListPET:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 iEventListPET ()
 iEventListPET constructor. Initialize the member variables to their default values.
 ~iEventListPET ()
 iEventListPET destructor.
int AllocateSpecificData ()
 Function allowing the allocation of specific data. Return 0 by default for iEventListPET.
void Describe ()
 This function can be used to get a description of the event printed out.
uint8_t GetKind ()
FLTNB GetEventScatRate (int a_bin)
uint32_t GetTOFMeasurement ()
FLTNB * GetPOI1 ()
FLTNB * GetPOI2 ()
FLTNB GetPOI1 (uint8_t axis)
FLTNB GetPOI2 (uint8_t axis)
FLTNB GetEventValue (int a_bin)
void SetKind (uint8_t a_value)
 Set the kind of coincidence.
void SetScatterRate (int a_bin, FLTNBDATA a_value)
 Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the scatter correction rate in 1/s (a_bin is dedicated to histogram mode, and ignored for list-mode)
void SetTOFMeasurement (uint32_t a_value)
 Initialize the TOFmeasurement with a value passed in parameters.
void SetPOI1 (int a_axis, FLTNBDATA a_value)
 Initialize the POI of the crystal #1 with a value for the specific axis.
void SetPOI2 (int a_axis, FLTNBDATA a_value)
 Initialize the POI of the crystal #2 with a value for the specific axis.
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 ?
FLTNB GetAdditiveCorrections (int a_bin)

Private Attributes

uint8_t m_kind
FLTNB m_eventScatRate
uint32_t m_TOFMeasurement
FLTNB mp_POI1 [3]
FLTNB mp_POI2 [3]

Detailed Description

Inherit from iEventPET. Class for PET list-mode events.

It manages data and functions specific to list mode PET.

Definition at line 37 of file iEventListPET.hh.

Constructor & Destructor Documentation

iEventListPET::iEventListPET ( )

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

Definition at line 34 of file iEventListPET.cc.

iEventListPET::~iEventListPET ( )

iEventListPET destructor.

Definition at line 61 of file iEventListPET.cc.

Member Function Documentation

int iEventListPET::AllocateSpecificData ( ) [inline, virtual]

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

Returns:
0 is success, positive value otherwise

Implements iEventPET.

Definition at line 61 of file iEventListPET.hh.

void iEventListPET::Describe ( ) [virtual]

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

Reimplemented from iEventPET.

Definition at line 91 of file iEventListPET.cc.

FLTNB iEventListPET::GetAdditiveCorrections ( int  a_bin) [inline, virtual]
Parameters:
abin (0 if noTOF)
Returns:
The sum of additive correction terms (the TOF bin parameter is ignored for list-mode PET)

Implements iEventPET.

Definition at line 175 of file iEventListPET.hh.

FLTNB iEventListPET::GetEventScatRate ( int  a_bin) [inline]
Parameters:
a_bin(0 if noTOF)
Returns:
the scatter correction rate in 1/s for this list-mode event (a_bin is dedicated to histogram mode, and ignored for list-mode)

Definition at line 83 of file iEventListPET.hh.

Here is the caller graph for this function:

FLTNB iEventListPET::GetEventValue ( int  a_bin) [inline, virtual]
Parameters:
abin (0 if noTOF)
Returns:
1 as default for a list-mode Event (a_bin is dedicated to histogram mode, and ignored for list-mode)

Implements iEventPET.

Definition at line 122 of file iEventListPET.hh.

uint8_t iEventListPET::GetKind ( ) [inline]
Returns:
the kind of coincidence

Definition at line 76 of file iEventListPET.hh.

Here is the caller graph for this function:

FLTNB iEventListPET::GetPOI1 ( ) [inline]
Returns:
the pointer containing the 3 indices for the Point Of Interaction of the 1st crystal
Parameters:
axis
Returns:
the Point of interaction of the 1st crystal along the axis specified in parameter

Definition at line 95 of file iEventListPET.hh.

Here is the caller graph for this function:

FLTNB iEventListPET::GetPOI1 ( uint8_t  axis) [inline]

Definition at line 108 of file iEventListPET.hh.

FLTNB iEventListPET::GetPOI2 ( ) [inline]
Returns:
the pointer containing the 3 indices for the Point Of Interaction of the 2nd crystal
Parameters:
axis
Returns:
the Point of interaction of the 2nd crystal along the axis specified in parameter

Definition at line 101 of file iEventListPET.hh.

Here is the caller graph for this function:

FLTNB iEventListPET::GetPOI2 ( uint8_t  axis) [inline]

Definition at line 115 of file iEventListPET.hh.

uint32_t iEventListPET::GetTOFMeasurement ( ) [inline]
Returns:
the TOF measurement value

Definition at line 89 of file iEventListPET.hh.

Here is the caller graph for this function:

void iEventListPET::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(0 if noTOF)
a_value

Implements iEventPET.

Definition at line 77 of file iEventListPET.cc.

void iEventListPET::SetKind ( uint8_t  a_value) [inline]

Set the kind of coincidence.

Parameters:
a_value

Definition at line 129 of file iEventListPET.hh.

void iEventListPET::SetPOI1 ( int  a_axis,
FLTNBDATA  a_value 
) [inline]

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

Parameters:
a_axis
a_value

Definition at line 153 of file iEventListPET.hh.

void iEventListPET::SetPOI2 ( int  a_axis,
FLTNBDATA  a_value 
) [inline]

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

Parameters:
a_axis
a_value

Definition at line 161 of file iEventListPET.hh.

void iEventListPET::SetScatterRate ( int  a_bin,
FLTNBDATA  a_value 
) [inline, virtual]

Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the scatter correction rate in 1/s (a_bin is dedicated to histogram mode, and ignored for list-mode)

Parameters:
abin (no use for list-mode)
a_value

Implements iEventPET.

Definition at line 138 of file iEventListPET.hh.

void iEventListPET::SetTOFMeasurement ( uint32_t  a_value) [inline]

Initialize the TOFmeasurement with a value passed in parameters.

Parameters:
a_value

Definition at line 145 of file iEventListPET.hh.

Member Data Documentation

FLTNB iEventListPET::m_eventScatRate [private]

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

Definition at line 188 of file iEventListPET.hh.

uint8_t iEventListPET::m_kind [private]

Coincidence type : unknown (=0), true(=1), single scat(=2), multiple scat(=3), random(=4)) Default value =KIND_UNKNOWN

Definition at line 187 of file iEventListPET.hh.

uint32_t iEventListPET::m_TOFMeasurement [private]

TOF time in ps, corresponding to the difference in arrival time between the two photons. Default value =0.0

Definition at line 189 of file iEventListPET.hh.

FLTNB iEventListPET::mp_POI1[3] [private]

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

Definition at line 190 of file iEventListPET.hh.

FLTNB iEventListPET::mp_POI2[3] [private]

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

Definition at line 191 of file iEventListPET.hh.

The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Typedefs Defines
Generated on Thu Mar 23 2017 19:08:37 for CASToR by   doxygen 1.7.6.1