xAOD::TrigPhoton_v1 Class Reference

Class describing a photon reconstructed in the HLT. More...

#include <TrigPhoton_v1.h>

Inheritance diagram for xAOD::TrigPhoton_v1:

Collaboration diagram for xAOD::TrigPhoton_v1:

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

Public Member Functions
	TrigPhoton_v1 ()
	Default constructor.
void	init (uint32_t roi, float dphi, float deta, const EMClusterLink_t &clLink)
	Initialisation function, setting most properties of the object.
Simple photon 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	rcore () const
	Documentation to be added.
void	setRcore (float Reta)
	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 HadEt)
	Documentation to be added.
float	etHad1 () const
	Documentation to be added.
void	setEtHad1 (float HadEt)
	Documentation to be added.
float	f0 () const
	Documentation to be added.
void	setF0 (float f0)
	Documentation to be added.
float	f1 () const
	Documentation to be added.
void	setF1 (float f1)
	Documentation to be added.
float	f2 () const
	Documentation to be added.
void	setF2 (float f2)
	Documentation to be added.
float	f3 () const
	Documentation to be added.
void	setF3 (float f3)
	Documentation to be added.
float	fside () const
	Documentation to be added.
void	setFside (float fside)
	Documentation to be added.
float	weta2 () const
	Documentation to be added.
void	setWeta2 (float Weta2)
	Documentation to be added.
Four-momentum properties
void	setPt (double pt)
	Set the transverse momentum ( \(p_T\)) of the photon.
float	caloEta () const
	Pseudorapidity ( \(\eta\)) of the photon in the calorimeter.
void	setCaloEta (float caloEta)
	Set the pseudorapidity ( \(\eta\)) of the photon in the calorimeter.
float	caloPhi () const
	Azimuthal angle ( \(\phi\)) of the photon in the calorimeter.
void	setCaloPhi (float caloPhi)
	Set the azimuthal angle ( \(\phi\)) of the photon in the calorimeter.
float	dEta () const
	Documentation to be added.
void	setDEta (float dEta)
	Documentation to be added.
float	dPhi () const
	Documentation to be added.
void	setDPhi (float dPhi)
	Documentation to be added.
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.

Link(s) to constituent objects
typedef ElementLink< TrigEMClusterContainer >	EMClusterLink_t
	Type of the EM cluster 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.

Detailed Description

Class describing a photon reconstructed in the HLT.

The HLT reconstructs photons in a simplified manner before using parts of the offline software to reconstruct photons 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 38 of file TrigPhoton_v1.h.

Member Typedef Documentation

EMClusterLink_t

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

Type of the EM cluster link.

Definition at line 166 of file TrigPhoton_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::TrigPhoton_v1::GenVecFourMom_t

Base 4 Momentum type for egamma.

Definition at line 64 of file TrigPhoton_v1.h.

Constructor & Destructor Documentation

TrigPhoton_v1()

xAOD::TrigPhoton_v1::TrigPhoton_v1

(

)

Default constructor.

Definition at line 18 of file TrigPhoton_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::TrigPhoton_v1::caloEta

(

)

const

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

caloPhi()

float xAOD::TrigPhoton_v1::caloPhi

(

)

const

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

dEta()

float xAOD::TrigPhoton_v1::dEta

(

)

const

Documentation to be added.

dPhi()

float xAOD::TrigPhoton_v1::dPhi

(

)

const

Documentation to be added.

e()

double xAOD::TrigPhoton_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 36 of file TrigPhoton_v1.cxx.

                                 {
 
      return genvecP4().E();
   }

emCluster()

setRcore setEtHad setFside setPt setCaloPhi const TrigEMCluster * xAOD::TrigPhoton_v1::emCluster

(

)

const

The associated EM cluster, as a simple pointer.

This function can be used to conveniently access the EM cluster associated with the electron.

It will return a null pointer if the associated object can't be retrieved, but it will never fail in any other way.

Returns

A pointer to the associated EM cluster, or a null pointer if the object can't be found

Definition at line 133 of file TrigPhoton_v1.cxx.

                                                       {
 
      // The link accessor:
      static const Accessor< EMClusterLink_t > acc( "emClusterLink" );
 
      // Check if the link is available:
      if( ! acc.isAvailable( *this ) ) {
         return nullptr;
      }
 
      // Check if the link is valid:
      const EMClusterLink_t& link = acc( *this );
      if( ! link.isValid() ) {
         return nullptr;
      }
 
      // Return the pointer:
      return *link;
   }

emClusterLink()

const EMClusterLink_t & xAOD::TrigPhoton_v1::emClusterLink

(

)

const

