xAOD::gFexGlobalRoI_v1 Class Reference

Class describing properties of a LVL1 gFEX global Trigger Object (TOB) in the xAOD format. More...

#include <gFexGlobalRoI_v1.h>

Inheritance diagram for xAOD::gFexGlobalRoI_v1:

Collaboration diagram for xAOD::gFexGlobalRoI_v1:

Public Types
enum	ObjectType {   gNull = 0 , gScalar = 1 , gMET = 2 , gMHT = 3 ,   gMST = 4 }
	Object types. More...

Public Member Functions
	gFexGlobalRoI_v1 ()
	Default constructor.
void	initialize (uint32_t word, int tobEtScaleOne, int tobEtScaleTwo=0)
	Initialise the object with its properties.
uint32_t	word () const
	The "raw" 32-bit word describing the object candidate.
void	setWord (uint32_t value)
	Set the "raw" 32-bit words describing the object candidate.
int	tobEtScaleOne () const
void	setScaleOne (int value)
	Set the "raw" 32-bit words describing the object candidate.
int	tobEtScaleTwo () const
void	setScaleTwo (int value)
	Set the "raw" 32-bit words describing the object candidate.
int16_t	quantityOne () const
	TOB ET (decoded from TOB, stored for convenience).
void	setQuantityOne (int16_t value)
	getter for integer ET on TOB scale (3.2 GeV/count)
int16_t	unpackQuantityOne () const
	setter for the above
int16_t	quantityTwo () const
	retrieves the Et index from the 32-bit word
void	setQuantityTwo (int16_t value)
	getter for integer ET on TOB scale (3.2 GeV/count)
int16_t	unpackQuantityTwo () const
	setter for the above
float	METquantityOne () const
	retrieves the Et index from the 32-bit word
float	METquantityTwo () const
	floating point value (GeV, TOB scale)
float	SumEt () const
	floating point value (GeV, TOB scale)
uint8_t	statusOne () const
	floating point value (GeV, TOB scale)
void	setStatusOne (uint8_t value)
uint8_t	statusTwo () const
void	setStatusTwo (uint8_t value)
unsigned int	unpackStatusOne () const
unsigned int	unpackStatusTwo () const
	retrieves the Status info for Quantity 1 from the 32-bit word
uint8_t	saturated () const
	retrieves the Status info for Quantity 2 from the 32-bit word
void	setSaturated (uint8_t value)
unsigned int	unpackSaturated () const
int	globalType () const
	retrieves the energy saturation status from the 32-bit word
void	setGlobalType (int type)
int	unpackType () const
bool	isgScalar () const
	Identification of object type with flags.
bool	isgMET () const
bool	isgMHT () const
bool	isgMST () const

Static Private Attributes
static const int	s_saturBit = 31
	Constants used in converting to ATLAS units.
static const int	s_tobIDBit = 26
static const int	s_statusOneBit = 25
static const int	s_statusTwoBit = 24
static const int	s_quantityOneBit = 12
static const int	s_quantityTwoBit = 0
static const int	s_saturMask = 0x1
static const int	s_tobIDMask = 0x1f
static const int	s_statusOneMask = 0x1
static const int	s_statusTwoMask = 0x1
static const int	s_quantityOneMask = 0xfff
static const int	s_quantityTwoMask = 0xfff

Detailed Description

Class describing properties of a LVL1 gFEX global Trigger Object (TOB) in the xAOD format.

Definition at line 25 of file gFexGlobalRoI_v1.h.

Member Enumeration Documentation

ObjectType

enum xAOD::gFexGlobalRoI_v1::ObjectType

Object types.

Enumerator
gNull
gScalar	indicaes a null value (should be accompanied by a Status=0)
gMET	scalar values (MET, SumET))
gMHT	MET components (METx, METy).
gMST	MET hard term components (MHTx, MHTy).

Definition at line 36 of file gFexGlobalRoI_v1.h.

                      {
         gNull      = 0,  
         gScalar    = 1,  
         gMET       = 2,  
         gMHT       = 3,  
         gMST       = 4   
      };

