xAOD::gFexJetRoI_v1 Class Reference

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

#include <gFexJetRoI_v1.h>

Inheritance diagram for xAOD::gFexJetRoI_v1:

Collaboration diagram for xAOD::gFexJetRoI_v1:

Public Types
enum	ObjectType { gRho = 0 , gBlockLead = 1 , gBlockSub = 2 , gJet = 3 }
	Object types. More...

Public Member Functions
	gFexJetRoI_v1 ()
	Default constructor.
void	initialize (uint32_t word, int tobEtScale)
	Initialise the object with its most important properties: only the word for gFEX.
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	menuEta () const
	the eta index to use for looking up thresholds in the menu
int	tobEtScale () const
void	setScale (int value)
	Set the "raw" 32-bit words describing the object candidate.
int16_t	gFexTobEt () const
	TOB ET (decoded from TOB, stored for convenience).
void	setTobEt (int16_t value)
	getter for integer ET on TOB scale (3.2 GeV/count)
int16_t	unpackEt () const
	setter for the above
float	et () const
	retrieves the Et index from the 32-bit word
uint8_t	iEta () const
	floating point value (GeV, TOB scale)
void	setEta (uint8_t value)
	getter for integer eta index (0-63)
unsigned int	unpackEtaIndex () const
	setter for the above
float	eta () const
	retrieves the Eta index from the 32-bit word
float	etaMin () const
	Floating point.
float	etaMax () const
	Floating point.
uint8_t	iPhi () const
	Floating point.
void	setPhi (uint8_t value)
	Getter for integer phi index (0-32) --> check numbers for gFEX.
unsigned int	unpackPhiIndex () const
	Setter for the above.
float	phi_gFex () const
	retrieves the phi index from the 32-bit word
float	phiMin_gFex () const
	Central value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).
float	phiMax_gFex () const
	Low value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).
float	phi () const
	High value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).
float	phiMin () const
	Central value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).
float	phiMax () const
	Low value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).
int	iPhiTopo () const
	High value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).
uint8_t	status () const
	phi index in the range used by L1Topo (0->127)
void	setStatus (uint8_t value)
unsigned int	unpackStatus () const
uint8_t	saturated () const
	retrieves the Status info from the 32-bit word
void	setSaturated (uint8_t value)
unsigned int	unpackSaturated () const
int	gFexType () const
	retrieves the Saturated info from the 32-bit word
void	setgFexType (int type)
int	unpackType () const
bool	isgBlockLead () const
	Identification of object type with flags.
bool	isgBlockSub () const
bool	isgJet () const
bool	isgRho () const

Static Private Attributes
static const float	s_PhiWidth = (2*pi)/32
	Constants used in converting to ATLAS units.
static const float	s_PhiWidthFR = (2*pi)/16
static const std::vector< float >	s_EtaEdge
static const std::vector< float >	s_EtaCenter
static const int	s_saturBit = 31
	Constants used in decoding TOB words For TOB word format changes these can be replaced by arrays in the _v2 object so that different versions can be decoded by one class.
static const int	s_phiBit = 26
static const int	s_etaBit = 20
static const int	s_etBit = 8
static const int	s_statusBit = 7
static const int	s_resBit = 5
static const int	s_tobIDBit = 0
static const int	s_saturMask = 0x1
static const int	s_phiMask = 0x1f
static const int	s_etaMask = 0x3f
static const int	s_etMask = 0xfff
static const int	s_statusMask = 0x1
static const int	s_resMask = 0x3
static const int	s_tobIDMask = 0x1f

Detailed Description

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

Definition at line 25 of file gFexJetRoI_v1.h.

Member Enumeration Documentation

ObjectType

enum xAOD::gFexJetRoI_v1::ObjectType

Object types.

Enumerator
gRho
gBlockLead	This object is a TOB (32 bit word).
gBlockSub	This object is a TOB (32 bit word).
gJet	This object is a TOB (32 bit word). This object is a TOB (32 bit word)

Definition at line 35 of file gFexJetRoI_v1.h.

                      {
         gRho         = 0,
         gBlockLead   = 1, 
         gBlockSub    = 2, 
         gJet         = 3, 
      };

Constructor & Destructor Documentation

gFexJetRoI_v1()

