xAOD::TrigElectron_v1 Class Reference

Class describing an electron reconstructed in the HLT. More...

#include <TrigElectron_v1.h>

Inheritance diagram for xAOD::TrigElectron_v1:

Collaboration diagram for xAOD::TrigElectron_v1:

Public Types
Functions describing the 4-momentum of the object
typedef TLorentzVector	FourMom_t
	Definition of the 4-momentum type.

Public Member Functions
	TrigElectron_v1 ()
	Default constructor.
void	init (uint32_t roi, float trkEtaAtCalo, float trkPhiAtCalo, float etOverPt, const EMClusterLink_t &clLink, const TrackParticleLink_t &tpLink)
	Initialisation function, setting most properties of the object.
Simple electron properties
uint32_t	roiWord () const
	Get the RoI word that seeded the reconstruction of this object.
void	setRoiWord (uint32_t roi)
	Set the RoI word that seeded the reconstruction of this object.
float	zvtx () const
	Get the Z position of the vertex that the electron is associated to.
void	setZvtx (float zVtx)
	Set the Z position of the vertex that the electron is associated to.
float	charge () const
	Get the charge of the electron.
void	setCharge (float charge)
	Set the charge of the electron.
int	nTRTHits () const
	Get the number of TRT hits that were used in the reconstruction.
void	setNTRTHits (int nTRTHits)
	Set the number of TRT hits that were used in the reconstruction.
int	nTRTHiThresholdHits () const
	Get the number of high-threshold TRT hits used in the reconstruction.
void	setNTRTHiThresholdHits (int nTRTHiThresholdHits)
	Set the number of high-threshold TRT hits used in the reconstruction.
float	rcore () const
	Documentation to be added.
void	setRcore (float rcore)
	Documentation to be added.
float	eratio () const
	Documentation to be added.
void	setEratio (float eratio)
	Documentation to be added.
float	etHad () const
	Documentation to be added.
void	setEtHad (float etHad)
	Documentation to be added.
float	etHad1 () const
	Documentation to be added.
void	setEtHad1 (float etHad1)
	Documentation to be added.
float	f0 () const
	Documentation to be added.
void	setF0 (float value)
	Documentation to be added.
float	f1 () const
	Documentation to be added.
void	setF1 (float value)
	Documentation to be added.
float	f2 () const
	Documentation to be added.
void	setF2 (float value)
	Documentation to be added.
float	f3 () const
	Documentation to be added.
void	setF3 (float value)
	Documentation to be added.
Four-momentum properties
float	trkEtaAtCalo () const
	Get the track's pseudorapidity extrapolated to the calorimeter.
void	setTrkEtaAtCalo (float trEta)
	Set the track's pseudorapidity extrapolated to the calorimeter.
float	trkPhiAtCalo () const
	Get the track's azimuthal angle extrapolated to the calorimeter.
void	setTrkPhiAtCalo (float trPhi)
	Set the track's azimuthal angle extrapolated to the calorimeter.
float	etOverPt () const
	Get \(E_T / p_T\) for the electron.
void	setEtOverPt (float etOverpt)
	Set \(E_T / p_T\) for the electron.
float	trkClusDeta () const
	The absolute value of the track-calo eta measurement difference.
float	trkClusDphi () const
	The absolute value of the track-calo phi measurement difference.
void	setPt (double pt)
	Set the transverse momentum ( \(p_T\)) of the electron.
float	caloEta () const
	Pseudorapidity ( \(\eta\)) of the electron in the calorimeter.
void	setCaloEta (float caloEta)
	Set the pseudorapidity ( \(\eta\)) of the electron in the calorimeter.
float	caloPhi () const
	Azimuthal angle ( \(\phi\)) of the electron in the calorimeter.
void	setCaloPhi (float caloPhi)
	Set the azimuthal angle ( \(\phi\)) of the electron in the calorimeter.
Functions for getting and setting user properties
template<class T>
XAOD_AUXDATA_DEPRECATED T &	auxdata (const std::string &name, const std::string &clsname="")
	Fetch an aux data variable, as a non-const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED const T &	auxdata (const std::string &name, const std::string &clsname="") const
	Fetch an aux data variable, as a const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for reading or not.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for writing or not.

Functions implementing the xAOD::IParticle interface
typedef ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > >	GenVecFourMom_t
	Base 4 Momentum type for egamma.
virtual double	pt () const
	The transverse momentum ( \(p_T\)) of the particle.
virtual double	eta () const
	The pseudorapidity ( \(\eta\)) of the particle.
virtual double	phi () const
	The azimuthal angle ( \(\phi\)) of the particle.
virtual double	m () const
	The invariant mass of the particle.
virtual double	e () const
	The total energy of the particle.
virtual double	rapidity () const
	The true rapidity (y) of the particle.
virtual FourMom_t	p4 () const
	The full 4-momentum of the particle.
