xAOD::EnergySumRoI_v2 Class Reference

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

#include <EnergySumRoI_v2.h>

Inheritance diagram for xAOD::EnergySumRoI_v2:

Collaboration diagram for xAOD::EnergySumRoI_v2:

Public Member Functions
	EnergySumRoI_v2 ()
	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 from a single RoI.
RoI word accessor functions
void	setRoIWord (uint32_t value)
	Generic RoI word adding: the function will identify which word it is.
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.
uint32_t	roiWord3 () const
	The fourth RoI word produced by the L1Calo hardware.
void	setRoIWord3 (uint32_t value)
	Set the first "raw" RoI word describing the energy-sum RoI.
uint32_t	roiWord4 () const
	The fifth RoI word produced by the L1Calo hardware.
void	setRoIWord4 (uint32_t value)
	Set the second "raw" RoI word describing the energy-sum RoI.
uint32_t	roiWord5 () const
	The sixth RoI word produced by the L1Calo hardware.
void	setRoIWord5 (uint32_t value)
	Set the third "raw" RoI word describing the energy-sum RoI.
Helper functions accessing the threshold patterns
uint32_t	thrPatSumET (bool restricted=false) const
	The bit-pattern describing the passed sum-ET thresholds.
uint32_t	thrPatMET (bool restricted=false) 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 (bool restricted=false) const
	The overflow flag for the EX calculation.
bool	overflowY (bool restricted=false) const
	The overflow flag for the EY calculation.
bool	overflowT (bool restricted=false) const
	The overflow flag for the ET calculation.
Thresholds passed by the event
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.
float	energyXRestricted () const
void	setEnergyX (float value)
	Set the total energy deposited in the X direction.
void	setEnergyXRestricted (float value)
float	exMiss () const
	The missing energy in the X direction.
float	exMissRestricted () const
float	energyY () const
	The total energy deposited in the Y direction.
float	energyYRestricted () const
void	setEnergyY (float value)
	Set the total energy deposited in the Y direction.
void	setEnergyYRestricted (float value)
float	eyMiss () const
	The missing energy in the Y direction.
float	eyMissRestricted () const
float	energyT () const
	The deposited total transverse energy.
float	energyTRestricted () const
void	setEnergyT (float value)
	Set the deposited total transverse energy.
void	setEnergyTRestricted (float value)

Static Private Attributes
static const unsigned int	s_Run2TruncRoIBit = 0x4000000
	The basic setters and getters for the xAOD class.
static const unsigned int	s_RoIType = 0xf0000000
static const unsigned int	s_Word0 = 0x40000000
static const unsigned int	s_Word1 = 0x60000000
static const unsigned int	s_Word2 = 0x50000000

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_v2.h.

Constructor & Destructor Documentation

EnergySumRoI_v2()

xAOD::EnergySumRoI_v2::EnergySumRoI_v2

(

)

Default constructor.

Definition at line 14 of file EnergySumRoI_v2.cxx.

      : SG::AuxElement() {
   }

Member Function Documentation

addThreshold()

void xAOD::EnergySumRoI_v2::addThreshold

(

const std::string &

name

)

Add a new threshold that was passed.

Definition at line 157 of file EnergySumRoI_v2.cxx.

                                                             {
 
      names( *this ).push_back( name );
      return;
   }

clearThresholds()

void xAOD::EnergySumRoI_v2::clearThresholds

(

)

Remove all the passed thresholds.

Definition at line 163 of file EnergySumRoI_v2.cxx.

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

energyT()

float xAOD::EnergySumRoI_v2::energyT

(

)

const

The deposited total transverse energy.

energyTRestricted()

float xAOD::EnergySumRoI_v2::energyTRestricted

(

)

const

energyX()

float xAOD::EnergySumRoI_v2::energyX

(

)

const

The total energy deposited in the X direction.

energyXRestricted()

float xAOD::EnergySumRoI_v2::energyXRestricted

(

)

const

energyY()

float xAOD::EnergySumRoI_v2::energyY

(

)

const

The total energy deposited in the Y direction.

energyYRestricted()

float xAOD::EnergySumRoI_v2::energyYRestricted

(

)

const

exMiss()

float xAOD::EnergySumRoI_v2::exMiss ( ) const

inline

The missing energy in the X direction.