Constructor & Destructor Documentation

gFexGlobalRoI_v1()

xAOD::gFexGlobalRoI_v1::gFexGlobalRoI_v1

(

)

Default constructor.

Constants used in converting to ATLAS units.

Definition at line 20 of file gFexGlobalRoI_v1.cxx.

      : SG::AuxElement() {
 
   }

Member Function Documentation

globalType()

int xAOD::gFexGlobalRoI_v1::globalType

(

)

const

retrieves the energy saturation status from the 32-bit word

initialize()

void xAOD::gFexGlobalRoI_v1::initialize	(	uint32_t	word,
		int	tobEtScaleOne,
		int	tobEtScaleTwo = 0 )

Initialise the object with its properties.

Definition at line 25 of file gFexGlobalRoI_v1.cxx.

                                                                                         {
 
      setWord( word );
      setScaleOne( tobEtScaleOne );
      setScaleTwo( tobEtScaleTwo );
      setGlobalType(unpackType());
      setQuantityOne( unpackQuantityOne() );
      setQuantityTwo( unpackQuantityTwo() );
      setStatusOne( unpackStatusOne());
      setStatusTwo( unpackStatusTwo());
      setSaturated(unpackSaturated());
 
   }

isgMET()

bool xAOD::gFexGlobalRoI_v1::isgMET

(

)

const

isgMHT()

bool xAOD::gFexGlobalRoI_v1::isgMHT

(

)

const

isgMST()

bool xAOD::gFexGlobalRoI_v1::isgMST

(

)

const

isgScalar()

bool xAOD::gFexGlobalRoI_v1::isgScalar

(

)

const

Identification of object type with flags.

METquantityOne()

float xAOD::gFexGlobalRoI_v1::METquantityOne

(

)

const

retrieves the Et index from the 32-bit word

METquantityTwo()

float xAOD::gFexGlobalRoI_v1::METquantityTwo

(

)

const

floating point value (GeV, TOB scale)

quantityOne()

int16_t xAOD::gFexGlobalRoI_v1::quantityOne

(

)

const

TOB ET (decoded from TOB, stored for convenience).

quantityTwo()

int16_t xAOD::gFexGlobalRoI_v1::quantityTwo

(

)

const

retrieves the Et index from the 32-bit word

saturated()

uint8_t xAOD::gFexGlobalRoI_v1::saturated

(

)

const

retrieves the Status info for Quantity 2 from the 32-bit word

Energy saturation in tthe global TOB values

setGlobalType()

void xAOD::gFexGlobalRoI_v1::setGlobalType

(

int

type

)

setQuantityOne()

void xAOD::gFexGlobalRoI_v1::setQuantityOne

(

int16_t

value

)

getter for integer ET on TOB scale (3.2 GeV/count)

setQuantityTwo()

void xAOD::gFexGlobalRoI_v1::setQuantityTwo

(

int16_t

value

)

getter for integer ET on TOB scale (3.2 GeV/count)

setSaturated()

void xAOD::gFexGlobalRoI_v1::setSaturated

(

uint8_t

value

)

setScaleOne()

void xAOD::gFexGlobalRoI_v1::setScaleOne

(

int

value

)

Set the "raw" 32-bit words describing the object candidate.

setScaleTwo()

void xAOD::gFexGlobalRoI_v1::setScaleTwo

(

int

value

)

Set the "raw" 32-bit words describing the object candidate.

setStatusOne()

void xAOD::gFexGlobalRoI_v1::setStatusOne

(

uint8_t

value

)

setStatusTwo()

void xAOD::gFexGlobalRoI_v1::setStatusTwo

(

uint8_t

value

)

setWord()

void xAOD::gFexGlobalRoI_v1::setWord

(

uint32_t

value

)

Set the "raw" 32-bit words describing the object candidate.

statusOne()

uint8_t xAOD::gFexGlobalRoI_v1::statusOne

(

)

const

