Energy-Sum RoI class for analysis. More...

#include <EnergySum_ROI.h>

Collaboration diagram for EnergySum_ROI:

Public Types
typedef std::vector< std::string >	thresholds_type
	Type storing the names of the passed thresholds. More...

Public Member Functions
	EnergySum_ROI (uint32_t roiWord0, uint32_t roiWord1, uint32_t roiWord2, float energyX, float energyY, float energyT, uint32_t thrPatSummET, uint32_t thrPatMissET, uint32_t thrPatMETSig, unsigned int overflows)
	Constructor used when creating the object from RoIBResult data. More...

	EnergySum_ROI ()
	Default constructor (for persistency purposes) More...

virtual	~EnergySum_ROI ()
	Destructor. More...

uint32_t	getROIWord0 () const
	Return the first RoI word produced by the L1Calo hardware. More...

uint32_t	getROIWord1 () const
	Return the second RoI word produced by the L1Calo hardware. More...

uint32_t	getROIWord2 () const
	Return the third RoI word produced by the L1Calo hardware. More...

float	getEnergyX () const
	Return the total energy deposited in the X direction. More...

float	getEnergyY () const
	Return the total energy deposited in the Y direction. More...

float	getEnergyT () const
	Return the deposited total transverse energy. More...

float	getExMiss () const
	Return the missing energy in the X direction. More...

float	getEyMiss () const
	Return the missing energy in the Y direction. More...

bool	getOverflowX () const
	Return the overflow flag for the E_X calculation. More...

bool	getOverflowY () const
	Return the overflow flag for the E_Y calculation. More...

bool	getOverflowT () const
	Return the overflow flag for the E_T calculation. More...

unsigned int	getOverflows () const
	Return the overflow bit-pattern. More...

uint32_t	getThrPatSummET () const
	Return the bit-pattern describing the passed sum-E_T thresholds. More...

uint32_t	getThrPatMissET () const
	Return the bit-pattern describing the passed missing-E_T thresholds. More...

uint32_t	getThrPatMETSig () const
	Return the bit-pattern describing the passed missing-E_T significance thresholds. More...

const thresholds_type &	getThresholds () const
	Return the names of the passed threshodlds. More...

void	addThreshold (thresholds_type::value_type thr)
	Add the name of a threshold that this RoI passed. More...

Private Attributes
uint32_t	m_roiWord0
	First 32bit encoded ROI word. More...

uint32_t	m_roiWord1
	Second 32bit encoded ROI word. More...

uint32_t	m_roiWord2
	Third 32bit encoded ROI word. More...

uint32_t	m_thrPatSummET
	threshold bit pattern for Summed E_T More...

uint32_t	m_thrPatMissET
	threshold bit pattern for Missing E_T More...

uint32_t	m_thrPatMETSig
	threshold bit pattern for Missing E_T Significance More...

thresholds_type	m_thresholds
	Names of the passed thresholds. More...

float	m_energyX
	Total energy deposited in the X direction. More...

float	m_energyY
	Total energy deposited in the Y direction. More...

float	m_energyT
	Total deposited transverse energy. More...

unsigned int	m_overflows
	Overflow flags: bit 0 = Ex, bit 1 = Ey, bit 2 = ETsum. More...

Detailed Description

Energy-Sum RoI class for analysis.

   Class giving information about the energy sum and missing Et at LVL1.

Author: Tadashi Maeno, Alan Watson, Attila Krasznahorkay

Version

Revision: 1.5

Date

Date: 2008-05-08 15:00:11

Definition at line 25 of file EnergySum_ROI.h.

Member Typedef Documentation

◆ thresholds_type

typedef std::vector< std::string > EnergySum_ROI::thresholds_type

Type storing the names of the passed thresholds.

Definition at line 44 of file EnergySum_ROI.h.

Constructor & Destructor Documentation

◆ EnergySum_ROI() [1/2]

EnergySum_ROI::EnergySum_ROI	(	uint32_t	roiWord0,
		uint32_t	roiWord1,
		uint32_t	roiWord2,
		float	energyX,
		float	energyY,
		float	energyT,
		uint32_t	thrPatSummET,
		uint32_t	thrPatMissET,
		uint32_t	thrPatMETSig,
		unsigned int	overflows
	)

inline

Constructor used when creating the object from RoIBResult data.

