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)
FLTNB	GetAdditiveCorrections (int a_bin)
void	SetEventValue (int a_bin, FLTNBDATA a_value)
INTNB	GetNbValueBins ()
	Not used, so throw an error and Exit. More...
void	MultiplyAdditiveCorrections (FLTNB a_factor)
	iEventNorm ()
	iEventNorm constructor. Initialize the member variables to their default values. More...
	~iEventNorm ()
	iEventNorm 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...
void	SetNormalizationFactor (FLTNBDATA a_value)
void	SetAttenuationCorrectionFactor (FLTNBDATA a_value)
FLTNB	GetMultiplicativeCorrections ()
	This is a pure virtual function implemented in the child classes. More...
FLTNB	GetNormalizationFactor ()
FLTNB	GetAttenuationCorrectionFactor ()
FLTNB	GetEventValue (int a_bin)
FLTNB	GetAdditiveCorrections (int a_bin)
void	SetEventValue (int a_bin, FLTNBDATA a_value)
INTNB	GetNbValueBins ()
	Get the number of event value bins. 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)
virtual FLTNB	GetBlankValue ()
	This is a pure virtual function implemented in the child classes. More...
	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)
virtual FLTNB	GetBlankValue ()
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)

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

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

Constructor & Destructor Documentation

iEventNorm() [1/2]

iEventNorm::iEventNorm

(

)

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

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

~iEventNorm() [1/2]

iEventNorm::~iEventNorm

(

)

iEventNorm destructor

Definition at line 30 of file code/src/datafile/iEventNorm.cc.

iEventNorm() [2/2]

iEventNorm::iEventNorm

(

)

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

~iEventNorm() [2/2]

iEventNorm::~iEventNorm

(

)

iEventNorm destructor

Member Function Documentation

AllocateSpecificData() [1/2]

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

Here is the call graph for this function:

AllocateSpecificData() [2/2]

int iEventNorm::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 vEvent.

Definition at line 44 of file include/datafile/iEventNorm.hh.

Here is the call graph for this function:

Describe() [1/2]

void iEventNorm::Describe ( )

virtual

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

Implements vEvent.

Definition at line 37 of file code/src/datafile/iEventNorm.cc.

Here is the caller graph for this function:

Describe() [2/2]

void iEventNorm::Describe ( )

virtual

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

Implements vEvent.

GetAdditiveCorrections() [1/2]

FLTNB iEventNorm::GetAdditiveCorrections ( int  a_bin )

virtual

Implements vEvent.

Definition at line 68 of file code/src/datafile/iEventNorm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

GetAdditiveCorrections() [2/2]

FLTNB iEventNorm::GetAdditiveCorrections ( int  a_bin )

virtual

Implements vEvent.

GetAttenuationCorrectionFactor() [1/2]

FLTNB iEventNorm::GetAttenuationCorrectionFactor ( )

inline

Definition at line 84 of file include/datafile/iEventNorm.hh.

Here is the call graph for this function:

GetAttenuationCorrectionFactor() [2/2]

FLTNB iEventNorm::GetAttenuationCorrectionFactor ( )

inline

Returns

The attenuation correction factor

Definition at line 84 of file code/include/datafile/iEventNorm.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

GetEventValue() [1/2]

FLTNB iEventNorm::GetEventValue ( int  a_bin )

virtual

Implements vEvent.

Definition at line 53 of file code/src/datafile/iEventNorm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

GetEventValue() [2/2]

FLTNB iEventNorm::GetEventValue ( int  a_bin )

virtual

Implements vEvent.

GetMultiplicativeCorrections() [1/2]

FLTNB iEventNorm::GetMultiplicativeCorrections ( )

inlinevirtual

This is a pure virtual function implemented in the child classes.

Returns

the product of the multiplicative corrections terms for this event

Implements vEvent.

Definition at line 72 of file include/datafile/iEventNorm.hh.

GetMultiplicativeCorrections() [2/2]

FLTNB iEventNorm::GetMultiplicativeCorrections ( )

inlinevirtual

Returns

The normalization factor times the attenuation correction factor

Implements vEvent.

Definition at line 72 of file code/include/datafile/iEventNorm.hh.

GetNbValueBins() [1/2]

INTNB iEventNorm::GetNbValueBins ( )

virtual

Get the number of event value bins.

Returns

the number of value bins

Implements vEvent.

GetNbValueBins() [2/2]

INTNB iEventNorm::GetNbValueBins ( )

virtual

Not used, so throw an error and Exit.

Returns

-1., but crash before

Implements vEvent.

Definition at line 97 of file code/src/datafile/iEventNorm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

GetNormalizationFactor() [1/2]

FLTNB iEventNorm::GetNormalizationFactor ( )

inline

Definition at line 78 of file include/datafile/iEventNorm.hh.

GetNormalizationFactor() [2/2]

FLTNB iEventNorm::GetNormalizationFactor ( )

inline

Returns

The normalization factor

Definition at line 78 of file code/include/datafile/iEventNorm.hh.

Here is the caller graph for this function:

MultiplyAdditiveCorrections() [1/2]

void iEventNorm::MultiplyAdditiveCorrections ( FLTNB  a_factor )

virtual

Implements vEvent.

Definition at line 112 of file code/src/datafile/iEventNorm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

MultiplyAdditiveCorrections() [2/2]

void iEventNorm::MultiplyAdditiveCorrections ( FLTNB  a_factor )

virtual

Implements vEvent.

SetAttenuationCorrectionFactor() [1/2]

void iEventNorm::SetAttenuationCorrectionFactor ( FLTNBDATA  a_value )

inline

Definition at line 66 of file include/datafile/iEventNorm.hh.

SetAttenuationCorrectionFactor() [2/2]

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

Here is the caller graph for this function:

SetEventValue() [1/2]

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

virtual

Implements vEvent.

Definition at line 83 of file code/src/datafile/iEventNorm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

SetEventValue() [2/2]

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

virtual

Implements vEvent.

SetNormalizationFactor() [1/2]

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

Here is the caller graph for this function:

SetNormalizationFactor() [2/2]

void iEventNorm::SetNormalizationFactor ( FLTNBDATA  a_value )

inline

Definition at line 59 of file include/datafile/iEventNorm.hh.

Member Data Documentation

m_attenuationCorrectionFactor

FLTNB iEventNorm::m_attenuationCorrectionFactor

protected

Attenuation correction factor. Default value = 1.0

Definition at line 132 of file code/include/datafile/iEventNorm.hh.

m_normalizationFactor

FLTNB iEventNorm::m_normalizationFactor

protected

Normalization correction term. Default value = 1.0

Definition at line 131 of file code/include/datafile/iEventNorm.hh.

---

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

• code/include/datafile/iEventNorm.hh
• code/src/datafile/iEventNorm.cc