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
using	TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

template<class T , class ALLOC = AuxAllocator_t<T>>
using	ConstAccessor = SG::ConstAccessor< T, ALLOC >

template<class T , class ALLOC = AuxAllocator_t<T>>
using	Accessor = SG::Accessor< T, ALLOC >

template<class T , class ALLOC = AuxAllocator_t<T>>
using	Decorator = SG::Decorator< T, ALLOC >

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

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

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

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

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

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

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

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

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

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

Public Member Functions
	TrigPhoton_v1 ()
	Default constructor. More...

void	init (uint32_t roi, float dphi, float deta, const EMClusterLink_t &clLink)
	Initialisation function, setting most properties of the object. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name)
	Fetch an aux data variable, as a non-const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="")
	Check if an aux variable is available for writing. More...

const SG::AuxVectorData *	container () const
	Return the container holding this element. More...

SG::AuxVectorData *	container ()
	Return the container holding this element. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for writing as a decoration. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name) const
	Fetch an aux decoration, as a non-const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name, const std::string &clsname) const
	Fetch an aux decoration, as a non-const reference. More...

void	makePrivateStore ()
	Create a new (empty) private store for this object. More...

template<class U1 >
void	makePrivateStore (const U1 &other)
	Create a new private store for this object and copy aux data. More...

template<class U1 >
void	makePrivateStore (const U1 *other)
	Create a new private store for this object and copy aux data. More...

void	releasePrivateStore ()
	Release and free any private store associated with this object. More...

void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...

void	setStore (SG::IAuxStore *store)
	Set the store associated with this object. More...

void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object. More...

void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for `setStore` with `IConstAuxStore`. More...

void	setNonConstStore (SG::IAuxStore *store)
	Synonym for `setStore` with `IAuxStore`. More...

bool	usingPrivateStore () const
	Test to see if this object is currently using a private store. More...

bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store. More...

const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface. More...

SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface. More...

void	clearCache ()
	Clear the cached aux data pointers. More...

const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object. More...

bool	hasStore () const
	Return true if this object has an associated store. More...

bool	hasNonConstStore () const
	Return true if this object has an associated non-const store. More...

bool	clearDecorations () const
	Clear all decorations. More...

bool	trackIndices () const
	Return true if index tracking is enabled for this object. More...

size_t	index () const
	Return the index of this element within its container. More...

size_t	index () const
	Return the index of this element within its container. More...

Simple photon properties
uint32_t	roiWord () const
	Get the RoI word that seeded the reconstruction of this object. More...

void	setRoiWord (uint32_t roi)
	Set the RoI word that seeded the reconstruction of this object. More...

float	rcore () const
	Documentation to be added. More...

void	setRcore (float Reta)
	Documentation to be added. More...

float	eratio () const
	Documentation to be added. More...

void	setEratio (float Eratio)
	Documentation to be added. More...

float	etHad () const
	Documentation to be added. More...

void	setEtHad (float HadEt)
	Documentation to be added. More...

float	etHad1 () const
	Documentation to be added. More...

void	setEtHad1 (float HadEt)
	Documentation to be added. More...

float	f0 () const
	Documentation to be added. More...

void	setF0 (float f0)
	Documentation to be added. More...

float	f1 () const
	Documentation to be added. More...

void	setF1 (float f1)
	Documentation to be added. More...

float	f2 () const
	Documentation to be added. More...

void	setF2 (float f2)
	Documentation to be added. More...

float	f3 () const
	Documentation to be added. More...

void	setF3 (float f3)
	Documentation to be added. More...

float	fside () const
	Documentation to be added. More...

void	setFside (float fside)
	Documentation to be added. More...

float	weta2 () const
	Documentation to be added. More...

void	setWeta2 (float Weta2)
	Documentation to be added. More...

Four-momentum properties
void	setPt (double pt)
	Set the transverse momentum ( \(p_T\)) of the photon. More...

