xAOD::EnergySumRoI_v1 Class Reference

Class describing a LVL1 energy-sum "RoI". More...

#include <EnergySumRoI_v1.h>

Inheritance diagram for xAOD::EnergySumRoI_v1:

Collaboration diagram for xAOD::EnergySumRoI_v1:

Public Member Functions
	EnergySumRoI_v1 ()
	Default constructor.
void	initialize (uint32_t roiword0, uint32_t roiword1, uint32_t roiword2, float energyX, float energyY, float energyT)
	Initialise the object with its most important properties.
RoI word accessor functions
uint32_t	roiWord0 () const
	The first RoI word produced by the L1Calo hardware.
void	setRoIWord0 (uint32_t value)
	Set the first "raw" RoI word describing the energy-sum RoI.
uint32_t	roiWord1 () const
	The second RoI word produced by the L1Calo hardware.
void	setRoIWord1 (uint32_t value)
	Set the second "raw" RoI word describing the energy-sum RoI.
uint32_t	roiWord2 () const
	The third RoI word produced by the L1Calo hardware.
void	setRoIWord2 (uint32_t value)
	Set the third "raw" RoI word describing the energy-sum RoI.
Helper functions accessing the threshold patterns
uint32_t	thrPatSumET () const
	The bit-pattern describing the passed sum-ET thresholds.
uint32_t	thrPatMET () const
	The bit-pattern describing the passed missing-ET thresholds.
uint32_t	thrPatMETSig () const
	The bit-pattern describing the passed missing-ET significance thresholds.
Helper functions accessing the overflow bits
bool	overflowX () const
	The overflow flag for the EX calculation.
bool	overflowY () const
	The overflow flag for the EY calculation.
bool	overflowT () const
	The overflow flag for the ET calculation.
Thresholds passed by the RoI
void	addThreshold (const std::string &name)
	Add a new threshold that was passed.
void	clearThresholds ()
	Remove all the passed thresholds.
const std::vector< std::string > &	thrNames () const
	The names of the thresholds passed.
Missing E<sub>T</sub> values
float	energyX () const
	The total energy deposited in the X direction.
void	setEnergyX (float value)
	Set the total energy deposited in the X direction.
float	exMiss () const
	The missing energy in the X direction.
float	energyY () const
	The total energy deposited in the Y direction.
void	setEnergyY (float value)
	Set the total energy deposited in the Y direction.
float	eyMiss () const
	The missing energy in the Y direction.
float	energyT () const
	The deposited total transverse energy.
void	setEnergyT (float value)
	Set the deposited total transverse energy.

Detailed Description

Class describing a LVL1 energy-sum "RoI".

This class describes the properties of the LVL1 energy-sum calculation in the xAOD format.

Author

Lukas Heinrich Lukas.nosp@m..Hei.nosp@m.nrich.nosp@m.@cer.nosp@m.n.ch

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Alan Watson Alan..nosp@m.Wats.nosp@m.on@ce.nosp@m.rn.c.nosp@m.h

Revision

631149

Date

2014-11-26 13:26:18 +0100 (Wed, 26 Nov 2014)

Definition at line 35 of file EnergySumRoI_v1.h.

Constructor & Destructor Documentation

EnergySumRoI_v1()

xAOD::EnergySumRoI_v1::EnergySumRoI_v1

(

)

Default constructor.

Definition at line 14 of file EnergySumRoI_v1.cxx.

      : SG::AuxElement() {
 
   }

Member Function Documentation

addThreshold()

void xAOD::EnergySumRoI_v1::addThreshold

(

const std::string &

name

)

Add a new threshold that was passed.

clearThresholds()

void xAOD::EnergySumRoI_v1::clearThresholds

(

)

Remove all the passed thresholds.

Definition at line 118 of file EnergySumRoI_v1.cxx.

                                         {
 
      names( *this ).clear();
      return;
   }

energyT()

float xAOD::EnergySumRoI_v1::energyT

(

)

const

The deposited total transverse energy.

energyX()

float xAOD::EnergySumRoI_v1::energyX

(

)