Definition at line 29 of file EnergySum_ROI.h.

       : m_roiWord0( roiWord0 ), m_roiWord1( roiWord1 ), m_roiWord2( roiWord2 ),
         m_thrPatSummET( thrPatSummET ), m_thrPatMissET( thrPatMissET ), m_thrPatMETSig( thrPatMETSig ), m_thresholds( 0 ),
         m_energyX( energyX ), m_energyY( energyY ), m_energyT( energyT ), 
         m_overflows( overflows ) {}

◆ EnergySum_ROI() [2/2]

EnergySum_ROI::EnergySum_ROI ( )

inline

Default constructor (for persistency purposes)

Definition at line 37 of file EnergySum_ROI.h.

38 : m_roiWord0( 0 ), m_roiWord1( 0 ), m_roiWord2( 0 ), m_thrPatSummET( 0 ), m_thrPatMissET( 0 ), m_thrPatMETSig( 0 ),

39 m_thresholds( 0 ), m_energyX( 0. ), m_energyY( 0. ), m_energyT( 0. ), m_overflows( 0 ) {}

◆ ~EnergySum_ROI()

virtual EnergySum_ROI::~EnergySum_ROI ( )

inlinevirtual

Destructor.

Definition at line 41 of file EnergySum_ROI.h.

41 {}

Member Function Documentation

◆ addThreshold()

void EnergySum_ROI::addThreshold ( thresholds_type::value_type thr )

inline

Add the name of a threshold that this RoI passed.

Definition at line 83 of file EnergySum_ROI.h.

83 { m_thresholds.push_back( thr ); }

◆ getEnergyT()

float EnergySum_ROI::getEnergyT ( ) const

inline

Return the deposited total transverse energy.

Definition at line 58 of file EnergySum_ROI.h.

58 { return m_energyT; }

◆ getEnergyX()

float EnergySum_ROI::getEnergyX ( ) const

inline

Return the total energy deposited in the X direction.

Definition at line 54 of file EnergySum_ROI.h.

54 { return m_energyX; }

◆ getEnergyY()

float EnergySum_ROI::getEnergyY ( ) const

inline

Return the total energy deposited in the Y direction.

Definition at line 56 of file EnergySum_ROI.h.

56 { return m_energyY; }

◆ getExMiss()

float EnergySum_ROI::getExMiss ( ) const

inline

Return the missing energy in the X direction.

Definition at line 60 of file EnergySum_ROI.h.

60 { return -m_energyX; }

◆ getEyMiss()

float EnergySum_ROI::getEyMiss ( ) const

inline

Return the missing energy in the Y direction.

Definition at line 62 of file EnergySum_ROI.h.

62 { return -m_energyY; }

◆ getOverflows()

unsigned int EnergySum_ROI::getOverflows ( ) const

inline

Return the overflow bit-pattern.

Definition at line 70 of file EnergySum_ROI.h.

70 { return m_overflows; }

◆ getOverflowT()

bool EnergySum_ROI::getOverflowT ( ) const

inline

Return the overflow flag for the E_T calculation.

Definition at line 68 of file EnergySum_ROI.h.

68 { return ( ( m_overflows >> 2 ) & 0x1 ); }

◆ getOverflowX()

bool EnergySum_ROI::getOverflowX ( ) const

inline

Return the overflow flag for the E_X calculation.

Definition at line 64 of file EnergySum_ROI.h.

64 { return ( m_overflows & 0x1 ); }

◆ getOverflowY()

bool EnergySum_ROI::getOverflowY ( ) const

inline

Return the overflow flag for the E_Y calculation.

Definition at line 66 of file EnergySum_ROI.h.

66 { return ( ( m_overflows >> 1 ) & 0x1 ); }

◆ getROIWord0()

uint32_t EnergySum_ROI::getROIWord0 ( ) const

inline

Return the first RoI word produced by the L1Calo hardware.

Definition at line 47 of file EnergySum_ROI.h.

47 { return m_roiWord0; }

◆ getROIWord1()

uint32_t EnergySum_ROI::getROIWord1 ( ) const

inline

Return the second RoI word produced by the L1Calo hardware.

Definition at line 49 of file EnergySum_ROI.h.

49 { return m_roiWord1; }

◆ getROIWord2()

uint32_t EnergySum_ROI::getROIWord2 ( ) const

inline

Return the third RoI word produced by the L1Calo hardware.

