xAOD::JetRoI_v1 Class Reference

Class describing a LVL1 jet region of interest. More...

#include <JetRoI_v1.h>

Inheritance diagram for xAOD::JetRoI_v1:

Collaboration diagram for xAOD::JetRoI_v1:

Public Member Functions
	JetRoI_v1 ()
	Default constructor.
void	initialize (uint32_t roiword, float eta, float phi)
	Initialise the object with its most important properties.
float	eta () const
	The pseudorapidity ( \(\eta\)) of the jet candidate.
void	setEta (float v)
	Set the pseudorapidity of the jet candidate.
float	phi () const
	The azimuthal angle ( \(\phi\)) of the jet candidate.
void	setPhi (float v)
	Set the azimuthal angle of the jet candidate.
uint32_t	roiWord () const
	The "raw" RoI word describing the jet candidate.
void	setRoIWord (uint32_t value)
	Set the "raw" RoI word, describing the jet candidate.
uint32_t	thrPattern () const
	The pattern describing which thresholds were passed by the jet.
Energies deposited in various areas around the RoI
float	et4x4 () const
	The energy deposited in a 0.4x0.4 area around the RoI.
void	setEt4x4 (float value)
	Set the energy deposited in a 0.4x0.4 area around the RoI.
float	et6x6 () const
	The energy deposited in a 0.6x0.6 area around the RoI.
void	setEt6x6 (float value)
	Set the energy deposited in a 0.6x0.6 area around the RoI.
float	et8x8 () const
	The energy deposited in a 0.8x0.8 area around the RoI.
void	setEt8x8 (float value)
	Set the energy deposited in a 0.8x0.8 area around the RoI.
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 jet region of interest.

This class describes the properties of a jet 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 JetRoI_v1.h.

Constructor & Destructor Documentation

JetRoI_v1()

xAOD::JetRoI_v1::JetRoI_v1

(

)

Default constructor.

Definition at line 14 of file JetRoI_v1.cxx.

      : SG::AuxElement() {
 
   }

Member Function Documentation

addThreshold()

void xAOD::JetRoI_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 55 of file JetRoI_v1.cxx.

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

clearThresholds()

void xAOD::JetRoI_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 66 of file JetRoI_v1.cxx.

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

et4x4()

float xAOD::JetRoI_v1::et4x4

(

)

const

The energy deposited in a 0.4x0.4 area around the RoI.

et6x6()

float xAOD::JetRoI_v1::et6x6

(

)

const

The energy deposited in a 0.6x0.6 area around the RoI.

et8x8()

float xAOD::JetRoI_v1::et8x8

(

)

const

The energy deposited in a 0.8x0.8 area around the RoI.

eta()

float xAOD::JetRoI_v1::eta

(

)

const

The pseudorapidity ( \(\eta\)) of the jet candidate.

initialize()

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

Initialise the object with its most important properties.

Definition at line 19 of file JetRoI_v1.cxx.

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

phi()

float xAOD::JetRoI_v1::phi

(

)

const

The azimuthal angle ( \(\phi\)) of the jet candidate.

roiWord()

uint32_t xAOD::JetRoI_v1::roiWord

(

)

const

The "raw" RoI word describing the jet candidate.

setEt4x4()

void xAOD::JetRoI_v1::setEt4x4

(

float

value

)

Set the energy deposited in a 0.4x0.4 area around the RoI.

setEt6x6()

void xAOD::JetRoI_v1::setEt6x6

(

float

value

)

Set the energy deposited in a 0.6x0.6 area around the RoI.

setEt8x8()

void xAOD::JetRoI_v1::setEt8x8

(

float

value

)

Set the energy deposited in a 0.8x0.8 area around the RoI.

setEta()

void xAOD::JetRoI_v1::setEta

(

float

v

)

Set the pseudorapidity of the jet candidate.

setPhi()

void xAOD::JetRoI_v1::setPhi

(

float

v

)

Set the azimuthal angle of the jet candidate.

setRoIWord()

void xAOD::JetRoI_v1::setRoIWord

(

uint32_t

value

)

Set the "raw" RoI word, describing the jet candidate.

thrNames()

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

(

)

const

The names of the thresholds passed by jet candidate.

thrPattern()

uint32_t xAOD::JetRoI_v1::thrPattern

(

)

const

The pattern describing which thresholds were passed by the jet.

thrValues()

const std::vector< float > & xAOD::JetRoI_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:

• JetRoI_v1.h
• JetRoI_v1.cxx