Definition at line 131 of file EnergySumRoI_v2.h.

{ return -energyX(); }

exMissRestricted()

float xAOD::EnergySumRoI_v2::exMissRestricted ( ) const

inline

Definition at line 132 of file EnergySumRoI_v2.h.

{ return -energyXRestricted(); }

eyMiss()

float xAOD::EnergySumRoI_v2::eyMiss ( ) const

inline

The missing energy in the Y direction.

Definition at line 141 of file EnergySumRoI_v2.h.

{ return -energyY(); }

eyMissRestricted()

float xAOD::EnergySumRoI_v2::eyMissRestricted ( ) const

inline

Definition at line 142 of file EnergySumRoI_v2.h.

{ return -energyYRestricted(); }

initialize()

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

Initialise the object with its most important properties from a single RoI.

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 25 of file EnergySumRoI_v2.cxx.

                                                     {
 
      bool restricted = ((roiword0&s_Run2TruncRoIBit) != 0);      
      
      if (restricted) {
        setRoIWord3( roiword0 );
        setRoIWord4( roiword1 );
        setRoIWord5( roiword2 );
        setEnergyXRestricted( energyX );
        setEnergyYRestricted( energyY );
        setEnergyTRestricted( energyT );
      }
      else {
        setRoIWord0( roiword0 );
        setRoIWord1( roiword1 );
        setRoIWord2( roiword2 );
        setEnergyX( energyX );
        setEnergyY( energyY );
        setEnergyT( energyT );
      }
   
      return;
   }

overflowT()

bool xAOD::EnergySumRoI_v2::overflowT

(

bool

restricted = false

)

const

The overflow flag for the E_T calculation.

Definition at line 139 of file EnergySumRoI_v2.cxx.

                                                        {
 
      if (restricted) return ( ( roiWord5() >> 15 ) & 0x1 );
      else            return ( ( roiWord2() >> 15 ) & 0x1 );
   }

overflowX()

bool xAOD::EnergySumRoI_v2::overflowX

(

bool

restricted = false

)

const

The overflow flag for the E_X calculation.

Definition at line 127 of file EnergySumRoI_v2.cxx.

                                                        {
 
      if (restricted) return ( ( roiWord3() >> 15 ) & 0x1 );
      else            return ( ( roiWord0() >> 15 ) & 0x1 );
   }

overflowY()

bool xAOD::EnergySumRoI_v2::overflowY

(

bool

restricted = false

)

const

The overflow flag for the E_Y calculation.

Definition at line 133 of file EnergySumRoI_v2.cxx.

                                                        {
 
      if (restricted) return ( ( roiWord4() >> 15 ) & 0x1 );
      else            return ( ( roiWord1() >> 15 ) & 0x1 );
   }

roiWord0()

uint32_t xAOD::EnergySumRoI_v2::roiWord0

(

)

const

The first RoI word produced by the L1Calo hardware.

roiWord1()

uint32_t xAOD::EnergySumRoI_v2::roiWord1

(

)

const

The second RoI word produced by the L1Calo hardware.

roiWord2()

uint32_t xAOD::EnergySumRoI_v2::roiWord2

(

)

const

The third RoI word produced by the L1Calo hardware.

roiWord3()

uint32_t xAOD::EnergySumRoI_v2::roiWord3

(

)

const

The fourth RoI word produced by the L1Calo hardware.

roiWord4()

uint32_t xAOD::EnergySumRoI_v2::roiWord4

(

)

const

The fifth RoI word produced by the L1Calo hardware.

roiWord5()

uint32_t xAOD::EnergySumRoI_v2::roiWord5

(

)

const

The sixth RoI word produced by the L1Calo hardware.

setEnergyT()

void xAOD::EnergySumRoI_v2::setEnergyT

(

float

value

)

Set the deposited total transverse energy.

setEnergyTRestricted()

void xAOD::EnergySumRoI_v2::setEnergyTRestricted

(

float

value

)

setEnergyX()

void xAOD::EnergySumRoI_v2::setEnergyX

(

float

value

)

Set the total energy deposited in the X direction.

setEnergyXRestricted()

void xAOD::EnergySumRoI_v2::setEnergyXRestricted

(

float

value

)

setEnergyY()

void xAOD::EnergySumRoI_v2::setEnergyY

(

float

value

)

Set the total energy deposited in the Y direction.

