xAOD::jFexSumETRoI_v1 Class Reference

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

#include <jFexSumETRoI_v1.h>

Inheritance diagram for xAOD::jFexSumETRoI_v1:

Collaboration diagram for xAOD::jFexSumETRoI_v1:

Public Member Functions
	jFexSumETRoI_v1 ()
	Default constructor.
void	initialize (uint8_t jFexNumber, uint8_t fpgaNumber, uint32_t tobWord, int resolution)
	In future initialze the xTOB as well, word1.
uint32_t	tobWord () const
	The "raw" 32-bit word describing the object candidate.
uint8_t	fpgaNumber () const
uint8_t	jFexNumber () const
uint16_t	tobEt_lower () const
uint8_t	tobSat_lower () const
uint16_t	tobEt_upper () const
uint8_t	tobSat_upper () const
int	tobEtScale () const
void	setTobWord (uint32_t tobWord)
	Set the "raw" 32-bit words describing the object candidate.
void	setjFexNumber (uint8_t jFexNumber)
void	setfpgaNumber (uint8_t fpgaNumber)
uint16_t	unpackEt_lower () const
	Raw data words.
void	setTobEt_lower (uint16_t value)
int	Et_lower () const
	Methods that require combining results or applying scales.
uint16_t	unpackEt_upper () const
void	setTobEt_upper (uint16_t value)
int	Et_upper () const
	Et_upper in 1 MeV scale.
uint8_t	unpackSat_lower () const
void	setTobSat_lower (uint8_t value)
uint8_t	unpackSat_upper () const
void	setTobSat_upper (uint8_t value)
void	setResolution (int value)

Static Private Attributes
static const int	s_Sat_upperBit = 31
static const int	s_Et_upperBit = 16
static const int	s_Et_lowerBit = 1
static const int	s_Sat_lowerBit = 0
static const int	s_Sat_upperMask = 0x1
static const int	s_Et_upperMask = 0x7fff
static const int	s_Et_lowerMask = 0x7fff
static const int	s_Sat_lowerMask = 0x1

Detailed Description

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

Definition at line 22 of file jFexSumETRoI_v1.h.

Constructor & Destructor Documentation

jFexSumETRoI_v1()

xAOD::jFexSumETRoI_v1::jFexSumETRoI_v1

(

)

Default constructor.

Definition at line 17 of file jFexSumETRoI_v1.cxx.

        : SG::AuxElement() {
    }

Member Function Documentation

Et_lower()

int xAOD::jFexSumETRoI_v1::Et_lower

(

)

const

Methods that require combining results or applying scales.

Et_lower in 1 MeV scale

Definition at line 94 of file jFexSumETRoI_v1.cxx.

                                        {
        return tobEt_lower()*tobEtScale();
    }

Et_upper()

int xAOD::jFexSumETRoI_v1::Et_upper

(

)

const

Et_upper in 1 MeV scale.

Definition at line 99 of file jFexSumETRoI_v1.cxx.

                                        {
        return tobEt_upper()*tobEtScale();
    }

fpgaNumber()

uint8_t xAOD::jFexSumETRoI_v1::fpgaNumber

(

)

const

initialize()

void xAOD::jFexSumETRoI_v1::initialize	(	uint8_t	jFexNumber,
		uint8_t	fpgaNumber,
		uint32_t	tobWord,
		int	resolution )

In future initialze the xTOB as well, word1.

Definition at line 20 of file jFexSumETRoI_v1.cxx.

                                                                                                             {
 
        setTobWord     ( tobWord           );
        setjFexNumber  ( jFexNumber        );
        setfpgaNumber  ( fpgaNumber        );
        setTobEt_lower ( unpackEt_lower()  );
        setTobEt_upper ( unpackEt_upper()  );
        setTobSat_lower( unpackSat_lower() );
        setTobSat_upper( unpackSat_upper() );
        setResolution  ( resolution        );
        
        //include in future when xTOB in jFEX has been implemented.
 
        // If the object is a TOB then the isTOB should be true.
        // For xTOB default is false, but should be set if a matching TOB is found
        // if (type() == TOB) setIsTOB(1);
        // else               setIsTOB(0);
 
        return;
    }

jFexNumber()

uint8_t xAOD::jFexSumETRoI_v1::jFexNumber

(

)

const

setfpgaNumber()

void xAOD::jFexSumETRoI_v1::setfpgaNumber

(

uint8_t

fpgaNumber

)

setjFexNumber()

void xAOD::jFexSumETRoI_v1::setjFexNumber