xAOD::gFexJetRoI_v1::gFexJetRoI_v1

(

)

Default constructor.

Definition at line 38 of file gFexJetRoI_v1.cxx.

    : SG::AuxElement() {
 
  }

Member Function Documentation

et()

float xAOD::gFexJetRoI_v1::et

(

)

const

retrieves the Et index from the 32-bit word

Definition at line 160 of file gFexJetRoI_v1.cxx.

                                {
      return gFexTobEt()*tobEtScale();
  }

eta()

float xAOD::gFexJetRoI_v1::eta

(

)

const

retrieves the Eta index from the 32-bit word

Definition at line 167 of file gFexJetRoI_v1.cxx.

                                 {
    if (gFexType() != gRho){
      int new_iEtaFR = 0;
      // Remapping in the extreme FR
      if (iEta() < 4 || iEta() > 35){
        if (iEta() == 2){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 0 : 1 ;
        }
        if (iEta() == 3){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 2 : 3 ;
        }
        if (iEta() == 36){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 37 : 36 ;
        }
        if (iEta() == 37){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 39 : 38 ;
        }
        return s_EtaCenter[new_iEtaFR];
      }
      //No remapping for central region |eta| < 3.0
      else{
        return s_EtaCenter[iEta()];
      }
    } 
    return 0;
   }

etaMax()

float xAOD::gFexJetRoI_v1::etaMax

(

)

const

Floating point.

Definition at line 222 of file gFexJetRoI_v1.cxx.

                                    {
    if (gFexType() != gRho){
      int new_iEtaFR = 0;
      // Remapping in the extreme FR
      if (iEta() < 4 || iEta() > 35){
        if (iEta() == 2){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 0 : 1 ;
        }
        if (iEta() == 3){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 2 : 3 ;
        }
        if (iEta() == 36){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 37 : 36 ;
        }
        if (iEta() == 37){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 39 : 38 ;
        }
        return s_EtaEdge[new_iEtaFR + 1];
      }
      //No remapping for central region |eta| < 3.0
      else{
        return s_EtaEdge[iEta() + 1];
      }
    }
    return 0;
  }

etaMin()

float xAOD::gFexJetRoI_v1::etaMin

(

)

const

Floating point.

Floating point coordinates. Return he minimum Eta and he maximum Eta of the Eta range.

Definition at line 195 of file gFexJetRoI_v1.cxx.

                                    {
    if (gFexType() != gRho){
      int new_iEtaFR = 0;
      // Remapping in the extreme FR
      if (iEta() < 4 || iEta() > 35){
        if (iEta() == 2){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 0 : 1 ;
        }
        if (iEta() == 3){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 2 : 3 ;
        }
        if (iEta() == 36){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 37 : 36 ;
        }
        if (iEta() == 37){
          new_iEtaFR = (int(iPhi())%2 == 0) ? 39 : 38 ;
        }
        return s_EtaEdge[new_iEtaFR];
      }
      //No remapping for central region |eta| < 3.0
      else{
        return s_EtaEdge[iEta()];
      }
    }
    return 0;
  }

gFexTobEt()

int16_t xAOD::gFexJetRoI_v1::gFexTobEt

(

)

const

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

gFexType()

int xAOD::gFexJetRoI_v1::gFexType

(

)

const

retrieves the Saturated info from the 32-bit word

iEta()

uint8_t xAOD::gFexJetRoI_v1::iEta

(

)

const

floating point value (GeV, TOB scale)

Eta Coordinates (decoded from TOB, stored for convenience)

initialize()

void xAOD::gFexJetRoI_v1::initialize	(	uint32_t	word,
		int	tobEtScale )

Initialise the object with its most important properties: only the word for gFEX.

Definition at line 43 of file gFexJetRoI_v1.cxx.

                                                                {
 
    setWord( word );
    setScale( tobEtScale );
    setgFexType(unpackType());
    setTobEt( unpackEt() );
    setEta( unpackEtaIndex() );
    setPhi( unpackPhiIndex() );
    setStatus( unpackStatus());
    setSaturated(unpackSaturated());
 
  }

iPhi()

uint8_t xAOD::gFexJetRoI_v1::iPhi

(

)

const

Floating point.

Phi coordinates

iPhiTopo()

