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

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

#include <iEventListSPECT.hh>

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

List of all members.

Public Member Functions

 iEventListSPECT ()
 iEventListSPECT constructor. Initialize the member variables to their default values.
 ~iEventListSPECT ()
 iEventListSPECT destructor.
int AllocateSpecificData ()
 Function allowing the allocation of specific data. Return 0 by default for iEventListSPECT.
void Describe ()
 This function can be used to get a description of the event printed out.
uint8_t GetKind ()
FLTNBGetPOI ()
FLTNB GetPOI (int a_axis)
FLTNB GetEventValue (int a_bin)
void SetKind (uint8_t a_value)
 Set the kind of coincidence.
void SetPOI (int a_axis, FLTNBDATA a_value)
 Initialize the POI of the crystal 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.

Private Attributes

uint8_t m_kind
FLTNB mp_POI [3]

Detailed Description

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

It manages data and functions specific to list mode SPECT.

Definition at line 21 of file iEventListSPECT.hh.


Constructor & Destructor Documentation

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

Definition at line 30 of file iEventListSPECT.cc.

iEventListSPECT destructor.

Definition at line 46 of file iEventListSPECT.cc.


Member Function Documentation

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

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 45 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 72 of file iEventListSPECT.cc.

FLTNB iEventListSPECT::GetEventValue ( int  a_bin) [inline, virtual]
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 80 of file iEventListSPECT.hh.

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

Definition at line 61 of file iEventListSPECT.hh.

Here is the caller graph for this function:

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

Here is the caller graph for this function:

FLTNB iEventListSPECT::GetPOI ( int  a_axis) [inline]

Definition at line 74 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 58 of file iEventListSPECT.cc.

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

Set the kind of coincidence.

Parameters:
a_value

Definition at line 87 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 95 of file iEventListSPECT.hh.


Member Data Documentation

uint8_t iEventListSPECT::m_kind [private]

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

Definition at line 114 of file iEventListSPECT.hh.

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

Definition at line 115 of file iEventListSPECT.hh.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Typedefs Defines