GenVecFourMom_t	genvecP4 () const
	The full 4-momentum of the particle : internal egamma type.
virtual Type::ObjectType	type () const
	The type of the object as a simple enumeration.

Links to constituent objects
typedef ElementLink< TrigEMClusterContainer >	EMClusterLink_t
	Type of the EM cluster link.
typedef ElementLink< TrackParticleContainer >	TrackParticleLink_t
	The type of the track particle link.
const TrigEMCluster *	emCluster () const
	The associated EM cluster, as a simple pointer.
const EMClusterLink_t &	emClusterLink () const
	The associated EM cluster, as an ElementLink.
void	setEmClusterLink (const EMClusterLink_t &value)
	Set the ElementLink pointing to the EM cluster constituent.
const TrackParticle *	trackParticle () const
	The associated track particle, as a simple pointer.
const TrackParticleLink_t &	trackParticleLink () const
	The associated track particle, as an ElementLink.
void	setTrackParticleLink (const TrackParticleLink_t &value)
	Set the ElementLink pointing to the track particle constituent.

Detailed Description

Class describing an electron reconstructed in the HLT.

The HLT reconstructs electrons in a simplified manner before using parts of the offline software to reconstruct electrons in a manner that's very similar to what the offline reconstruction is doing.

Author

Fabrizio Salvatore Fabri.nosp@m.zio..nosp@m.Salva.nosp@m.tore.nosp@m.@cern.nosp@m..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

Revision

631115

Date

2014-11-26 09:34:25 +0100 (Wed, 26 Nov 2014)

Definition at line 40 of file TrigElectron_v1.h.

Member Typedef Documentation

EMClusterLink_t

typedef ElementLink< TrigEMClusterContainer > xAOD::TrigElectron_v1::EMClusterLink_t

Type of the EM cluster link.

Definition at line 189 of file TrigElectron_v1.h.

FourMom_t

typedef TLorentzVector xAOD::IParticle::FourMom_t

inherited

Definition of the 4-momentum type.

Definition at line 69 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

GenVecFourMom_t

typedef ROOT::Math::LorentzVector<ROOT::Math::PtEtaPhiM4D<double> > xAOD::TrigElectron_v1::GenVecFourMom_t

Base 4 Momentum type for egamma.

Definition at line 66 of file TrigElectron_v1.h.

TrackParticleLink_t

typedef ElementLink< TrackParticleContainer > xAOD::TrigElectron_v1::TrackParticleLink_t

The type of the track particle link.

Definition at line 199 of file TrigElectron_v1.h.

Constructor & Destructor Documentation

TrigElectron_v1()

xAOD::TrigElectron_v1::TrigElectron_v1

(

)

Default constructor.

The default constructor doesn't do much, it just sets up the object in a reasonable state.

Remember that an object created with this constructor is not usable yet. You either have to add it to a container, or give it a private auxiliary store before setting properties on it.

Definition at line 23 of file TrigElectron_v1.cxx.

      : IParticle() {
 
   }

Member Function Documentation

auxdata() [1/2]

template<class T>

XAOD_AUXDATA_DEPRECATED T & xAOD::IParticle::auxdata ( const std::string & name, const std::string & clsname = "" )

inlineinherited

Fetch an aux data variable, as a non-const reference.

This function provides an easy way for users to decorate objects with auxiliary data.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns

A modifiable reference to the decoration

Definition at line 98 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                {
 
         return SG::Accessor< T >(name, clsname)(*this);
      }

auxdata() [2/2]

template<class T>

XAOD_AUXDATA_DEPRECATED const T & xAOD::IParticle::auxdata ( const std::string & name, const std::string & clsname = "" ) const

inlineinherited

Fetch an aux data variable, as a const reference.

This function provides an easy way for users to retrieve auxiliary decorations from an object.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns

A constant reference to the decoration

Definition at line 118 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                            {
        
         return SG::ConstAccessor< T >( name, clsname )( *this );
      }

caloEta()

float xAOD::TrigElectron_v1::caloEta

(

)

const

Pseudorapidity ( \(\eta\)) of the electron in the calorimeter.

caloPhi()

float xAOD::TrigElectron_v1::caloPhi

(

)

const

Azimuthal angle ( \(\phi\)) of the electron in the calorimeter.

charge()

float xAOD::TrigElectron_v1::charge

(

)

const

Get the charge of the electron.

e()

double xAOD::TrigElectron_v1::e ( ) const

virtual

The total energy of the particle.

This function gets the energy of the electron using the internal TLorentzVector.

Which calculates the energy based on the eta, phi, pt, and m properties.

Returns

The energy of the electron

Implements xAOD::IParticle.

Definition at line 41 of file TrigElectron_v1.cxx.

                                   {
 
      return genvecP4().E();
   }

emCluster()

