xAOD::jFexTauRoI_v1 Class Reference

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

#include <jFexTauRoI_v1.h>

Inheritance diagram for xAOD::jFexTauRoI_v1:

Collaboration diagram for xAOD::jFexTauRoI_v1:

Public Member Functions
	jFexTauRoI_v1 ()
	Default constructor.
void	initialize (uint8_t jFexNumber, uint8_t fpgaNumber, uint32_t tobWord, char istob, int resolution, float_t eta, float_t phi)
	In future initialze the EDM.
uint32_t	tobWord () const
	The "raw" 32-bit word describing the object candidate.
uint8_t	jFexNumber () const
uint8_t	fpgaNumber () const
uint16_t	tobEt () const
uint16_t	tobIso () const
uint8_t	tobLocalEta () const
uint8_t	tobLocalPhi () const
uint8_t	tobSat () const
int	globalEta () const
uint	globalPhi () const
float	eta () const
float	phi () const
int	tobEtScale () const
char	isTOB () const
void	setIsTOB (char value)
	Set the isTOB variable (TOB or xTOB).
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)
unsigned int	unpackEtTOB () const
	TOB ET (decoded from TOB, stored for convenience).
void	setTobEt (uint16_t value)
unsigned int	et () const
	Methods that require combining results or applying scales.
unsigned int	unpackIsoTOB () const
	TOB Isolation (decoded from TOB, stored for convenience).
void	setTobIso (uint16_t value)
unsigned int	iso () const
	Iso on TOB scale.
unsigned int	unpackEtaIndex () const
	Eta coordinates.
void	setTobLocalEta (uint8_t value)
unsigned int	unpackPhiIndex () const
	Phi coordinates.
void	setTobLocalPhi (uint8_t value)
unsigned int	unpackSaturationIndex () const
void	setTobSat (uint8_t value)
int	unpackGlobalEta () const
	As the Trigger towers are 1x1 in Eta - Phi coords (x10).
void	setGlobalEta (int value)
void	setEta (float value)
uint	unpackGlobalPhi () const
void	setGlobalPhi (uint value)
void	setPhi (float value)
void	setResolution (int value)

Static Private Attributes
static const int	s_isoBit = 21
static const int	s_etBit = 10
static const int	s_etaBit = 5
static const int	s_phiBit = 1
static const int	s_satBit = 0
static const int	s_etaMask = 0x1f
static const int	s_phiMask = 0xf
static const int	s_etMask = 0x7ff
static const int	s_isoMask = 0x7ff
static const int	s_satMask = 0x1

Detailed Description

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

Definition at line 23 of file jFexTauRoI_v1.h.

Constructor & Destructor Documentation

jFexTauRoI_v1()

xAOD::jFexTauRoI_v1::jFexTauRoI_v1

(

)

Default constructor.

Definition at line 18 of file jFexTauRoI_v1.cxx.

     : SG::AuxElement() {
   }

Member Function Documentation

et()

unsigned int xAOD::jFexTauRoI_v1::et

(

)

const

Methods that require combining results or applying scales.

ET on TOB scale

Definition at line 114 of file jFexTauRoI_v1.cxx.

                                        {
     //return TOB Et in a 1 MeV scale
     return tobEt()*tobEtScale();
   }

eta()

float xAOD::jFexTauRoI_v1::eta

(

)

const

fpgaNumber()

uint8_t xAOD::jFexTauRoI_v1::fpgaNumber

(

)

const

globalEta()

int xAOD::jFexTauRoI_v1::globalEta

(

)

const

globalPhi()

uint xAOD::jFexTauRoI_v1::globalPhi

(

)

const

initialize()

void xAOD::jFexTauRoI_v1::initialize	(	uint8_t	jFexNumber,
		uint8_t	fpgaNumber,
		uint32_t	tobWord,
		char	istob,
		int	resolution,
		float_t	eta,
		float_t	phi )

In future initialze the EDM.