float	caloEta () const
	Pseudorapidity ( \(\eta\)) of the photon in the calorimeter. More...

void	setCaloEta (float caloEta)
	Set the pseudorapidity ( \(\eta\)) of the photon in the calorimeter. More...

float	caloPhi () const
	Azimuthal angle ( \(\phi\)) of the photon in the calorimeter. More...

void	setCaloPhi (float caloPhi)
	Set the azimuthal angle ( \(\phi\)) of the photon in the calorimeter. More...

float	dEta () const
	Documentation to be added. More...

void	setDEta (float dEta)
	Documentation to be added. More...

float	dPhi () const
	Documentation to be added. More...

void	setDPhi (float dPhi)
	Documentation to be added. More...

Static Public Attributes
static constexpr bool	supportsThinning = true
	Mark that this type supports thinning operations. More...

Protected Member Functions
bool	noPrivateData () const
	True if this element has no private data. More...

bool	havePrivateData () const
	True if this element currently has private data. More...

bool	hadPrivateData () const
	True if this element had private data before it was added to its current container. More...

Private Types
enum	PrivateStoreState : uint8_t { PrivateStoreState::NO_PRIVATE = 0, PrivateStoreState::HAVE_PRIVATE = 1, PrivateStoreState::HAD_PRIVATE = 2 }
	The current private data state. More...

Private Member Functions
void	releasePrivateStoreForDtor ()
	Out-of-line portion of destructor. More...

void	setIndex (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...

bool	setIndexPrivate (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...

void	makePrivateStore1 (const void *)
	Create a new private store for this object and copy aux data. More...

void	makePrivateStore1 (const AuxElement *other)
	Create a new private store for this object and copy aux data. More...

AuxElementStandaloneData *	setStore1 (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...

void	clearAux ()
	Clear all aux data associated with this element. More...

void	copyAux (const ConstAuxElement &other)
	Copy aux data from another object. More...

void	setNoPrivateData ()
	Record that this element does not have private data. More...

void	setHavePrivateData ()
	Record that this element currently has private data. More...

void	setHadPrivateData ()
	Record that this element used to have private data. More...

Private Attributes
const SG::AuxVectorData *	m_container
	The container of which this object is an element. More...

size_t	m_index
	The index of this element within its container. More...

PrivateStoreState	m_privateStoreState

Functions implementing the xAOD::IParticle interface
typedef ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > >	GenVecFourMom_t
	Base 4 Momentum type for egamma. More...

virtual double	pt () const
	The transverse momentum ( \(p_T\)) of the particle. More...

virtual double	eta () const
	The pseudorapidity ( \(\eta\)) of the particle. More...

virtual double	phi () const
	The azimuthal angle ( \(\phi\)) of the particle. More...

virtual double	m () const
	The invariant mass of the particle. More...

virtual double	e () const
	The total energy of the particle. More...

virtual double	rapidity () const
	The true rapidity (y) of the particle. More...

virtual FourMom_t	p4 () const
	The full 4-momentum of the particle. More...

GenVecFourMom_t	genvecP4 () const
	The full 4-momentum of the particle : internal egamma type. More...

virtual Type::ObjectType	type () const
	The type of the object as a simple enumeration. More...

Link(s) to constituent objects
typedef ElementLink< TrigEMClusterContainer >	EMClusterLink_t
	Type of the EM cluster link. More...

const TrigEMCluster *	emCluster () const
	The associated EM cluster, as a simple pointer. More...

const EMClusterLink_t &	emClusterLink () const
	The associated EM cluster, as an ElementLink. More...

void	setEmClusterLink (const EMClusterLink_t &value)
	Set the ElementLink pointing to the EM cluster constituent. More...

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

◆ Accessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Accessor = SG::Accessor<T, ALLOC>

inherited

Definition at line 548 of file AuxElement.h.

◆ ConstAccessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::ConstAccessor = SG::ConstAccessor<T, ALLOC>

inherited

Definition at line 545 of file AuxElement.h.

◆ Decorator

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Decorator = SG::Decorator<T, ALLOC>

inherited

Definition at line 551 of file AuxElement.h.

◆ 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.

◆ TypelessConstAccessor

using SG::AuxElement::TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

inherited

Definition at line 542 of file AuxElement.h.

Member Enumeration Documentation

◆ PrivateStoreState

enum SG::IAuxElement::PrivateStoreState : uint8_t

strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE
HAVE_PRIVATE
HAD_PRIVATE

Definition at line 131 of file IAuxElement.h.

   {
     NO_PRIVATE = 0,
     HAVE_PRIVATE = 1,
     HAD_PRIVATE = 2,
   };

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/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata ( const std::string & name )

inherited

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

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ auxdata() [2/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

◆ auxdata() [3/4]

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() [4/4]

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 );
       }

◆ auxdataConst() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

◆ auxdataConst() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst	(	const std::string &	name,
		const std::string &	clsname
	)		const

inherited

Fetch an aux data variable, as a const reference.

Parameters

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

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

◆ auxdecor() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string & name ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

◆ auxdecor() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor	(	const std::string &	name,
		const std::string &	clsname
	)		const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

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

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

◆ 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.

◆ clearAux()

void SG::AuxElement::clearAux ( )

privateinherited

Clear all aux data associated with this element.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 535 of file AuxElement.cxx.

 {
   if (!m_container) return;
   if (!m_container->hasStore()) return;
   if (!m_container->hasNonConstStore())
     throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
   for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
     r.clear (auxid, *container(), index(), 1);
   }
 }

◆ clearCache()

void SG::AuxElement::clearCache ( )

inherited

Clear the cached aux data pointers.

You should call this any time something changes in the aux store that could invalidate the vector pointers.

Definition at line 319 of file AuxElement.cxx.

 {
   if (container())
     container()->clearCache();
 }

◆ clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

inherited

Clear all decorations.

Erase all decorations from an associated store, restoring the state to when lock was called.

Returns true if there were any decorations that were cleared, false if the store did not contain any decorations.

Definition at line 385 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->clearDecorations();
   return false;
 }

