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

Inherit from iEventCT. Class for CT list-mode events. More...

#include <iEventListCT.hh>

Inheritance diagram for iEventListCT:
Inheritance graph
Collaboration diagram for iEventListCT:
Collaboration graph

Public Member Functions

 iEventListCT ()
 iEventListCT constructor. Initialize the member variables to their default values. More...
 
 ~iEventListCT ()
 iEventListCT destructor. More...
 
int AllocateSpecificData ()
 Function allowing the allocation of specific data. Return 0 by default for iEventListCT. More...
 
void Describe ()
 This function can be used to get a description of the event printed out. More...
 
uint8_t GetKind ()
 
FLTNB GetEventValue (int a_bin)
 
void SetKind (uint8_t a_value)
 Set the kind of event. 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 iEventCT
 iEventCT ()
 iEventCT constructor. Initialize the member variables to their default values. More...
 
virtual ~iEventCT ()
 iEventCT destructor. More...
 
FLTNB GetBlankValue ()
 
FLTNB GetEventScatRate ()
 
void SetBlankValue (FLTNBDATA a_value)
 Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the blank value. 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...
 

Private Attributes

uint8_t m_kind
 

Additional Inherited Members

- Protected Attributes inherited from iEventCT
FLTNB m_eventScatRate
 
FLTNB m_eventBlankValue
 
- 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 iEventCT. Class for CT list-mode events.

It manages data and functions specific to list mode CT.

Definition at line 41 of file iEventListCT.hh.

Constructor & Destructor Documentation

iEventListCT::iEventListCT ( )

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

Definition at line 41 of file iEventListCT.cc.

iEventListCT::~iEventListCT ( )

iEventListCT destructor.

Definition at line 55 of file iEventListCT.cc.

Member Function Documentation

int iEventListCT::AllocateSpecificData ( )
inlinevirtual

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

Returns
0 is success, positive value otherwise

Implements iEventCT.

Definition at line 64 of file iEventListCT.hh.

void iEventListCT::Describe ( )
virtual

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

Reimplemented from iEventCT.

Definition at line 74 of file iEventListCT.cc.

FLTNB iEventListCT::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 iEventCT.

Definition at line 85 of file iEventListCT.hh.

uint8_t iEventListCT::GetKind ( )
inline
Returns
the kind of coincidence

Definition at line 79 of file iEventListCT.hh.

Here is the caller graph for this function:

INTNB iEventListCT::GetNbValueBins ( )
inlinevirtual

Get the number of event value bins.

Returns
the number of value bins

Implements iEventCT.

Definition at line 106 of file iEventListCT.hh.

void iEventListCT::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 iEventCT.

Definition at line 62 of file iEventListCT.cc.

Here is the call graph for this function:

void iEventListCT::SetKind ( uint8_t  a_value)
inline

Set the kind of event.

Parameters
a_value

Definition at line 92 of file iEventListCT.hh.

Member Data Documentation

uint8_t iEventListCT::m_kind
private

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

Definition at line 116 of file iEventListCT.hh.


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