int xAOD::gFexJetRoI_v1::iPhiTopo

(

)

const

High value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).

Definition at line 332 of file gFexJetRoI_v1.cxx.

                                    {
    int phi_out = 0;
    if (gFexType() != gRho){
      if (( iEta() <= 3 ) || ( (iEta() >= 36) )){
        phi_out = ( 8 * iPhi() ) + 4;
      }
      else {
        phi_out = ( 4 * iPhi() ) + 2;
      } 
    } 
    return phi_out; 
  }

isgBlockLead()

bool xAOD::gFexJetRoI_v1::isgBlockLead

(

)

const

Identification of object type with flags.

Definition at line 114 of file gFexJetRoI_v1.cxx.

                                         {
    return gFexType() == gBlockLead;
  }

isgBlockSub()

bool xAOD::gFexJetRoI_v1::isgBlockSub

(

)

const

Definition at line 118 of file gFexJetRoI_v1.cxx.

                                        {
    return gFexType() == gBlockSub;
  }

isgJet()

bool xAOD::gFexJetRoI_v1::isgJet

(

)

const

Definition at line 122 of file gFexJetRoI_v1.cxx.

                                   {
    return gFexType() == gJet;
  }

isgRho()

bool xAOD::gFexJetRoI_v1::isgRho

(

)

const

Definition at line 126 of file gFexJetRoI_v1.cxx.

                                   {
    return gFexType() == gRho;
  }

menuEta()

int xAOD::gFexJetRoI_v1::menuEta

(

)

const

the eta index to use for looking up thresholds in the menu

Definition at line 56 of file gFexJetRoI_v1.cxx.

                                     {
      return static_cast<int>(eta()*40)/4;
    }

phi()

float xAOD::gFexJetRoI_v1::phi

(

)

const

High value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).

Definition at line 300 of file gFexJetRoI_v1.cxx.

                                 {
    float phi_out = 0;
    if (gFexType() != gRho){
      if (phi_gFex() < pi) phi_out = phi_gFex();
      else phi_out = (phi_gFex() - 2*pi);
    }
    return phi_out; 
  }

phi_gFex()

float xAOD::gFexJetRoI_v1::phi_gFex

(

)

const

retrieves the phi index from the 32-bit word

Definition at line 254 of file gFexJetRoI_v1.cxx.

                                      {
    float phi_out = 0;
    if (gFexType() != gRho){
      float phi_idx;
      if (iEta() < 4 || iEta() > 35){
        // take the even iphi() and divide by 2 to get a continuous range (0-15)
        if (int(iPhi()%2) == 0 ){ 
          phi_idx = iPhi()/2;
          phi_out = (phi_idx * s_PhiWidthFR) + (s_PhiWidthFR/2);
          }
          // take the odd iphi() and get a continuous range (0,15)
        else { 
          phi_idx = (iPhi()-1)/2;
          phi_out = (phi_idx * s_PhiWidthFR) + (s_PhiWidthFR/2);}
      }
      else{
        phi_out = (iPhi() * s_PhiWidth) + (s_PhiWidth/2);
      }
        
    } 
    return phi_out; 
  }

phiMax()

float xAOD::gFexJetRoI_v1::phiMax

(

)

const

Low value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).

Definition at line 311 of file gFexJetRoI_v1.cxx.

                                    {
    float phi_out = 0;
    if (gFexType() != gRho){
      if (phiMax_gFex() < pi) phi_out = phiMax_gFex();
      else phi_out = (phiMax_gFex() - 2*pi);
    }
    return phi_out; 
  }

phiMax_gFex()

float xAOD::gFexJetRoI_v1::phiMax_gFex

(

)

const

Low value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).

Definition at line 290 of file gFexJetRoI_v1.cxx.

                                         {
    float phi_out = 0;
    if (gFexType() != gRho){
      phi_out = iPhi() * s_PhiWidth + s_PhiWidth;
    } 
    return phi_out; 
  }

phiMin()

float xAOD::gFexJetRoI_v1::phiMin

(

)

const

Central value of phi corresponding to phi index (using ATLAS convention, phi in [-pi, pi]).

Definition at line 322 of file gFexJetRoI_v1.cxx.

                                    {
    float phi_out = 0;
    if (gFexType() != gRho){
      if (phiMin_gFex() < pi) phi_out = phiMin_gFex();
      else phi_out = (phiMin_gFex() - 2*pi);
    }
    return phi_out; 
  }