const TrigEMCluster * xAOD::TrigElectron_v1::emCluster

(

)

const

The associated EM cluster, as a simple pointer.

emClusterLink()

const EMClusterLink_t & xAOD::TrigElectron_v1::emClusterLink

(

)

const

The associated EM cluster, as an ElementLink.

eratio()

float xAOD::TrigElectron_v1::eratio

(

)

const

Documentation to be added.

eta()

virtual double xAOD::TrigElectron_v1::eta ( ) const

inlinevirtual

The pseudorapidity ( \(\eta\)) of the particle.

Implements xAOD::IParticle.

Definition at line 52 of file TrigElectron_v1.h.

{ return caloEta(); }

etHad()

float xAOD::TrigElectron_v1::etHad

(

)

const

Documentation to be added.

etHad1()

float xAOD::TrigElectron_v1::etHad1

(

)

const

Documentation to be added.

etOverPt()

float xAOD::TrigElectron_v1::etOverPt

(

)

const

Get \(E_T / p_T\) for the electron.

f0()

float xAOD::TrigElectron_v1::f0

(

)

const

Documentation to be added.

f1()

float xAOD::TrigElectron_v1::f1

(

)

const

Documentation to be added.

f2()

float xAOD::TrigElectron_v1::f2

(

)

const

Documentation to be added.

f3()

float xAOD::TrigElectron_v1::f3

(

)

const

Documentation to be added.

genvecP4()

TrigElectron_v1::GenVecFourMom_t xAOD::TrigElectron_v1::genvecP4

(

)

const

The full 4-momentum of the particle : internal egamma type.

this provides a GenVector (pt, eta, phi, m)

Definition at line 69 of file TrigElectron_v1.cxx.

                                                                  {
     return GenVecFourMom_t(pt(), eta(), phi(), m());
   } 

init()

void xAOD::TrigElectron_v1::init	(	uint32_t	roi,
		float	trkEtaAtCalo,
		float	trkPhiAtCalo,
		float	etOverPt,
		const EMClusterLink_t &	clLink,
		const TrackParticleLink_t &	tpLink )

Initialisation function, setting most properties of the object.

isAvailable()

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailable ( const std::string & name, const std::string & clsname = "" ) const

inlineinherited

Check if a user property is available for reading or not.

This function should be used to check if a user property which may or may not exist, is set on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns

Whether the decoration exists or not

Definition at line 135 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                            {
 
         return SG::ConstAccessor< T >(name, clsname).isAvailable(*this);
      }

isAvailableWritable()

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailableWritable ( const std::string & name, const std::string & clsname = "" ) const

inlineinherited

Check if a user property is available for writing or not.

This function can be used to check whether it will be possible to set a user property on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns

Whether the decoration is possible to set

Definition at line 152 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                                    {
 
         return SG::Accessor< T >(name, clsname).isAvailableWritable(*this);
      }

m()

virtual double xAOD::TrigElectron_v1::m ( ) const

inlinevirtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 56 of file TrigElectron_v1.h.

{ return ParticleConstants::electronMassInMeV; }

nTRTHiThresholdHits()

int xAOD::TrigElectron_v1::nTRTHiThresholdHits

(

)

const

Get the number of high-threshold TRT hits used in the reconstruction.

nTRTHits()

int xAOD::TrigElectron_v1::nTRTHits

(

)

const

Get the number of TRT hits that were used in the reconstruction.

p4()

TrigElectron_v1::FourMom_t xAOD::TrigElectron_v1::p4 ( ) const

virtual

The full 4-momentum of the particle.

This function provides the 4-momentum of the object as a TLorentzVector.

Returns

The full 4-momentum of the electron

Implements xAOD::IParticle.

Definition at line 62 of file TrigElectron_v1.cxx.

                                                      {
     FourMom_t p4;
     p4.SetPtEtaPhiM( pt(), eta(), phi(),m()); 
     return p4; 
   }

phi()

virtual double xAOD::TrigElectron_v1::phi ( ) const

inlinevirtual

The azimuthal angle ( \(\phi\)) of the particle.

Implements xAOD::IParticle.

Definition at line 54 of file TrigElectron_v1.h.

{ return caloPhi(); }

pt()

virtual double xAOD::TrigElectron_v1::pt ( ) const

virtual

The transverse momentum ( \(p_T\)) of the particle.

Implements xAOD::IParticle.

rapidity()

double xAOD::TrigElectron_v1::rapidity ( ) const

virtual

The true rapidity (y) of the particle.

This function gets the rapidity of the electron using the internal TLorentzVector.

Which calculates the rapidity based on the eta, phi, pt, and m properties.

Returns

The rapidity (y) of the electron

Implements xAOD::IParticle.

Definition at line 52 of file TrigElectron_v1.cxx.

                                          {
 
      return genvecP4().Rapidity();
   }