◆ container() [1/2]

SG::AuxVectorData* SG::AuxElement::container ( )

inherited

Return the container holding this element.

◆ container() [2/2]

const SG::AuxVectorData* SG::AuxElement::container ( ) const

inherited

Return the container holding this element.

◆ copyAux()

void SG::AuxElement::copyAux ( const ConstAuxElement & other )

privateinherited

Copy aux data from another object.

Parameters

other The object from which to copy.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)

Definition at line 561 of file AuxElement.cxx.

 {
   if (!m_container) return;
   if (!m_container->hasStore()) return;
   if (!m_container->hasNonConstStore())
     throw SG::ExcConstAuxData ("copyAux");
  
   const SG::AuxVectorData* ocont = other.container();
  
   if (!ocont || !ocont->hasStore()) {
     this->clearAux();
     return;
   }
  
   size_t oindex = other.index();
   SG::auxid_set_t other_ids = ocont->getAuxIDs();
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  
   SG::AuxVectorData& cont = *container();
   for (SG::auxid_t auxid : other_ids) {
     if (!r.isLinked (auxid)) {
       r.copy (auxid, cont, index(), *ocont, oindex, 1);
     }
   }
  
   for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
     if (!other_ids.test (auxid)) {
       r.clear (auxid, cont, index(), 1);
     }
   }
 }

◆ 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.

50 { 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());
    } 

◆ getAuxIDs()

const SG::auxid_set_t & SG::AuxElement::getAuxIDs ( ) const

inherited

Return a set of identifiers for existing data items for this object.

If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.