floating point value (GeV, TOB scale)

TOB status: set to 0 if values are null

statusTwo()

uint8_t xAOD::gFexGlobalRoI_v1::statusTwo

(

)

const

SumEt()

float xAOD::gFexGlobalRoI_v1::SumEt

(

)

const

floating point value (GeV, TOB scale)

tobEtScaleOne()

int xAOD::gFexGlobalRoI_v1::tobEtScaleOne

(

)

const

tobEtScaleTwo()

int xAOD::gFexGlobalRoI_v1::tobEtScaleTwo

(

)

const

unpackQuantityOne()

int16_t xAOD::gFexGlobalRoI_v1::unpackQuantityOne

(

)

const

setter for the above

unpackQuantityTwo()

int16_t xAOD::gFexGlobalRoI_v1::unpackQuantityTwo

(

)

const

setter for the above

unpackSaturated()

unsigned int xAOD::gFexGlobalRoI_v1::unpackSaturated

(

)

const

unpackStatusOne()

unsigned int xAOD::gFexGlobalRoI_v1::unpackStatusOne

(

)

const

unpackStatusTwo()

unsigned int xAOD::gFexGlobalRoI_v1::unpackStatusTwo

(

)

const

retrieves the Status info for Quantity 1 from the 32-bit word

unpackType()

int xAOD::gFexGlobalRoI_v1::unpackType

(

)

const

word()

uint32_t xAOD::gFexGlobalRoI_v1::word

(

)

const

The "raw" 32-bit word describing the object candidate.

Member Data Documentation

s_quantityOneBit

const int xAOD::gFexGlobalRoI_v1::s_quantityOneBit = 12

staticprivate

Definition at line 112 of file gFexGlobalRoI_v1.h.

s_quantityOneMask

const int xAOD::gFexGlobalRoI_v1::s_quantityOneMask = 0xfff

staticprivate

Definition at line 120 of file gFexGlobalRoI_v1.h.

s_quantityTwoBit

const int xAOD::gFexGlobalRoI_v1::s_quantityTwoBit = 0

staticprivate

Definition at line 113 of file gFexGlobalRoI_v1.h.

s_quantityTwoMask

const int xAOD::gFexGlobalRoI_v1::s_quantityTwoMask = 0xfff

staticprivate

Definition at line 121 of file gFexGlobalRoI_v1.h.

s_saturBit

const int xAOD::gFexGlobalRoI_v1::s_saturBit = 31

staticprivate

Constants used in converting to ATLAS units.

Definition at line 108 of file gFexGlobalRoI_v1.h.

s_saturMask

const int xAOD::gFexGlobalRoI_v1::s_saturMask = 0x1

staticprivate

Definition at line 116 of file gFexGlobalRoI_v1.h.

s_statusOneBit

const int xAOD::gFexGlobalRoI_v1::s_statusOneBit = 25

staticprivate

Definition at line 110 of file gFexGlobalRoI_v1.h.

s_statusOneMask

const int xAOD::gFexGlobalRoI_v1::s_statusOneMask = 0x1

staticprivate

Definition at line 118 of file gFexGlobalRoI_v1.h.

s_statusTwoBit

const int xAOD::gFexGlobalRoI_v1::s_statusTwoBit = 24

staticprivate

Definition at line 111 of file gFexGlobalRoI_v1.h.

s_statusTwoMask

const int xAOD::gFexGlobalRoI_v1::s_statusTwoMask = 0x1

staticprivate

Definition at line 119 of file gFexGlobalRoI_v1.h.

s_tobIDBit

const int xAOD::gFexGlobalRoI_v1::s_tobIDBit = 26

staticprivate

Definition at line 109 of file gFexGlobalRoI_v1.h.

s_tobIDMask

const int xAOD::gFexGlobalRoI_v1::s_tobIDMask = 0x1f

staticprivate

Definition at line 117 of file gFexGlobalRoI_v1.h.

---

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

• gFexGlobalRoI_v1.h
• gFexGlobalRoI_v1.cxx