Definition at line 21 of file jFexTauRoI_v1.cxx.

                                                                                                                                                 {
 
     setTobWord( tobWord );
     setjFexNumber( jFexNumber );
     setfpgaNumber(fpgaNumber);
     setTobLocalEta( unpackEtaIndex() );
     setTobLocalPhi( unpackPhiIndex() ); 
     setTobEt(unpackEtTOB());
     setTobIso(unpackIsoTOB());
     setTobSat(unpackSaturationIndex());
     setGlobalEta(unpackGlobalEta());
     setGlobalPhi(unpackGlobalPhi());
     setEta( eta );
     setPhi( phi ); 
     setResolution( resolution ); 
     setIsTOB(istob);
 
 
      return;
   }

iso()

unsigned int xAOD::jFexTauRoI_v1::iso

(

)

const

Iso on TOB scale.

Definition at line 120 of file jFexTauRoI_v1.cxx.

                                         {
    //return TOB Isolation in a 1 MeV scale
     return tobIso()*tobEtScale();
   }

isTOB()

char xAOD::jFexTauRoI_v1::isTOB

(

)

const

jFexNumber()

uint8_t xAOD::jFexTauRoI_v1::jFexNumber

(

)

const

phi()

float xAOD::jFexTauRoI_v1::phi

(

)

const

setEta()

void xAOD::jFexTauRoI_v1::setEta

(

float

value

)

setfpgaNumber()

void xAOD::jFexTauRoI_v1::setfpgaNumber

(

uint8_t

fpgaNumber

)

setGlobalEta()

void xAOD::jFexTauRoI_v1::setGlobalEta

(

int

value

)

setGlobalPhi()

void xAOD::jFexTauRoI_v1::setGlobalPhi

(

uint

value

)

setIsTOB()

void xAOD::jFexTauRoI_v1::setIsTOB

(

char

value

)

Set the isTOB variable (TOB or xTOB).

setjFexNumber()

void xAOD::jFexTauRoI_v1::setjFexNumber

(

uint8_t

jFexNumber

)

setPhi()

void xAOD::jFexTauRoI_v1::setPhi

(

float

value

)

setResolution()

void xAOD::jFexTauRoI_v1::setResolution

(

int

value

)

setTobEt()

void xAOD::jFexTauRoI_v1::setTobEt

(

uint16_t

value

)

setTobIso()

void xAOD::jFexTauRoI_v1::setTobIso

(

uint16_t

value

)

setTobLocalEta()

void xAOD::jFexTauRoI_v1::setTobLocalEta

(

uint8_t

value

)

setTobLocalPhi()

void xAOD::jFexTauRoI_v1::setTobLocalPhi

(

uint8_t

value

)

setTobSat()

void xAOD::jFexTauRoI_v1::setTobSat

(

uint8_t

value

)

setTobWord()

void xAOD::jFexTauRoI_v1::setTobWord

(

uint32_t

tobWord

)

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

tobEt()

uint16_t xAOD::jFexTauRoI_v1::tobEt

(

)

const

tobEtScale()

int xAOD::jFexTauRoI_v1::tobEtScale

(

)

const

tobIso()

uint16_t xAOD::jFexTauRoI_v1::tobIso

(

)

const

tobLocalEta()

uint8_t xAOD::jFexTauRoI_v1::tobLocalEta

(

)

const

tobLocalPhi()

uint8_t xAOD::jFexTauRoI_v1::tobLocalPhi

(

)

const

tobSat()

uint8_t xAOD::jFexTauRoI_v1::tobSat

(

)

const

tobWord()

uint32_t xAOD::jFexTauRoI_v1::tobWord

(

)

const

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

unpackEtaIndex()

unsigned int xAOD::jFexTauRoI_v1::unpackEtaIndex

(

)

const

Eta coordinates.

Definition at line 98 of file jFexTauRoI_v1.cxx.

                                                    {
     return (tobWord() >> s_etaBit) & s_etaMask;
   }

unpackEtTOB()

unsigned int xAOD::jFexTauRoI_v1::unpackEtTOB

(

)

const

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

Raw data words.

