xAOD::EmTauRoI_v1 Class Reference

Class describing a LVL1 em/tau region of interest. More...

#include <EmTauRoI_v1.h>

Inheritance diagram for xAOD::EmTauRoI_v1:

Collaboration diagram for xAOD::EmTauRoI_v1:

Public Types
enum	RoIType { CPRoIWord = 0 , EMRoIWord = 1 , TauRoIWord = 2 }
	RoI word types. More...

Public Member Functions
	EmTauRoI_v1 ()
	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.
uint32_t	thrPattern () const
	The pattern describing which thresholds were passed by the jet.
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
	The ET deposited in the inner hadronic isolation region (2x2 core).
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.nosp@m..Hei.nosp@m.nrich.nosp@m.@cer.nosp@m.n.ch

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Alan Watson Alan..nosp@m.Wats.nosp@m.on@ce.nosp@m.rn.c.nosp@m.h

Revision

631149

Date

2014-11-26 13:26:18 +0100 (Wed, 26 Nov 2014)

Definition at line 35 of file EmTauRoI_v1.h.

Member Enumeration Documentation

RoIType

enum xAOD::EmTauRoI_v1::RoIType

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.

Definition at line 45 of file EmTauRoI_v1.h.

                   {
         CPRoIWord  = 0, 
         EMRoIWord  = 1, 
         TauRoIWord = 2  
      };

Constructor & Destructor Documentation

EmTauRoI_v1()

xAOD::EmTauRoI_v1::EmTauRoI_v1

(

)

Default constructor.

Definition at line 17 of file EmTauRoI_v1.cxx.

      : SG::AuxElement() {
 
   }

Member Function Documentation

addThreshold()

void xAOD::EmTauRoI_v1::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

Definition at line 86 of file EmTauRoI_v1.cxx.

                                                                      {
 
      names( *this ).push_back( name );
      values( *this ).push_back( value );
 
      return;
   }

clearThresholds()

void xAOD::EmTauRoI_v1::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.

Definition at line 97 of file EmTauRoI_v1.cxx.

                                     {
 
      names( *this ).clear();
      values( *this ).clear();
 
      return;
   }

core()

float xAOD::EmTauRoI_v1::core

(

)

const

The ET of the RoI Core cluster (2x2 towers, EM+Had).

emClus()

float xAOD::EmTauRoI_v1::emClus

(

)

const

The deposited E_T from the "EM cluster".

emIsol()

float xAOD::EmTauRoI_v1::emIsol

(

)

const

The EM calorimeter isolation (outer ring of EM towers).

eta()

float xAOD::EmTauRoI_v1::eta

(

)

const

The pseudorapidity ( \(\eta\)) of the em/tau candidate.

hadCore()

float xAOD::EmTauRoI_v1::hadCore

(

)

const

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

hadIsol()

float xAOD::EmTauRoI_v1::hadIsol

(

)

const

The hadron calorimeter isolation (outer ring of had towers).

initialize()

void xAOD::EmTauRoI_v1::initialize	(	uint32_t	roiword,
		float	eta,
		float	phi )

Initialise the object with its most important properties.

Definition at line 22 of file EmTauRoI_v1.cxx.

                                                                        {
 
      setRoIWord( roiword );
      setEta( eta );
      setPhi( phi );
 
      return;
   }

phi()

float xAOD::EmTauRoI_v1::phi

(

)

const

The azimuthal angle ( \(\phi\)) of the em/tau candidate.

roiType()

EmTauRoI_v1::RoIType xAOD::EmTauRoI_v1::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

Definition at line 37 of file EmTauRoI_v1.cxx.

                                                 {
 
      const uint32_t roi = roiWord();
      if( ( roi & 0xc0000000 ) == 0 ) {
         return CPRoIWord;
      } else if( ( roi & 0xf0000000 ) == 0xa0000000 ) {
         return EMRoIWord;
      } else if( ( roi & 0xf0000000 ) == 0xb0000000 ) {
         return TauRoIWord;
      }
 
      throw std::runtime_error( "xAOD::EmTauRoI_v1::roiType() "
                                "Unknown RoI word type found" );
      return static_cast< RoIType >( -1 );
   }

roiWord()

uint32_t xAOD::EmTauRoI_v1::roiWord

(

)

const

The "raw" RoI word describing the em/tau candidate.

setCore()

void xAOD::EmTauRoI_v1::setCore

(

float

value

)

Set the ET of the RoI Core cluster (2x2 towers, EM+Had).

setEmClus()

void xAOD::EmTauRoI_v1::setEmClus

(

float

value

)

Set the deposited E_T from the "EM cluster".

setEmIsol()

void xAOD::EmTauRoI_v1::setEmIsol

(

float

value

)

Set the EM calorimeter isolation (outer ring of EM towers).

setEta()

void xAOD::EmTauRoI_v1::setEta

(

float

v

)

Set the pseudorapidity of the em/tau candidate.

setHadCore()

void xAOD::EmTauRoI_v1::setHadCore

(

float

value

)

Set the E_T deposited in the inner hadronic isolation region.

setHadIsol()

void xAOD::EmTauRoI_v1::setHadIsol

(

float

value

)

Set the hadron calorimeter isolation (outer ring of had towers).

setPhi()

void xAOD::EmTauRoI_v1::setPhi

(

float

v

)

Set the azimuthal angle of the em/tau candidate.

setRoIWord()

void xAOD::EmTauRoI_v1::setRoIWord

(

uint32_t

value

)

Set the "raw" RoI word, describing the em/tau candidate.

setTauClus()

void xAOD::EmTauRoI_v1::setTauClus

(

float

value

)

Set the deposited E_T from the "tau cluster".

tauClus()

float xAOD::EmTauRoI_v1::tauClus

(

)

const

The deposited E_T from the "tau cluster".

thrNames()

const std::vector< std::string > & xAOD::EmTauRoI_v1::thrNames

(

)

const

The names of the thresholds passed by jet candidate.

thrPattern()

uint32_t xAOD::EmTauRoI_v1::thrPattern

(

)

const

The pattern describing which thresholds were passed by the jet.

thrValues()

const std::vector< float > & xAOD::EmTauRoI_v1::thrValues

(

)

const

The values of the thresholds (in MeV) passed by the jet candidate.

---

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

• EmTauRoI_v1.h
• EmTauRoI_v1.cxx