The associated EM cluster, as an ElementLink.

eratio()

float xAOD::TrigPhoton_v1::eratio

(

)

const

Documentation to be added.

eta()

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

inlinevirtual

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

Implements xAOD::IParticle.

Definition at line 50 of file TrigPhoton_v1.h.

{ return caloEta(); }

etHad()

float xAOD::TrigPhoton_v1::etHad

(

)

const

Documentation to be added.

etHad1()

float xAOD::TrigPhoton_v1::etHad1

(

)

const

Documentation to be added.

f0()

float xAOD::TrigPhoton_v1::f0

(

)

const

Documentation to be added.

f1()

float xAOD::TrigPhoton_v1::f1

(

)

const

Documentation to be added.

f2()

float xAOD::TrigPhoton_v1::f2

(

)

const

Documentation to be added.

f3()

float xAOD::TrigPhoton_v1::f3

(

)

const

Documentation to be added.

fside()

float xAOD::TrigPhoton_v1::fside

(

)

const

Documentation to be added.

genvecP4()

TrigPhoton_v1::GenVecFourMom_t xAOD::TrigPhoton_v1::genvecP4

(

)

const

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

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

Definition at line 64 of file TrigPhoton_v1.cxx.

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

init()

void xAOD::TrigPhoton_v1::init	(	uint32_t	roi,
		float	dphi,
		float	deta,
		const EMClusterLink_t &	clLink )

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::TrigPhoton_v1::m ( ) const

inlinevirtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 54 of file TrigPhoton_v1.h.

{ return 0.0; }

p4()

TrigPhoton_v1::FourMom_t xAOD::TrigPhoton_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 57 of file TrigPhoton_v1.cxx.

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

phi()

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

inlinevirtual

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

Implements xAOD::IParticle.

Definition at line 52 of file TrigPhoton_v1.h.

{ return caloPhi(); }

pt()

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

virtual

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

Implements xAOD::IParticle.

rapidity()

double xAOD::TrigPhoton_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 47 of file TrigPhoton_v1.cxx.

                                        {
 
      return genvecP4().Rapidity();
   }

rcore()

float xAOD::TrigPhoton_v1::rcore

(

)

const

Documentation to be added.

roiWord()

uint32_t xAOD::TrigPhoton_v1::roiWord

(

)

const

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

setCaloEta()

void xAOD::TrigPhoton_v1::setCaloEta

(

float

caloEta

)

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

setCaloPhi()

void xAOD::TrigPhoton_v1::setCaloPhi

(

float

caloPhi

)

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

setDEta()

void xAOD::TrigPhoton_v1::setDEta

(

float

dEta

)

Documentation to be added.

setDPhi()

void xAOD::TrigPhoton_v1::setDPhi

(

float

dPhi

)

Documentation to be added.

setEmClusterLink()

void xAOD::TrigPhoton_v1::setEmClusterLink

(

const EMClusterLink_t &

value

)

Set the ElementLink pointing to the EM cluster constituent.

setEratio()

void xAOD::TrigPhoton_v1::setEratio

(

float

Eratio

)

Documentation to be added.

setEtHad()

void xAOD::TrigPhoton_v1::setEtHad

(

float

HadEt

)

Documentation to be added.

setEtHad1()

void xAOD::TrigPhoton_v1::setEtHad1

(

float

HadEt

)

Documentation to be added.

setF0()

void xAOD::TrigPhoton_v1::setF0

(

float

f0

)

Documentation to be added.

setF1()

void xAOD::TrigPhoton_v1::setF1

(

float

f1

)

Documentation to be added.

setF2()

void xAOD::TrigPhoton_v1::setF2

(

float

f2

)

Documentation to be added.

setF3()

void xAOD::TrigPhoton_v1::setF3

(

float

f3

)

Documentation to be added.

setFside()

void xAOD::TrigPhoton_v1::setFside

(

float

fside

)

Documentation to be added.

setPt()

void xAOD::TrigPhoton_v1::setPt

(

double

pt

)

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

setRcore()

void xAOD::TrigPhoton_v1::setRcore

(

float

Reta

)

Documentation to be added.

setRoiWord()

void xAOD::TrigPhoton_v1::setRoiWord

(

uint32_t

roi

)

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

setWeta2()

void xAOD::TrigPhoton_v1::setWeta2

(

float

Weta2

)

Documentation to be added.

type()

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

inlinevirtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 70 of file TrigPhoton_v1.h.

{ return Type::TrigPhoton; }

weta2()

float xAOD::TrigPhoton_v1::weta2

(

)

const

Documentation to be added.

---

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

• TrigPhoton_v1.h
• TrigPhoton_v1.cxx