Definition at line 335 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (havePrivateData())
     return m_container->getConstStore()->getAuxIDs();
   if (container())
     return container()->getAuxIDs();
   static const SG::auxid_set_t null_set;
   return null_set;
 #else
   return ConstAuxElement::getAuxIDs();
 #endif
 }

◆ getConstStore()

const SG::IConstAuxStore * SG::AuxElement::getConstStore ( ) const

inherited

Return the current store, as a const interface.

This will be non-zero if either a const or non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 284 of file AuxElement.cxx.

 {
   if (havePrivateData()) {
     return m_container->getConstStore();
   }
   return 0;
 }

◆ getStore()

SG::IAuxStore * SG::AuxElement::getStore ( ) const

inherited

Return the current store, as a non-const interface.

This will be non-zero if a non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 299 of file AuxElement.cxx.

 {
   if (havePrivateData()) {
 #ifdef ATHCONTAINERS_R21_COMPAT
     SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = m_container;
 #else
     SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
 #endif
     return container_nc->getStore();
   }
   return 0;
 }

◆ hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

True if this element had private data before it was added to its current container.

◆ hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

Return true if this object has an associated non-const store.

This will be true for either a private or standalone store.

Definition at line 368 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->hasNonConstStore();
   return false;
 }

◆ hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

This will be true for either a private or standalone store.

Definition at line 355 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->hasStore();
   return false;
 }

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

◆ index() [1/2]

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

◆ index() [2/2]

size_t SG::IAuxElement::index

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

◆ 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() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritable	(	const std::string &	name,
		const std::string &	clsname = `""`
	)

inherited

Check if an aux variable is available for writing.

Parameters

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

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ isAvailableWritable() [2/2]

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);
       }

◆ isAvailableWritableAsDecoration()

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritableAsDecoration	(	const std::string &	name,
		const std::string &	clsname = `""`
	)		const

inherited

Check if an aux variable is available for writing as a decoration.

Parameters

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

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ 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.

54 { return 0.0; }

◆ makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )

inherited

Create a new (empty) private store for this object.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

Definition at line 172 of file AuxElement.cxx.

 {
   if (m_container) {
     throw SG::ExcBadPrivateStore ("store already exists");
   }
  
   m_container = new SG::AuxElementPrivateData;
   IAuxElement::setIndex (0);
   IAuxElement::setHavePrivateData();
 }

◆ makePrivateStore() [2/3]

template<class U1 >

void SG::AuxElement::makePrivateStore ( const U1 & other )

inherited

Create a new private store for this object and copy aux data.

Parameters

other The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

◆ makePrivateStore() [3/3]

template<class U1 >

void SG::AuxElement::makePrivateStore ( const U1 * other )

inherited

Create a new private store for this object and copy aux data.

Parameters

other The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

◆ makePrivateStore1() [1/2]

void SG::AuxElement::makePrivateStore1 ( const AuxElement * other )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does have aux data.

Definition at line 521 of file AuxElement.cxx.

 {
   makePrivateStore();
   if (other)
     this->copyAux (*other);
 }

◆ makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1 ( const void * )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does not have aux data.

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ 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.

52 { 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.

◆ releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )

inherited

Release and free any private store associated with this object.

ExcBadPrivateStore will be thrown if this object does not have a private store.

Definition at line 190 of file AuxElement.cxx.

 {
   if (hadPrivateData()) {
     // We had a private store, but it was released because this object
     // was added to a container.  Just forget about it.
     IAuxElement::setNoPrivateData();
     return;
   }
  
   if (!havePrivateData() ||
       !m_container ||
       typeid(*m_container) != typeid(AuxElementPrivateData))
   {
     throw SG::ExcBadPrivateStore ("no private store exists");
   }
  
   IAuxElement::setIndex (0);
   IAuxElement::setNoPrivateData();
   delete m_container;
   m_container = 0;
 }

◆ releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )

privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 398 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (havePrivateData()) {
     delete m_container;
   }
 #else
   ConstAuxElement::releasePrivateStoreForDtor();
 #endif
 }

◆ 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.

◆ setConstStore()

void SG::AuxElement::setConstStore ( const SG::IConstAuxStore * store )

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ 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.

◆ setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

◆ setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

◆ setIndex()

void SG::AuxElement::setIndex	(	size_t	index,
		SG::AuxVectorData *	container
	)

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

Usually this simply sets the index and container members of this object. However, in the case where this object has an associated private store, then we need to deal with releasing the store if the object is being added to a container, or making a new store if the object is being removed from a container.

◆ setIndexPrivate()

bool SG::AuxElement::setIndexPrivate	(	size_t	index,
		SG::AuxVectorData *	container
	)

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

This is called from setIndex when we have a private store to deal with.

Definition at line 462 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (hadPrivateData()) {
     // We had a private store, but it was released because we were added
     // to a container.
  
     if (container == 0) {
       // We're being moved out of the container.  Make a new private
       // store, copy the data, and switch to it.
       auto privateData = new SG::AuxElementPrivateData;
       AuxElement to (privateData, 0);
       to.copyAux (*this);
       IAuxElement::setIndex (0);
       IAuxElement::setHavePrivateData();
       m_container = privateData;
       return true;
     }
   }
   else if (havePrivateData() &&
            typeid(*m_container) == typeid(AuxElementPrivateData))
   {
     // We currently have a private store.
  
     if (container != 0 && container != m_container) {
       // We're being added to a container.
       // Aux data has already been copied.
       // Release private store.
       IAuxElement::setIndex (index);
       IAuxElement::setHadPrivateData();
       delete m_container;
       m_container = container;
       return false;
     }
   }
   else {
     // We have a standalone store.
     throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
                                   "from a container.");
   }
  
   IAuxElement::setIndex (index);
   m_container = container;
   return false;
 #else
   return ConstAuxElement::setIndexPrivate (index, container);
 #endif
 }

◆ setNonConstStore()

void SG::AuxElement::setNonConstStore ( SG::IAuxStore * store )

inherited

Synonym for setStore with IAuxStore.

Parameters

store The new store.

◆ setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )

privateinherited

Record that this element does not have private data.

◆ 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.

◆ setStore() [1/3]

