CASToR  2.0
Tomographic Reconstruction (PET/SPECT/CT)
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | List of all members
iEventHistoSPECT Class Reference

Inherit from iEventSPECT. Class for SPECT histogram mode events. More...

#include <iEventHistoSPECT.hh>

Inheritance diagram for iEventHistoSPECT:
Inheritance graph
Collaboration diagram for iEventHistoSPECT:
Collaboration graph

Public Member Functions

 iEventHistoSPECT ()
 iEventHistoSPECT constructor. Initialize the member variables to their default values. More...
 
 ~iEventHistoSPECT ()
 iEventHistoSPECT destructor. More...
 
int AllocateSpecificData ()
 Function allowing the allocation of specific data. Return 0 by default for iEventHistoSPECT. More...
 
void Describe ()
 This function can be used to get a description of the event printed out. More...
 
FLTNB GetEventValue (int a_bin)
 
void SetEventValue (int a_bin, FLTNBDATA a_value)
 Cast the FLTNBDATA value passed in parameters in FLTNB, and use it to set the event value (a_bin is dedicated to PET and ignored for SPECT) 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...
 

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 histogram mode events.

It manages data and functions specific to histo mode SPECT.

Definition at line 41 of file iEventHistoSPECT.hh.

Constructor & Destructor Documentation

iEventHistoSPECT::iEventHistoSPECT ( )

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

Definition at line 40 of file iEventHistoSPECT.cc.

iEventHistoSPECT::~iEventHistoSPECT ( )

iEventHistoSPECT destructor.

Definition at line 52 of file iEventHistoSPECT.cc.

Member Function Documentation

int iEventHistoSPECT::AllocateSpecificData ( )
inlinevirtual

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

Returns
0 is success, positive value otherwise

Implements iEventSPECT.

Definition at line 64 of file iEventHistoSPECT.hh.

void iEventHistoSPECT::Describe ( )
virtual

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

Reimplemented from iEventSPECT.

Definition at line 59 of file iEventHistoSPECT.cc.

FLTNB iEventHistoSPECT::GetEventValue ( int  a_bin)
inlinevirtual
Parameters
a_bin(0 if noTOF)
Returns
the event value (a_bin is dedicated to PET and ignored for SPECT)

Implements iEventSPECT.

Definition at line 80 of file iEventHistoSPECT.hh.

Here is the caller graph for this function:

INTNB iEventHistoSPECT::GetNbValueBins ( )
inlinevirtual

Get the number of event value bins.

Returns
the number of value bins

Implements iEventSPECT.

Definition at line 95 of file iEventHistoSPECT.hh.

void iEventHistoSPECT::SetEventValue ( int  a_bin,
FLTNBDATA  a_value 
)
inlinevirtual

Cast the FLTNBDATA value passed in parameters in FLTNB, and use it to set the event value (a_bin is dedicated to PET and ignored for SPECT)

Parameters
a_bin(0 if noTOF)
a_value

Implements iEventSPECT.

Definition at line 88 of file iEventHistoSPECT.hh.


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