(

uint8_t

jFexNumber

)

setResolution()

void xAOD::jFexSumETRoI_v1::setResolution

(

int

value

)

setTobEt_lower()

void xAOD::jFexSumETRoI_v1::setTobEt_lower

(

uint16_t

value

)

setTobEt_upper()

void xAOD::jFexSumETRoI_v1::setTobEt_upper

(

uint16_t

value

)

setTobSat_lower()

void xAOD::jFexSumETRoI_v1::setTobSat_lower

(

uint8_t

value

)

setTobSat_upper()

void xAOD::jFexSumETRoI_v1::setTobSat_upper

(

uint8_t

value

)

setTobWord()

void xAOD::jFexSumETRoI_v1::setTobWord

(

uint32_t

tobWord

)

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

tobEt_lower()

uint16_t xAOD::jFexSumETRoI_v1::tobEt_lower

(

)

const

tobEt_upper()

uint16_t xAOD::jFexSumETRoI_v1::tobEt_upper

(

)

const

tobEtScale()

int xAOD::jFexSumETRoI_v1::tobEtScale

(

)

const

tobSat_lower()

uint8_t xAOD::jFexSumETRoI_v1::tobSat_lower

(

)

const

tobSat_upper()

uint8_t xAOD::jFexSumETRoI_v1::tobSat_upper

(

)

const

tobWord()

uint32_t xAOD::jFexSumETRoI_v1::tobWord

(

)

const

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

unpackEt_lower()

uint16_t xAOD::jFexSumETRoI_v1::unpackEt_lower

(

)

const

Raw data words.

Only calculable externally Extracted from data words, stored for convenience Setting the jFEX ET resolution Methods to decode data from the TOB/RoI and return to the user TOB or xTOB?

Definition at line 73 of file jFexSumETRoI_v1.cxx.

                                                   {
        return (tobWord() >> s_Et_lowerBit) & s_Et_lowerMask;
    }

unpackEt_upper()

uint16_t xAOD::jFexSumETRoI_v1::unpackEt_upper

(

)

const

Definition at line 78 of file jFexSumETRoI_v1.cxx.

                                                   {
        return (tobWord() >> s_Et_upperBit) & s_Et_upperMask;
    }

unpackSat_lower()

uint8_t xAOD::jFexSumETRoI_v1::unpackSat_lower

(

)

const

Definition at line 83 of file jFexSumETRoI_v1.cxx.

                                                   {
        return (tobWord() >> s_Sat_lowerBit) & s_Sat_lowerMask;
    }

unpackSat_upper()

uint8_t xAOD::jFexSumETRoI_v1::unpackSat_upper

(

)

const

Definition at line 87 of file jFexSumETRoI_v1.cxx.

                                                   {
        return (tobWord() >> s_Sat_upperBit) & s_Sat_upperMask;
    }

Member Data Documentation

s_Et_lowerBit

const int xAOD::jFexSumETRoI_v1::s_Et_lowerBit = 1

staticprivate

Definition at line 72 of file jFexSumETRoI_v1.h.

s_Et_lowerMask

const int xAOD::jFexSumETRoI_v1::s_Et_lowerMask = 0x7fff

staticprivate

Definition at line 78 of file jFexSumETRoI_v1.h.

s_Et_upperBit

const int xAOD::jFexSumETRoI_v1::s_Et_upperBit = 16

staticprivate

Definition at line 71 of file jFexSumETRoI_v1.h.

s_Et_upperMask

const int xAOD::jFexSumETRoI_v1::s_Et_upperMask = 0x7fff

staticprivate

Definition at line 77 of file jFexSumETRoI_v1.h.

s_Sat_lowerBit

const int xAOD::jFexSumETRoI_v1::s_Sat_lowerBit = 0

staticprivate

Definition at line 73 of file jFexSumETRoI_v1.h.

s_Sat_lowerMask

const int xAOD::jFexSumETRoI_v1::s_Sat_lowerMask = 0x1

staticprivate

Definition at line 79 of file jFexSumETRoI_v1.h.

s_Sat_upperBit

const int xAOD::jFexSumETRoI_v1::s_Sat_upperBit = 31

staticprivate

Definition at line 70 of file jFexSumETRoI_v1.h.

s_Sat_upperMask

const int xAOD::jFexSumETRoI_v1::s_Sat_upperMask = 0x1

staticprivate

Definition at line 76 of file jFexSumETRoI_v1.h.

---

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

• jFexSumETRoI_v1.h
• jFexSumETRoI_v1.cxx