xAOD::EmTauRoI_v2 Class Reference

#include <EmTauRoI_v2.h>

Inheritance diagram for xAOD::EmTauRoI_v2:
SG::AuxElement SG::IAuxElement

List of all members.

Public Types

enum  RoIType { CPRoIWord = 0, EMRoIWord = 1, TauRoIWord = 2 }
 

RoI word types.

More...

Public Member Functions

 EmTauRoI_v2 ()
 Default constructor.
void initialize (uint32_t roiword, float eta, float phi)
 Initialise the object with its most important properties.
RoIType roiType () const
 Get the type of the RoI word.
float eta () const
 The pseudorapidity ($\eta$) of the em/tau candidate.
void setEta (float v)
 Set the pseudorapidity of the em/tau candidate.
float phi () const
 The azimuthal angle ($\phi$) of the em/tau candidate.
void setPhi (float v)
 Set the azimuthal angle of the em/tau candidate.
uint32_t roiWord () const
 The "raw" RoI word describing the em/tau candidate.
void setRoIWord (uint32_t value)
 Set the "raw" RoI word, describing the em/tau candidate.
float etScale () const
 The ET scale of the RoI bits.
void setEtScale (float v)
 Set the ET scale.
float eT () const
 The ET of the cluster (from RoI word).
uint8_t isol () const
 The isolation result mask (from RoI word).
uint32_t thrPattern () const
 The pattern describing which thresholds were passed by the jet.
void setThrPattern (uint32_t value)
 Set the threshold pattern.
Energies deposited in various areas around the RoI



float core () const
 The ET of the RoI Core cluster (2x2 towers, EM+Had).
void setCore (float value)
 Set the ET of the RoI Core cluster (2x2 towers, EM+Had).
float emClus () const
 The deposited ET from the "EM cluster".
void setEmClus (float value)
 Set the deposited ET from the "EM cluster".
float tauClus () const
 The deposited ET from the "tau cluster".
void setTauClus (float value)
 Set the deposited ET from the "tau cluster".
float emIsol () const
 The EM calorimeter isolation (outer ring of EM towers).
void setEmIsol (float value)
 Set the EM calorimeter isolation (outer ring of EM towers).
float hadIsol () const
 The hadron calorimeter isolation (outer ring of had towers).
void setHadIsol (float value)
 Set the hadron calorimeter isolation (outer ring of had towers).
float hadCore () const
void setHadCore (float value)
 Set the ET deposited in the inner hadronic isolation region.
Thresholds passed by the RoI



void addThreshold (const std::string &name, float value)
 Add a new threshold that was passed by the RoI.
void clearThresholds ()
 Remove all the passed thresholds from the RoI.
const std::vector< std::string > & thrNames () const
 The names of the thresholds passed by jet candidate.
const std::vector< float > & thrValues () const
 The values of the thresholds (in MeV) passed by the jet candidate.

Detailed Description

Class describing a LVL1 em/tau region of interest

This class describes the properties of an em/tau region of interest (RoI) in the xAOD format.

Author:
Lukas Heinrich <Lukas.Heinrich@cern.ch>
Attila Krasznahorkay <Attila.Krasznahorkay@cern.ch>
Alan Watson <Alan.Watson@cern.ch>
Revision
631149
Date
2014-11-26 13:26:18 +0100 (Wed, 26 Nov 2014)

Member Enumeration Documentation

RoI word types.

Enumerator:
CPRoIWord 

This is a Run 1 EM/Tau RoI word.

EMRoIWord 

This is a Run 2 EM RoI word.

TauRoIWord 

This is a Run 2 Tau RoI word.


Member Function Documentation

void xAOD::EmTauRoI_v2::addThreshold ( const std::string &  name,
float  value 
)

Add a new threshold that was passed by the RoI.

Parameters:
name The name of the passed threshold
value The value (in MeV) of the passed threshold
void xAOD::EmTauRoI_v2::clearThresholds (  ) 

Remove all the passed thresholds from the RoI.

This function can be used to clear the thresholds that are currently held by the object.

float xAOD::EmTauRoI_v2::hadCore (  )  const

The ET deposited in the inner hadronic isolation region (2x2 core)

uint8_t xAOD::EmTauRoI_v2::isol (  )  const

The isolation result mask (from RoI word).

Get isolation results from the RoI word.

EmTauRoI_v2::RoIType xAOD::EmTauRoI_v2::roiType (  )  const

Get the type of the RoI word.

This function must be used by all analysers to check the type of the RoI before doing anything further with it. Since the way to use Run 1 and Run 2 L1Calo RoI words is quite different.

Returns:
The "type" of the RoI word in question

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 1 Dec 2017 for RootCore Packages by  doxygen 1.6.1