void SG::AuxElement::setStore ( const DataLink< SG::IConstAuxStore > & store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Parameters

store Link to the new store.

Definition at line 249 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore() [2/3]

void SG::AuxElement::setStore ( const SG::IConstAuxStore * store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 221 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore() [3/3]

void SG::AuxElement::setStore ( SG::IAuxStore * store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 237 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore1()

AuxElementStandaloneData * SG::AuxElement::setStore1 ( const SG::IConstAuxStore * store )

privateinherited

Set the store associated with this object.

Parameters

store The new store.

Helper for setStore. Creates the AuxElementStandaloneData object if needed and returns it.

Parameters

store The new store.

Helper for setStore. Creates the @x AuxElementStandaloneData object if needed and returns it.

Definition at line 418 of file AuxElement.cxx.

 {
   if (store) {
     // Want this object be standalone.
     if (!m_container) {
       // Not in a container (and no private store).  Make a new object.
       AuxElementStandaloneData* data = new AuxElementStandaloneData;
       IAuxElement::setHavePrivateData();
       m_container = data;
       return data;
     }
     if (usingStandaloneStore()) {
       // Standalone --- return existing object.
       return static_cast<AuxElementStandaloneData*> (container());
     }
     // Otherwise, it's an error.
     throw ExcBadPrivateStore ("Attempt to attach a standalone store to an "
                               "object in a container or with a private store.");
   }
  
   else {
     // Getting rid of a standalone store.
     if (usingStandaloneStore()) {
       IAuxElement::setNoPrivateData();
       delete m_container;
       m_container = 0;
     }
     else if (m_container != 0)
       throw ExcBadPrivateStore ("Attempt to remove a standalone store from an "
                                 "object in a container or with a private store.");
     return 0;
   }
 }

◆ setWeta2()

void xAOD::TrigPhoton_v1::setWeta2 ( float Weta2 )

Documentation to be added.

◆ trackIndices()

bool SG::AuxElement::trackIndices ( ) const

inherited

Return true if index tracking is enabled for this object.

Always returns true. Included here to be consistent with AuxVectorBase when standalone objects may be used as template parameters.

◆ 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.

70 { return Type::TrigPhoton; }

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

Test to see if this object is currently using a private store.

Definition at line 260 of file AuxElement.cxx.

 {
   return havePrivateData() && 
     typeid(*m_container) == typeid(AuxElementPrivateData);
 }

◆ usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

inherited

Test to see if this object is currently using a standalone store.

Test to see if this object is currently using a private store.

Definition at line 270 of file AuxElement.cxx.

 {
   return havePrivateData() &&
     typeid(*m_container) == typeid(AuxElementStandaloneData);
 }

◆ weta2()

float xAOD::TrigPhoton_v1::weta2 ( ) const

Documentation to be added.

Member Data Documentation

◆ m_container

const SG::AuxVectorData* SG::ConstAuxElement::m_container

privateinherited

The container of which this object is an element.

Should be null if this object is not within a container, except that it may also point at a private store.

Definition at line 324 of file AuxElement.h.

◆ m_index

size_t SG::IAuxElement::m_index

privateinherited

The index of this element within its container.

Should be 0 if this object is not within a container.

Definition at line 128 of file IAuxElement.h.

◆ m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState

privateinherited

Definition at line 137 of file IAuxElement.h.

◆ supportsThinning

constexpr bool SG::AuxElement::supportsThinning = true

staticconstexprinherited

Mark that this type supports thinning operations.

See AthContainers/supportsThinning.h and AthenaPoolCnvSvc/T_AthenaPoolCnv.h. Helps guide which pool converter template will be used. If false, the default pool converter will be used rather than the aux store-specific one. Ordinary xAOD type should not touch this, but may be overridden in a derived class to handle certain special cases.

Definition at line 920 of file AuxElement.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Functions implementing the xAOD::IParticle interface

Link(s) to constituent objects

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ Decorator

◆ EMClusterLink_t

◆ FourMom_t

◆ GenVecFourMom_t

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ TrigPhoton_v1()

Member Function Documentation

◆ auxdata() [1/4]

◆ auxdata() [2/4]

◆ auxdata() [3/4]

◆ auxdata() [4/4]

◆ auxdataConst() [1/2]

◆ auxdataConst() [2/2]

◆ auxdecor() [1/2]

◆ auxdecor() [2/2]

◆ caloEta()

◆ caloPhi()

◆ clearAux()

◆ clearCache()

◆ clearDecorations()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ dEta()

◆ dPhi()

◆ e()

◆ emCluster()

◆ emClusterLink()

◆ eratio()

◆ eta()

◆ etHad()

◆ etHad1()

◆ f0()

◆ f1()

◆ f2()

◆ f3()

◆ fside()

◆ genvecP4()

◆ getAuxIDs()

◆ getConstStore()

◆ getStore()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ havePrivateData()

◆ index() [1/2]

◆ index() [2/2]

◆ init()

◆ isAvailable()

◆ isAvailableWritable() [1/2]

◆ isAvailableWritable() [2/2]

◆ isAvailableWritableAsDecoration()

◆ m()

◆ makePrivateStore() [1/3]

◆ makePrivateStore() [2/3]

◆ makePrivateStore() [3/3]

◆ makePrivateStore1() [1/2]

◆ makePrivateStore1() [2/2]

◆ noPrivateData()

◆ p4()

◆ phi()

◆ pt()

◆ rapidity()

◆ rcore()