Definition at line 51 of file EnergySum_ROI.h.

51 { return m_roiWord2; }

◆ getThresholds()

const thresholds_type& EnergySum_ROI::getThresholds ( ) const

inline

Return the names of the passed threshodlds.

Definition at line 80 of file EnergySum_ROI.h.

80 { return m_thresholds; }

◆ getThrPatMETSig()

uint32_t EnergySum_ROI::getThrPatMETSig ( ) const

inline

Return the bit-pattern describing the passed missing-E_T significance thresholds.

Definition at line 77 of file EnergySum_ROI.h.

77 { return m_thrPatMETSig; }

◆ getThrPatMissET()

uint32_t EnergySum_ROI::getThrPatMissET ( ) const

inline

Return the bit-pattern describing the passed missing-E_T thresholds.

Definition at line 75 of file EnergySum_ROI.h.

75 { return m_thrPatMissET; }

◆ getThrPatSummET()

uint32_t EnergySum_ROI::getThrPatSummET ( ) const

inline

Return the bit-pattern describing the passed sum-E_T thresholds.

Definition at line 73 of file EnergySum_ROI.h.

73 { return m_thrPatSummET; }

Member Data Documentation

◆ m_energyT

float EnergySum_ROI::m_energyT

private

Total deposited transverse energy.

Definition at line 98 of file EnergySum_ROI.h.

◆ m_energyX

float EnergySum_ROI::m_energyX

private

Total energy deposited in the X direction.

Definition at line 96 of file EnergySum_ROI.h.

◆ m_energyY

float EnergySum_ROI::m_energyY

private

Total energy deposited in the Y direction.

Definition at line 97 of file EnergySum_ROI.h.

◆ m_overflows

unsigned int EnergySum_ROI::m_overflows

private

Overflow flags: bit 0 = Ex, bit 1 = Ey, bit 2 = ETsum.

Definition at line 100 of file EnergySum_ROI.h.

◆ m_roiWord0

uint32_t EnergySum_ROI::m_roiWord0

private

First 32bit encoded ROI word.

Definition at line 86 of file EnergySum_ROI.h.

◆ m_roiWord1

uint32_t EnergySum_ROI::m_roiWord1

private

Second 32bit encoded ROI word.

Definition at line 87 of file EnergySum_ROI.h.

◆ m_roiWord2

uint32_t EnergySum_ROI::m_roiWord2

private

Third 32bit encoded ROI word.

Definition at line 88 of file EnergySum_ROI.h.

◆ m_thresholds

thresholds_type EnergySum_ROI::m_thresholds

private

Names of the passed thresholds.

Definition at line 94 of file EnergySum_ROI.h.

◆ m_thrPatMETSig

uint32_t EnergySum_ROI::m_thrPatMETSig

private

threshold bit pattern for Missing E_T Significance

Definition at line 92 of file EnergySum_ROI.h.

◆ m_thrPatMissET

uint32_t EnergySum_ROI::m_thrPatMissET

private

threshold bit pattern for Missing E_T

Definition at line 91 of file EnergySum_ROI.h.

◆ m_thrPatSummET

uint32_t EnergySum_ROI::m_thrPatSummET

private

threshold bit pattern for Summed E_T

Definition at line 90 of file EnergySum_ROI.h.

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

EnergySum_ROI.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ thresholds_type

Constructor & Destructor Documentation

◆ EnergySum_ROI() [1/2]

◆ EnergySum_ROI() [2/2]

◆ ~EnergySum_ROI()

Member Function Documentation

◆ addThreshold()

◆ getEnergyT()

◆ getEnergyX()

◆ getEnergyY()

◆ getExMiss()

◆ getEyMiss()

◆ getOverflows()

◆ getOverflowT()

◆ getOverflowX()

◆ getOverflowY()

◆ getROIWord0()

◆ getROIWord1()

◆ getROIWord2()

◆ getThresholds()

◆ getThrPatMETSig()

◆ getThrPatMissET()

◆ getThrPatSummET()

Member Data Documentation

◆ m_energyT

◆ m_energyX

◆ m_energyY

◆ m_overflows

◆ m_roiWord0

◆ m_roiWord1

◆ m_roiWord2

◆ m_thresholds

◆ m_thrPatMETSig

◆ m_thrPatMissET

◆ m_thrPatSummET