CASToR  3.2
Tomographic Reconstruction (PET/SPECT/CT)
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)
 
void SetEventValue (int a_bin, FLTNBDATA a_value)
 
INTNB GetNbValueBins ()
 Get the number of event value bins. More...
 
 iEventListCT ()
 iEventListCT constructor. Initialize the member variables to their default values. More...
 
 ~iEventListCT ()
 iEventListCT destructor. More...
 
int AllocateSpecificData ()
 Pure virtual function implemented in the child classes, dedicated to the allocation of specific data in the child classes. 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)
 
void SetEventValue (int a_bin, FLTNBDATA a_value)
 
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)
 
void SetScatterRate (FLTNBDATA a_value)
 
FLTNB GetAdditiveCorrections (int a_bin)
 
FLTNB GetMultiplicativeCorrections ()
 
void MultiplyAdditiveCorrections (FLTNB a_factor)
 
 iEventCT ()
 iEventCT constructor. Initialize the member variables to their default values. More...
 
virtual ~iEventCT ()
 iEventCT destructor. More...
 
FLTNB GetBlankValue ()
 This is a pure virtual function implemented in the child classes. More...
 
FLTNB GetEventScatRate ()
 
void SetBlankValue (FLTNBDATA a_value)
 
void SetScatterRate (FLTNBDATA a_value)
 
FLTNB GetAdditiveCorrections (int a_bin)
 
FLTNB GetMultiplicativeCorrections ()
 This is a pure virtual function implemented in the child classes. More...
 
void MultiplyAdditiveCorrections (FLTNB a_factor)
 
- 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)
 
void SetNbLines (uint16_t a_value)
 
void SetID1 (int a_line, uint32_t a_value)
 
void SetID2 (int a_line, uint32_t a_value)
 
void SetVerbose (int a_verbose)
 
 vEvent ()
 vEvent constructor. Initialize the member variables to their default values. More...
 
virtual ~vEvent ()
 vEvent destructor More...
 
int AllocateID ()
 
int AllocateCustomINTData ()
 Instantiate the m_nbCustomINTData array. More...
 
int AllocateCustomFLTData ()
 Instantiate the m_nbCustomFLTData array. 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)
 
void SetNbLines (uint16_t a_value)
 
void SetID1 (int a_line, uint32_t a_value)
 
void SetID2 (int a_line, uint32_t a_value)
 
void SetVerbose (int a_verbose)
 
void SetEventIndex (int a_eventIndex)
 Set current index associated to the event. More...
 
int64_t GetEventIndex ()
 Get current index associated to the event. More...
 
virtual int GetNbCustomFLTData ()
 
virtual int GetNbCustomINTData ()
 
virtual void SetNbCustomFLTData (int a_value)
 initialize the number of custom INT data with a_value More...
 
virtual void SetNbCustomINTData (int a_value)
 initialize the number of custom INT data with a_value More...
 
virtual EVTFLTDATA * GetCustomFLTData ()
 
virtual EVTINTDATA * GetCustomINTData ()
 
virtual EVTFLTDATA GetCustomFLTData (int a_idx)
 
virtual EVTINTDATA GetCustomINTData (int a_idx)
 
virtual int SetCustomFLTData (int a_idx, EVTFLTDATA a_value)
 
virtual int SetCustomINTData (int a_idx, EVTINTDATA a_value)
 

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
 
int64_t m_eventIndex
 
EVTFLTDATA * mp_customFLTData
 
EVTINTDATA * mp_customINTData
 
int m_nbCustomFLTData
 
int m_nbCustomINTData
 

Detailed Description

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

It manages data and functions specific to list mode CT.

Definition at line 18 of file code/include/datafile/iEventListCT.hh.

Constructor & Destructor Documentation

◆ iEventListCT() [1/2]

iEventListCT::iEventListCT ( )

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

Definition at line 18 of file code/src/datafile/iEventListCT.cc.

◆ ~iEventListCT() [1/2]

iEventListCT::~iEventListCT ( )

iEventListCT destructor.

Definition at line 32 of file code/src/datafile/iEventListCT.cc.

◆ iEventListCT() [2/2]

iEventListCT::iEventListCT ( )

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

◆ ~iEventListCT() [2/2]

iEventListCT::~iEventListCT ( )

iEventListCT destructor.

Member Function Documentation

◆ AllocateSpecificData() [1/2]

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 41 of file code/include/datafile/iEventListCT.hh.

Here is the call graph for this function:

◆ AllocateSpecificData() [2/2]

int iEventListCT::AllocateSpecificData ( )
inlinevirtual

Pure virtual function implemented in the child classes, dedicated to the allocation of specific data in the child classes.

Returns
0 is success, positive value otherwise

Implements iEventCT.

Definition at line 41 of file include/datafile/iEventListCT.hh.

Here is the call graph for this function:

◆ Describe() [1/2]

void iEventListCT::Describe ( )
virtual

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

Reimplemented from iEventCT.

Definition at line 51 of file code/src/datafile/iEventListCT.cc.

Here is the caller graph for this function:

◆ Describe() [2/2]

void iEventListCT::Describe ( )
virtual

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

Reimplemented from iEventCT.

◆ GetEventValue() [1/2]

FLTNB iEventListCT::GetEventValue ( int  a_bin)
inlinevirtual

Implements iEventCT.

Definition at line 62 of file code/include/datafile/iEventListCT.hh.

◆ GetEventValue() [2/2]

FLTNB iEventListCT::GetEventValue ( int  a_bin)
inlinevirtual

Implements iEventCT.

Definition at line 62 of file include/datafile/iEventListCT.hh.

◆ GetKind() [1/2]

uint8_t iEventListCT::GetKind ( )
inline

Definition at line 56 of file include/datafile/iEventListCT.hh.

◆ GetKind() [2/2]

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

Definition at line 56 of file code/include/datafile/iEventListCT.hh.

Here is the caller graph for this function:

◆ GetNbValueBins() [1/2]

INTNB iEventListCT::GetNbValueBins ( )
inlinevirtual

Get the number of event value bins.

Returns
the number of value bins

Implements iEventCT.

Definition at line 83 of file include/datafile/iEventListCT.hh.

◆ GetNbValueBins() [2/2]

INTNB iEventListCT::GetNbValueBins ( )
inlinevirtual

Get the number of event value bins.

Returns
the number of value bins

Implements iEventCT.

Definition at line 83 of file code/include/datafile/iEventListCT.hh.

◆ SetEventValue() [1/2]

void iEventListCT::SetEventValue ( int  a_bin,
FLTNBDATA  a_value 
)
virtual

Implements iEventCT.

◆ SetEventValue() [2/2]

void iEventListCT::SetEventValue ( int  a_bin,
FLTNBDATA  a_value 
)
virtual

Implements iEventCT.

Definition at line 39 of file code/src/datafile/iEventListCT.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetKind() [1/2]

void iEventListCT::SetKind ( uint8_t  a_value)
inline

Definition at line 69 of file include/datafile/iEventListCT.hh.

Here is the call graph for this function:

◆ SetKind() [2/2]

void iEventListCT::SetKind ( uint8_t  a_value)
inline

Definition at line 69 of file code/include/datafile/iEventListCT.hh.

Here is the call graph for this function:

Member Data Documentation

◆ m_kind

uint8_t iEventListCT::m_kind
private

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

Definition at line 93 of file code/include/datafile/iEventListCT.hh.

The documentation for this class was generated from the following files:
Generated on Tue Oct 22 2024 21:49:46 for CASToR by   doxygen 1.8.13