Only calculable externally Used to differencite TOBs from xTOBs Extracted from data words, stored for convenience global coordinates, stored for furture use but not sent to L1Topo Setting the jFEX ET resolution Methods to decode data from the TOB/RoI and return to the user TOB or xTOB?

Definition at line 88 of file jFexTauRoI_v1.cxx.

                                                 {
     return (tobWord() >> s_etBit) & s_etMask;
    }

unpackGlobalEta()

int xAOD::jFexTauRoI_v1::unpackGlobalEta

(

)

const

As the Trigger towers are 1x1 in Eta - Phi coords (x10).

Definition at line 128 of file jFexTauRoI_v1.cxx.

                                          {
      
    int globalEta = 0;
    if(jFexNumber()<3){
        globalEta= 8*(jFexNumber()-2) - (tobLocalEta()+1);
    }
    else if(jFexNumber()<6){
        globalEta= 8*(jFexNumber()-3) + (tobLocalEta());
    }
 
    return globalEta;
  }

unpackGlobalPhi()

uint xAOD::jFexTauRoI_v1::unpackGlobalPhi

(

)

const

Definition at line 141 of file jFexTauRoI_v1.cxx.

                                              {
        const unsigned int quadrant = ::getQuadrant(fpgaNumber());
        
        uint globalPhi = tobLocalPhi() + (quadrant * 16);
        return globalPhi;
 
    }

unpackIsoTOB()

unsigned int xAOD::jFexTauRoI_v1::unpackIsoTOB

(

)

const

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

Definition at line 93 of file jFexTauRoI_v1.cxx.

                                                  {
     return (tobWord() >> s_isoBit) & s_isoMask;
    } 

unpackPhiIndex()

unsigned int xAOD::jFexTauRoI_v1::unpackPhiIndex

(

)

const

Phi coordinates.

Definition at line 102 of file jFexTauRoI_v1.cxx.

                                                    {
     return (tobWord() >> s_phiBit) & s_phiMask;
   }

unpackSaturationIndex()

unsigned int xAOD::jFexTauRoI_v1::unpackSaturationIndex

(

)

const

Definition at line 107 of file jFexTauRoI_v1.cxx.

                                                          {
     return (tobWord() >> s_satBit) & s_satMask;
   }

Member Data Documentation

s_etaBit

const int xAOD::jFexTauRoI_v1::s_etaBit = 5

staticprivate

Definition at line 99 of file jFexTauRoI_v1.h.

s_etaMask

const int xAOD::jFexTauRoI_v1::s_etaMask = 0x1f

staticprivate

Definition at line 104 of file jFexTauRoI_v1.h.

s_etBit

const int xAOD::jFexTauRoI_v1::s_etBit = 10

staticprivate

Definition at line 98 of file jFexTauRoI_v1.h.

s_etMask

const int xAOD::jFexTauRoI_v1::s_etMask = 0x7ff

staticprivate

Definition at line 106 of file jFexTauRoI_v1.h.

s_isoBit

const int xAOD::jFexTauRoI_v1::s_isoBit = 21

staticprivate

Definition at line 97 of file jFexTauRoI_v1.h.

s_isoMask

const int xAOD::jFexTauRoI_v1::s_isoMask = 0x7ff

staticprivate

Definition at line 107 of file jFexTauRoI_v1.h.

s_phiBit

const int xAOD::jFexTauRoI_v1::s_phiBit = 1

staticprivate

Definition at line 100 of file jFexTauRoI_v1.h.

s_phiMask

const int xAOD::jFexTauRoI_v1::s_phiMask = 0xf

staticprivate

Definition at line 105 of file jFexTauRoI_v1.h.

s_satBit

const int xAOD::jFexTauRoI_v1::s_satBit = 0

staticprivate

Definition at line 101 of file jFexTauRoI_v1.h.

s_satMask

const int xAOD::jFexTauRoI_v1::s_satMask = 0x1

staticprivate

Definition at line 108 of file jFexTauRoI_v1.h.

---

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

• jFexTauRoI_v1.h
• jFexTauRoI_v1.cxx