phiMin_gFex()

float xAOD::gFexJetRoI_v1::phiMin_gFex

(

)

const

Central value of phi corresponding to phi index (using gFex convention, phi in [0, 2pi]).

Definition at line 280 of file gFexJetRoI_v1.cxx.

                                         {
    float phi_out = 0;
    if (gFexType() != gRho){
      phi_out = iPhi() * s_PhiWidth;
    } 
    return phi_out; 
  }

saturated()

uint8_t xAOD::gFexJetRoI_v1::saturated

(

)

const

retrieves the Status info from the 32-bit word

Energy saturation: if any gTower is saturated within gBlock and gJet, this bit is set. Always 0 for Rho.

setEta()

void xAOD::gFexJetRoI_v1::setEta

(

uint8_t

value

)

getter for integer eta index (0-63)

setgFexType()

void xAOD::gFexJetRoI_v1::setgFexType

(

int

type

)

setPhi()

void xAOD::gFexJetRoI_v1::setPhi

(

uint8_t

value

)

Getter for integer phi index (0-32) --> check numbers for gFEX.

setSaturated()

void xAOD::gFexJetRoI_v1::setSaturated

(

uint8_t

value

)

setScale()

void xAOD::gFexJetRoI_v1::setScale

(

int

value

)

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

setStatus()

void xAOD::gFexJetRoI_v1::setStatus

(

uint8_t

value

)

setTobEt()

void xAOD::gFexJetRoI_v1::setTobEt

(

int16_t

value

)

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

setWord()

void xAOD::gFexJetRoI_v1::setWord

(

uint32_t

value

)

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

status()

uint8_t xAOD::gFexJetRoI_v1::status

(

)

const

phi index in the range used by L1Topo (0->127)

TOB status: set to 1 if TOB Et exceeds TOB threshold (gBlocks & gJets). Status is set to 1 if Rho calculation is valid

tobEtScale()

int xAOD::gFexJetRoI_v1::tobEtScale

(

)

const

unpackEt()

int16_t xAOD::gFexJetRoI_v1::unpackEt

(

)

const

setter for the above

Definition at line 141 of file gFexJetRoI_v1.cxx.

                                        {
  // Data content = TOB
    int16_t energy = (word() >> s_etBit) & s_etMask; 
    return energy; 
  }

unpackEtaIndex()

unsigned int xAOD::gFexJetRoI_v1::unpackEtaIndex

(

)

const

setter for the above

Definition at line 148 of file gFexJetRoI_v1.cxx.

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

unpackPhiIndex()

unsigned int xAOD::gFexJetRoI_v1::unpackPhiIndex

(

)

const

Setter for the above.

Definition at line 153 of file gFexJetRoI_v1.cxx.

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

unpackSaturated()

unsigned int xAOD::gFexJetRoI_v1::unpackSaturated

(

)

const

Definition at line 135 of file gFexJetRoI_v1.cxx.

                                                   {
    return (word() >> s_saturBit) & s_saturMask;
  }

unpackStatus()

unsigned int xAOD::gFexJetRoI_v1::unpackStatus

(

)

const

Definition at line 131 of file gFexJetRoI_v1.cxx.

                                                {
    return (word() >> s_statusBit) & s_statusMask;
  }

unpackType()

int xAOD::gFexJetRoI_v1::unpackType

(

)

const

Definition at line 97 of file gFexJetRoI_v1.cxx.

                                      {
    auto tobID = (word() >> s_tobIDBit) & s_tobIDMask;
    if (tobID == 0 ){
      return gRho;
    }  
    else if (tobID == 1 || tobID == 2) {
      return gBlockLead;
    } 
    else if (tobID == 3 || tobID == 4 ) {
      return gBlockSub;
    }      
    else if (tobID == 5 || tobID == 6) {
      return gJet;
    }  
    else return -999;
  }

word()

uint32_t xAOD::gFexJetRoI_v1::word

(

)

const

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

Member Data Documentation

s_etaBit

const int xAOD::gFexJetRoI_v1::s_etaBit = 20

staticprivate

Definition at line 125 of file gFexJetRoI_v1.h.

