iEventNorm Class Reference

Inherit from vEvent. Used for normalization events for sensitivity computation. More...

#include <iEventNorm.hh>

Inheritance diagram for iEventNorm:

Collaboration diagram for iEventNorm:

Public Member Functions
	iEventNorm ()
	iEventNorm constructor. Initialize the member variables to their default values. More...
	~iEventNorm ()
	iEventNorm destructor More...
int	AllocateSpecificData ()
	Inherited and pure virtual from vEvent. More...
void	Describe ()
	This function can be used to get a description of the event printed out. More...
void	SetNormalizationFactor (FLTNBDATA a_value)
	Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the normalization term. More...
void	SetAttenuationCorrectionFactor (FLTNBDATA a_value)
	Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the attenuation correction factor. More...
FLTNB	GetMultiplicativeCorrections ()
FLTNB	GetNormalizationFactor ()
FLTNB	GetAttenuationCorrectionFactor ()
FLTNB	GetEventValue (int a_bin)
	Not used, so throw an error and Exit. More...
FLTNB	GetAdditiveCorrections (int a_bin)
	Not used, so throw an error and Exit. More...
void	SetEventValue (int a_bin, FLTNBDATA a_value)
	Not used, so throw an error and Exit. More...
INTNB	GetNbValueBins ()
	Not used, so throw an error and Exit. More...
void	MultiplyAdditiveCorrections (FLTNB a_factor)
	Not used, so throw an error and Exit. 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...

Protected Attributes
FLTNB	m_normalizationFactor
FLTNB	m_attenuationCorrectionFactor
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 vEvent. Used for normalization events for sensitivity computation.

This class is designed to represent a normalization event. It is used for sensitivity computation.
A normalization datafile will be interpreted as a collection of iEventNorm events where each event
contains a list of considered LORs with associated normalization factors.

Definition at line 43 of file iEventNorm.hh.

Constructor & Destructor Documentation

iEventNorm::iEventNorm

(

)

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

Definition at line 41 of file iEventNorm.cc.

iEventNorm::~iEventNorm

(

)

iEventNorm destructor

Definition at line 53 of file iEventNorm.cc.

Member Function Documentation

int iEventNorm::AllocateSpecificData ( )

inlinevirtual

Inherited and pure virtual from vEvent.

Just do nothing here

Returns

0 is success, positive value otherwise

Implements vEvent.

Definition at line 67 of file iEventNorm.hh.

void iEventNorm::Describe ( )

virtual

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

Implements vEvent.

Definition at line 60 of file iEventNorm.cc.

FLTNB iEventNorm::GetAdditiveCorrections ( int  a_bin )

virtual

Not used, so throw an error and Exit.

Parameters

a	bin (0 if noTOF)

Returns

-1., but crash before

Implements vEvent.

Definition at line 91 of file iEventNorm.cc.

Here is the call graph for this function:

FLTNB iEventNorm::GetAttenuationCorrectionFactor ( )

inline

Returns

The attenuation correction factor

Definition at line 107 of file iEventNorm.hh.

FLTNB iEventNorm::GetEventValue ( int  a_bin )

virtual

Not used, so throw an error and Exit.

Parameters

a	bin (0 if noTOF)

Returns

-1., but crash before

Implements vEvent.

Definition at line 76 of file iEventNorm.cc.

Here is the call graph for this function:

FLTNB iEventNorm::GetMultiplicativeCorrections ( )

inlinevirtual

Returns

The normalization factor times the attenuation correction factor

Implements vEvent.

Definition at line 95 of file iEventNorm.hh.

INTNB iEventNorm::GetNbValueBins ( )

virtual

Not used, so throw an error and Exit.

Returns

-1., but crash before

Implements vEvent.

Definition at line 120 of file iEventNorm.cc.

Here is the call graph for this function:

FLTNB iEventNorm::GetNormalizationFactor ( )

inline

Returns

The normalization factor

Definition at line 101 of file iEventNorm.hh.

void iEventNorm::MultiplyAdditiveCorrections ( FLTNB  a_factor )

virtual

Not used, so throw an error and Exit.

Parameters

FLTNB

a_factor

Implements vEvent.

Definition at line 135 of file iEventNorm.cc.

Here is the call graph for this function:

void iEventNorm::SetAttenuationCorrectionFactor ( FLTNBDATA  a_value )

inline

Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the attenuation correction factor.

Parameters

an	attenuation correction factor

Definition at line 89 of file iEventNorm.hh.

Here is the caller graph for this function:

void iEventNorm::SetEventValue ( int  a_bin, FLTNBDATA  a_value  )

virtual

Not used, so throw an error and Exit.

Parameters

a	bin (ignored)
a_value

Implements vEvent.

Definition at line 106 of file iEventNorm.cc.

Here is the call graph for this function:

void iEventNorm::SetNormalizationFactor ( FLTNBDATA  a_value )

inline

Cast the FLTNBDATA value passed as parameter in FLTNB, and set it to the normalization term.

Parameters

a	normalization term

Definition at line 82 of file iEventNorm.hh.

Member Data Documentation

FLTNB iEventNorm::m_attenuationCorrectionFactor

protected

Attenuation correction factor. Default value = 1.0

Definition at line 155 of file iEventNorm.hh.

FLTNB iEventNorm::m_normalizationFactor

protected

Normalization correction term. Default value = 1.0

Definition at line 154 of file iEventNorm.hh.

---

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

• iEventNorm.hh
• iEventNorm.cc