const

The total energy deposited in the X direction.

energyY()

float xAOD::EnergySumRoI_v1::energyY

(

)

const

The total energy deposited in the Y direction.

exMiss()

float xAOD::EnergySumRoI_v1::exMiss ( ) const

inline

The missing energy in the X direction.

Definition at line 111 of file EnergySumRoI_v1.h.

{ return -energyX(); }

eyMiss()

float xAOD::EnergySumRoI_v1::eyMiss ( ) const

inline

The missing energy in the Y direction.

Definition at line 118 of file EnergySumRoI_v1.h.

{ return -energyY(); }

initialize()

void xAOD::EnergySumRoI_v1::initialize	(	uint32_t	roiword0,
		uint32_t	roiword1,
		uint32_t	roiword2,
		float	energyX,
		float	energyY,
		float	energyT )

Initialise the object with its most important properties.

Parameters

roiword0	The first RoI word produced by the L1Calo hardware
roiword1	The second RoI word produced by the L1Calo hardware
roiword2	The third RoI word produced by the L1Calo hardware
energyX	The total energy deposited in the X direction
energyY	The total energy deposited in the Y direction
energyT	The total transverse energy deposited

Definition at line 26 of file EnergySumRoI_v1.cxx.

                                                     {
 
      setRoIWord0( roiword0 );
      setRoIWord1( roiword1 );
      setRoIWord2( roiword2 );
 
      setEnergyX( energyX );
      setEnergyY( energyY );
      setEnergyT( energyT );
 
      return;
   }

overflowT()

bool xAOD::EnergySumRoI_v1::overflowT

(

)

const

The overflow flag for the E_T calculation.

overflowX()

bool xAOD::EnergySumRoI_v1::overflowX

(

)

const

The overflow flag for the E_X calculation.

overflowY()

bool xAOD::EnergySumRoI_v1::overflowY

(

)

const

The overflow flag for the E_Y calculation.

roiWord0()

uint32_t xAOD::EnergySumRoI_v1::roiWord0

(

)

const

The first RoI word produced by the L1Calo hardware.

roiWord1()

uint32_t xAOD::EnergySumRoI_v1::roiWord1

(

)

const

The second RoI word produced by the L1Calo hardware.

roiWord2()

uint32_t xAOD::EnergySumRoI_v1::roiWord2

(

)

const

The third RoI word produced by the L1Calo hardware.

setEnergyT()

void xAOD::EnergySumRoI_v1::setEnergyT

(

float

value

)

Set the deposited total transverse energy.

setEnergyX()

void xAOD::EnergySumRoI_v1::setEnergyX

(

float

value

)

Set the total energy deposited in the X direction.

setEnergyY()

void xAOD::EnergySumRoI_v1::setEnergyY

(

float

value

)

Set the total energy deposited in the Y direction.

setRoIWord0()

void xAOD::EnergySumRoI_v1::setRoIWord0

(

uint32_t

value

)

Set the first "raw" RoI word describing the energy-sum RoI.

setRoIWord1()

void xAOD::EnergySumRoI_v1::setRoIWord1

(

uint32_t

value

)

Set the second "raw" RoI word describing the energy-sum RoI.

setRoIWord2()

void xAOD::EnergySumRoI_v1::setRoIWord2

(

uint32_t

value

)

Set the third "raw" RoI word describing the energy-sum RoI.

thrNames()

const std::vector< std::string > & xAOD::EnergySumRoI_v1::thrNames

(

)

const

The names of the thresholds passed.

Definition at line 124 of file EnergySumRoI_v1.cxx.

                                                                 {
 
      return names( *this );
   }

thrPatMET()

uint32_t xAOD::EnergySumRoI_v1::thrPatMET

(

)

const

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

thrPatMETSig()

uint32_t xAOD::EnergySumRoI_v1::thrPatMETSig

(

)

const

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

thrPatSumET()

uint32_t xAOD::EnergySumRoI_v1::thrPatSumET

(

)

const

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

---

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

• EnergySumRoI_v1.h
• EnergySumRoI_v1.cxx