s_EtaCenter

const std::vector< float > xAOD::gFexJetRoI_v1::s_EtaCenter

staticprivate

Initial value:

= { -4.5, -3.8, -3.38, -3.18, -3.15, -3, 
           -2.8, -2.6, -2.35, -2.1, -1.9, -1.7, -1.5, -1.3, -1.1, -0.9,  
           -0.7, -0.5, -0.3, -0.1, 0.1, 0.3, 0.5, 0.7, 0.9, 1.1,                                                 
           1.3, 1.5, 1.7, 1.9, 2.1, 2.35, 2.6, 2.8, 3.0,
           3.15, 3.18, 3.38, 3.8, 4.5}

Definition at line 114 of file gFexJetRoI_v1.h.

s_EtaEdge

const std::vector< float > xAOD::gFexJetRoI_v1::s_EtaEdge

staticprivate

Initial value:

= { -4.9, -4.1, -3.5, -3.25, -3.2, -3.1, 
           -2.9, -2.7, -2.5, -2.2, -2.0, -1.8, -1.6, -1.4, -1.2, -1.0,  
           -0.8, -0.6, -0.4, -0.2, 0.0, 0.2, 0.4, 0.6, 0.8, 1.0,                                                 
           1.2, 1.4, 1.6, 1.8, 2.0, 2.2, 2.5, 2.7, 2.9,
           3.1,3.25, 3.3, 3.5, 4.1, 4.9 }

Definition at line 113 of file gFexJetRoI_v1.h.

s_etaMask

const int xAOD::gFexJetRoI_v1::s_etaMask = 0x3f

staticprivate

Definition at line 134 of file gFexJetRoI_v1.h.

s_etBit

const int xAOD::gFexJetRoI_v1::s_etBit = 8

staticprivate

Definition at line 126 of file gFexJetRoI_v1.h.

s_etMask

const int xAOD::gFexJetRoI_v1::s_etMask = 0xfff

staticprivate

Definition at line 135 of file gFexJetRoI_v1.h.

s_phiBit

const int xAOD::gFexJetRoI_v1::s_phiBit = 26

staticprivate

Definition at line 124 of file gFexJetRoI_v1.h.

s_phiMask

const int xAOD::gFexJetRoI_v1::s_phiMask = 0x1f

staticprivate

Definition at line 133 of file gFexJetRoI_v1.h.

s_PhiWidth

const float xAOD::gFexJetRoI_v1::s_PhiWidth = (2*pi)/32

staticprivate

Constants used in converting to ATLAS units.

Definition at line 111 of file gFexJetRoI_v1.h.

s_PhiWidthFR

const float xAOD::gFexJetRoI_v1::s_PhiWidthFR = (2*pi)/16

staticprivate

Definition at line 112 of file gFexJetRoI_v1.h.

s_resBit

const int xAOD::gFexJetRoI_v1::s_resBit = 5

staticprivate

Definition at line 128 of file gFexJetRoI_v1.h.

s_resMask

const int xAOD::gFexJetRoI_v1::s_resMask = 0x3

staticprivate

Definition at line 137 of file gFexJetRoI_v1.h.

s_saturBit

const int xAOD::gFexJetRoI_v1::s_saturBit = 31

staticprivate

Constants used in decoding TOB words For TOB word format changes these can be replaced by arrays in the _v2 object so that different versions can be decoded by one class.

Definition at line 123 of file gFexJetRoI_v1.h.

s_saturMask

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

staticprivate

Definition at line 132 of file gFexJetRoI_v1.h.

s_statusBit

const int xAOD::gFexJetRoI_v1::s_statusBit = 7

staticprivate

Definition at line 127 of file gFexJetRoI_v1.h.

s_statusMask

const int xAOD::gFexJetRoI_v1::s_statusMask = 0x1

staticprivate

Definition at line 136 of file gFexJetRoI_v1.h.

s_tobIDBit

const int xAOD::gFexJetRoI_v1::s_tobIDBit = 0

staticprivate

Definition at line 129 of file gFexJetRoI_v1.h.

s_tobIDMask

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

staticprivate

Definition at line 138 of file gFexJetRoI_v1.h.

---

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

• gFexJetRoI_v1.h
• gFexJetRoI_v1.cxx