rcore()

float xAOD::TrigElectron_v1::rcore

(

)

const

Documentation to be added.

roiWord()

uint32_t xAOD::TrigElectron_v1::roiWord

(

)

const

Get the RoI word that seeded the reconstruction of this object.

setCaloEta()

void xAOD::TrigElectron_v1::setCaloEta

(

float

caloEta

)

Set the pseudorapidity ( \(\eta\)) of the electron in the calorimeter.

setCaloPhi()

void xAOD::TrigElectron_v1::setCaloPhi

(

float

caloPhi

)

Set the azimuthal angle ( \(\phi\)) of the electron in the calorimeter.

setCharge()

void xAOD::TrigElectron_v1::setCharge

(

float

charge

)

Set the charge of the electron.

setEmClusterLink()

void xAOD::TrigElectron_v1::setEmClusterLink

(

const EMClusterLink_t &

value

)

Set the ElementLink pointing to the EM cluster constituent.

setEratio()

void xAOD::TrigElectron_v1::setEratio

(

float

eratio

)

Documentation to be added.

setEtHad()

void xAOD::TrigElectron_v1::setEtHad

(

float

etHad

)

Documentation to be added.

setEtHad1()

void xAOD::TrigElectron_v1::setEtHad1

(

float

etHad1

)

Documentation to be added.

setEtOverPt()

void xAOD::TrigElectron_v1::setEtOverPt

(

float

etOverpt

)

Set \(E_T / p_T\) for the electron.

setF0()

void xAOD::TrigElectron_v1::setF0

(

float

value

)

Documentation to be added.

setF1()

void xAOD::TrigElectron_v1::setF1

(

float

value

)

Documentation to be added.

setF2()

void xAOD::TrigElectron_v1::setF2

(

float

value

)

Documentation to be added.

setF3()

void xAOD::TrigElectron_v1::setF3

(

float

value

)

Documentation to be added.

setNTRTHiThresholdHits()

void xAOD::TrigElectron_v1::setNTRTHiThresholdHits

(

int

nTRTHiThresholdHits

)

Set the number of high-threshold TRT hits used in the reconstruction.

setNTRTHits()

void xAOD::TrigElectron_v1::setNTRTHits

(

int

nTRTHits

)

Set the number of TRT hits that were used in the reconstruction.

setPt()

void xAOD::TrigElectron_v1::setPt

(

double

pt

)

Set the transverse momentum ( \(p_T\)) of the electron.

setRcore()

void xAOD::TrigElectron_v1::setRcore

(

float

rcore

)

Documentation to be added.

setRoiWord()

void xAOD::TrigElectron_v1::setRoiWord

(

uint32_t

roi

)

Set the RoI word that seeded the reconstruction of this object.

setTrackParticleLink()

void xAOD::TrigElectron_v1::setTrackParticleLink

(

const TrackParticleLink_t &

value

)

Set the ElementLink pointing to the track particle constituent.

setTrkEtaAtCalo()

void xAOD::TrigElectron_v1::setTrkEtaAtCalo

(

float

trEta

)

Set the track's pseudorapidity extrapolated to the calorimeter.

setTrkPhiAtCalo()

void xAOD::TrigElectron_v1::setTrkPhiAtCalo

(

float

trPhi

)

Set the track's azimuthal angle extrapolated to the calorimeter.

setZvtx()

void xAOD::TrigElectron_v1::setZvtx

(

float

zVtx

)

Set the Z position of the vertex that the electron is associated to.

trackParticle()

const TrackParticle * xAOD::TrigElectron_v1::trackParticle

(

)

const

The associated track particle, as a simple pointer.

trackParticleLink()

const TrackParticleLink_t & xAOD::TrigElectron_v1::trackParticleLink

(

)

const

The associated track particle, as an ElementLink.

trkClusDeta()

float xAOD::TrigElectron_v1::trkClusDeta

(

)

const

The absolute value of the track-calo eta measurement difference.

trkClusDphi()

float xAOD::TrigElectron_v1::trkClusDphi

(

)

const

The absolute value of the track-calo phi measurement difference.

trkEtaAtCalo()

float xAOD::TrigElectron_v1::trkEtaAtCalo

(

)

const

Get the track's pseudorapidity extrapolated to the calorimeter.

trkPhiAtCalo()

float xAOD::TrigElectron_v1::trkPhiAtCalo

(

)

const

Get the track's azimuthal angle extrapolated to the calorimeter.

type()

virtual Type::ObjectType xAOD::TrigElectron_v1::type ( ) const

inlinevirtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 72 of file TrigElectron_v1.h.

{ return Type::TrigElectron; }

zvtx()

float xAOD::TrigElectron_v1::zvtx

(

)

const

Get the Z position of the vertex that the electron is associated to.

---

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

• TrigElectron_v1.h
• TrigElectron_v1.cxx