setEnergyYRestricted()

void xAOD::EnergySumRoI_v2::setEnergyYRestricted

(

float

value

)

setRoIWord()

void xAOD::EnergySumRoI_v2::setRoIWord

(

uint32_t

value

)

Generic RoI word adding: the function will identify which word it is.

Update RoI word value. The function works out for itself which word input is.

Definition at line 54 of file EnergySumRoI_v2.cxx.

                                                      {
 
      bool word0 = ((roiword&s_RoIType) == s_Word0);
      bool word1 = ((roiword&s_RoIType) == s_Word1);
      bool word2 = ((roiword&s_RoIType) == s_Word2);
      bool restricted = ((roiword&s_Run2TruncRoIBit) != 0);
 
      if (!restricted) {
         if      (word0) setRoIWord0(roiword);
         else if (word1) setRoIWord1(roiword);
         else if (word2) setRoIWord2(roiword);
      }
      else {
         if      (word0) setRoIWord3(roiword);
         else if (word1) setRoIWord4(roiword);
         else if (word2) setRoIWord5(roiword);
      }
 
      return;
 
   }

setRoIWord0()

void xAOD::EnergySumRoI_v2::setRoIWord0

(

uint32_t

value

)

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

setRoIWord1()

void xAOD::EnergySumRoI_v2::setRoIWord1

(

uint32_t

value

)

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

setRoIWord2()

void xAOD::EnergySumRoI_v2::setRoIWord2

(

uint32_t

value

)

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

setRoIWord3()

void xAOD::EnergySumRoI_v2::setRoIWord3

(

uint32_t

value

)

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

setRoIWord4()

void xAOD::EnergySumRoI_v2::setRoIWord4

(

uint32_t

value

)

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

setRoIWord5()

void xAOD::EnergySumRoI_v2::setRoIWord5

(

uint32_t

value

)

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

thrNames()

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

(

)

const

The names of the thresholds passed.

Definition at line 169 of file EnergySumRoI_v2.cxx.

                                                                 {
 
      return names( *this );
   }

thrPatMET()

uint32_t xAOD::EnergySumRoI_v2::thrPatMET

(

bool

restricted = false

)

const

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

Definition at line 108 of file EnergySumRoI_v2.cxx.

                                                            {
 
      if (restricted) return ( ( roiWord4() >> 16 ) & 0xff ); 
      else            return ( ( roiWord1() >> 16 ) & 0xff );
   }

thrPatMETSig()

uint32_t xAOD::EnergySumRoI_v2::thrPatMETSig

(

)

const

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

Definition at line 114 of file EnergySumRoI_v2.cxx.

                                                {
 
      return ( ( roiWord2() >> 16 ) & 0xff );
   }

thrPatSumET()

setRoIWord1 setRoIWord3 setRoIWord5 uint32_t xAOD::EnergySumRoI_v2::thrPatSumET

(

bool

restricted = false

)

const

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

Definition at line 102 of file EnergySumRoI_v2.cxx.

                                                              {
 
      if (restricted) return ( ( roiWord3() >> 16 ) & 0xff ); 
      else            return ( ( roiWord0() >> 16 ) & 0xff );
   }

Member Data Documentation

s_RoIType

const unsigned int xAOD::EnergySumRoI_v2::s_RoIType = 0xf0000000

staticprivate

Definition at line 157 of file EnergySumRoI_v2.h.

s_Run2TruncRoIBit

const unsigned int xAOD::EnergySumRoI_v2::s_Run2TruncRoIBit = 0x4000000

staticprivate

The basic setters and getters for the xAOD class.

Definition at line 156 of file EnergySumRoI_v2.h.

s_Word0

const unsigned int xAOD::EnergySumRoI_v2::s_Word0 = 0x40000000

staticprivate

Definition at line 158 of file EnergySumRoI_v2.h.

s_Word1

const unsigned int xAOD::EnergySumRoI_v2::s_Word1 = 0x60000000

staticprivate

Definition at line 159 of file EnergySumRoI_v2.h.

s_Word2

const unsigned int xAOD::EnergySumRoI_v2::s_Word2 = 0x50000000

staticprivate

Definition at line 160 of file EnergySumRoI_v2.h.

---

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

• EnergySumRoI_v2.h
• EnergySumRoI_v2.cxx