ATLAS Offline Software
Loading...
Searching...
No Matches
xAOD::Photon_v1 Class Reference

#include <Photon_v1.h>

Inheritance diagram for xAOD::Photon_v1:
Collaboration diagram for xAOD::Photon_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 Decorator = SG::Decorator<T, ALLOC>

Public Member Functions

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.
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.
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.
void assign (const AuxElement &other, bool warnUnlocked=false)
 Assignment.
const SG::AuxVectorDatacontainer () const
 Return the container holding this element.
SG::AuxVectorDatacontainer ()
 Return the container holding this element.
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.
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.
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.
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.
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.
void makePrivateStore ()
 Create a new (empty) private store for this object.
template<class U1>
void makePrivateStore (const U1 &other, bool warnUnlocked=false)
 Create a new private store for this object and copy aux data.
template<class U1>
void makePrivateStore (const U1 *other, bool warnUnlocked=false)
 Create a new private store for this object and copy aux data.
void releasePrivateStore ()
 Release and free any private store associated with this object.
void setStore (const SG::IConstAuxStore *store)
 Set the store associated with this object.
void setStore (SG::IAuxStore *store)
 Set the store associated with this object.
void setStore (const DataLink< SG::IConstAuxStore > &store)
 Set the store associated with this object.
void setConstStore (const SG::IConstAuxStore *store)
 Synonym for setStore with IConstAuxStore.
void setNonConstStore (SG::IAuxStore *store)
 Synonym for setStore with IAuxStore.
bool usingPrivateStore () const
 Test to see if this object is currently using a private store.
bool usingStandaloneStore () const
 Test to see if this object is currently using a standalone store.
void clearCache ()
 Clear the cached aux data pointers.
const SG::auxid_set_tgetAuxIDs () const
 Return a set of identifiers for existing data items for this object.
const SG::auxid_set_tgetDecorIDs () const
 Return a set of identifiers for decorations for this object.
bool hasStore () const
 Return true if this object has an associated store.
bool hasNonConstStore () const
 Return true if this object has an associated non-const store.
bool clearDecorations () const
 Clear all decorations.
bool trackIndices () const
 Return true if index tracking is enabled for this object.
size_t index () const
 Return the index of this element within its container.
xAOD::Photon constructors
 Photon_v1 ()
 Default constructor.
 Photon_v1 (const Photon_v1 &ph)
 Copy ctor.
xAOD::Photon Assignment
Photon_v1operator= (const Photon_v1 &el)
 Assignment Operator. Ends up using the assignment of AuxElement for the store.
xAOD::Photon ObjectType
virtual Type::ObjectType type () const override final
 The type of the object as a simple enumeration.
xAOD::IParticle functions

These are already virtual due to IParticle

virtual double m () const override final
 The invariant mass of the particle.
virtual double e () const override final
 The total energy of the particle.
virtual double rapidity () const override final
 The true rapidity (y) of the particle.
xAOD::Photon vertex to cluster matching values.
bool vertexCaloMatchValue (float &value, const EgammaParameters::VertexCaloMatchType information) const
 Accessor to vertex to Calo Match Values If 'information' is stored in this xAOD::Egamma and is of the correct type, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'.
float vertexCaloMatchValue (const EgammaParameters::VertexCaloMatchType information) const
 Accessor to vertex to Calo Match Values , this just returns the value without internaly checking if it exists.
bool setVertexCaloMatchValue (const float value, const EgammaParameters::VertexCaloMatchType information)
 Set method for CaloMatch values.
xAOD::EgammaParameters::ConversionType conversionType () const
 return the photon conversion type (see EgammaEnums)
float conversionRadius () const
 return the photon conversion radius
xAOD::Egamma author (i.e. which reco algorithm was used)
uint16_t author (uint16_t bitmask=EgammaParameters::AuthorALL) const
 Get author.
void addAuthor (uint16_t)
 add author
void setAuthor (uint16_t)
 set author
xAOD::Egamma ambiguousObject i.e get the electron/photon corresponding to an ambiguous photon/electron

as the same cluster leads to creation of both.

const Egamma_v1ambiguousObject () const
 Get ambiguous.
xAOD::Egamma Shower shape Accesors

If 'information' is stored in this xAOD::Egamma and is of the correct type, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'.

bool showerShapeValue (float &value, const EgammaParameters::ShowerShapeType information) const
 Accessor for ShowerShape values.
float showerShapeValue (const EgammaParameters::ShowerShapeType information) const
 Accessor to ShowerShape values , this just returns the value without internaly checking if it exists.
bool setShowerShapeValue (float value, const EgammaParameters::ShowerShapeType information)
 Set method for Shower Shape values.
xAOD::Egamma object quality of the calorimeter cluster
bool isGoodOQ (uint32_t mask) const
 Check object quality. Return True is it is Good Object Quality.
uint32_t OQ () const
 Return the object quality bit word.
void setOQ (uint32_t newOQ)
 Set the object quality.
xAOD::Egamma Isolation value Accesors

If 'information' is stored in this xAOD::Egamma and is of the correct type, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'.

bool isolation (float &value, const Iso::IsolationType information) const
 Accessor for Isolation values.
float isolation (const Iso::IsolationType information) const
 Accessor to Isolation values , this just returns the value without internaly checking if it exists.
bool setIsolation (float value, const Iso::IsolationType information)
 set method for Isolation values.
bool isolationValue (float &value, const Iso::IsolationType information) const
 old Accessor for Isolation values.
float isolationValue (const Iso::IsolationType information) const
 old Accessor to Isolation values , this just returns the value without internaly checking if it exists.
bool setIsolationValue (float value, const Iso::IsolationType information)
 old set method for Isolation values.
xAOD::Egamma Isolation correction Accesors

If 'information' is stored in this xAOD::Egamma and is of the correct type, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'.

bool isolationCaloCorrection (float &value, const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection corr, const Iso::IsolationCorrectionParameter param) const
 Accessor for flavour and type depended Isolation Calo correction.
float isolationCaloCorrection (const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection corr, const Iso::IsolationCorrectionParameter param) const
 Accessor for flavour and type depended Isolation Calo corrections , this just returns the correction without internaly checking if it exists.
bool isolationCaloCorrection (float &value, Iso::IsolationType type, Iso::IsolationCaloCorrection corr) const
 Accessor for type depended Isolation Calo correction.
float isolationCaloCorrection (Iso::IsolationType type, Iso::IsolationCaloCorrection corr) const
 Accessor for type depended Isolation Calo corrections , this just returns the correction without internaly checking if it exists.
bool setIsolationCaloCorrection (float value, const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection corr, const Iso::IsolationCorrectionParameter param)
 set method for flavour and type depended Isolation Calo Corrections.
bool setIsolationCaloCorrection (float value, Iso::IsolationType type, Iso::IsolationCaloCorrection corr)
 set method for type depended Isolation Calo Corrections.
bool isolationTrackCorrection (float &value, const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection corr) const
 Accessor for Isolation Track correction.
float isolationTrackCorrection (const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection corr) const
 Accessor to Isolation Track corrections , this just returns the correction without internaly checking if it exists.
bool setIsolationTrackCorrection (float value, const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection corr)
 Set method for Isolation Track Corrections.
bool isolationCorrectionBitset (std::bitset< 32 > &value, const Iso::IsolationFlavour flavour) const
 Accessor for Isolation corection Bitset.
std::bitset< 32 > isolationCorrectionBitset (const Iso::IsolationFlavour flavour) const
 Accessor to Isolation corection Bitset , this just returns the bitset without internaly checking if it exists.
bool setIsolationCorrectionBitset (uint32_t value, const Iso::IsolationFlavour flavour)
 Set method for Isolation corection Bitset.
xAOD::Egamma selector / isEM methods using the menu name
bool passSelection (bool &value, const std::string &menu) const
 Check if the egamma object pass a selection menu (using the name) If the menu decision is stored in this xAOD::Egamma, then the function fills 'value' with the decision (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.
bool passSelection (const std::string &menu) const
 Check if the egamma object pass a selection menu (using the name) If the particular menu decision is not stored in this xAOD::Egamma, an exception will occur.
void setPassSelection (bool value, const std::string &menu)
 Set the selection decision for a menu (using the name)
bool selectionisEM (unsigned int &value, const std::string &isEM) const
 Return the isEM word for a selection menu If the menu isEM is stored in this xAOD::Egamma, then the function fills 'value' with the isEM (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.
unsigned int selectionisEM (const std::string &isEM) const
 Return the isEM word for a selection menu (using the name) If the particular isEM word is not stored in this xAOD::Egamma, an exception will occur.
void setSelectionisEM (unsigned int value, const std::string &isEM)
 Set the isEM word for a selection menu (using the name)
bool likelihoodValue (float &value, const std::string &LHValue=std::string("LHValue")) const
 Return the LH value as float If the LH decision is stored in this xAOD::Egamma, then the function fills 'value' with the decision (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.
float likelihoodValue (const std::string &LHValue=std::string("LHValue")) const
 Return the LH value as float If the LH Value is not stored in this xAOD::Egamma, an exception will occur.
void setLikelihoodValue (float value, const std::string &LHValue=std::string("LHValue"))
 Set the LHValue as float.
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.

Static Public Attributes

static constexpr bool supportsThinning = true
 Mark that this type supports thinning operations.

Protected Types

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

Protected Member Functions

const SG::IConstAuxStoregetConstStore () const
 Return the current store, as a const interface.
SG::IAuxStoregetStore () const
 Return the current store, as a non-const interface.
bool noPrivateData () const
 True if this element has no private data.
bool havePrivateData () const
 True if this element currently has private data.
bool hadPrivateData () const
 True if this element had private data before it was added to its current container.

Private Types

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

Private Member Functions

void releasePrivateStoreForDtor ()
 Out-of-line portion of destructor.
void setIndex (size_t index, SG::AuxVectorData *container)
 Set the index/container for this element.
bool setIndexPrivate (size_t index, SG::AuxVectorData *container)
 Set the index/container for this element.
void makePrivateStore1 (const void *other, bool warnUnlocked)
 Create a new private store for this object and copy aux data.
void makePrivateStore1 (const AuxElement *other, bool warnUnlocked)
 Create a new private store for this object and copy aux data.
AuxElementStandaloneData * setStore1 (const SG::IConstAuxStore *store)
 Set the store associated with this object.
void clearAux ()
 Clear all aux data associated with this element.
void copyAux (const ConstAuxElement &other, bool warnUnlocked=false)
 Copy aux data from another object.
void setNoPrivateData ()
 Record that this element does not have private data.
void setHavePrivateData ()
 Record that this element currently has private data.
void setHadPrivateData ()
 Record that this element used to have private data.

Static Private Member Functions

static void clearAuxHelper (AuxVectorData &container, size_t index)
 Clear all aux data associated with an element.
static void copyAuxHelper (AuxVectorData &container, size_t index, const ConstAuxElement &other, bool warnUnlocked)
 Copy aux data from another object.

Private Attributes

const SG::AuxVectorDatam_container
 The container of which this object is an element.
size_t m_index
 The index of this element within its container.
PrivateStoreState m_privateStoreState

xAOD::vertex Pointers to vertices

typedef std::vector< ElementLink< VertexContainer > > VxELVec_t
 Helper type definition.
const xAOD::Vertexvertex (size_t index=0) const
 Pointer to the xAOD::Vertex/es that match the photon candidate.
const ElementLink< VertexContainer > & vertexLink (size_t index=0) const
 ElementLink to the xAOD::vertex/es that match the electron candidate.
const VxELVec_tvertexLinks () const
 Get all vertex links.
void setVertexLinks (const VxELVec_t &links)
 set Pointer to the xAOD::vertex/vertices that match the photon candidate
size_t nVertices () const
 Return the number xAOD::Vertex/vertices that match the photon candidate.

xAOD::IParticle functions

These are already virtual due to IParticle

typedef IParticle::FourMom_t FourMom_t
 Definition of the 4-momentum type.
virtual double pt () const override final
 The transverse momentum ( \(p_T\)) of the particle.
virtual double eta () const override final
 The pseudorapidity ( \(\eta\)) of the particle.
virtual double phi () const override final
 The azimuthal angle ( \(\phi\)) of the particle.
virtual FourMom_t p4 () const override final
 The full 4-momentum of the particle as a TLoretzVector.

xAOD::Egamma 4-Mom functions

typedef ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > > GenVecFourMom_t
 Base 4 Momentum type for egamma.
GenVecFourMom_t genvecP4 () const
 The full 4-momentum of the particle : internal egamma type.
void setPtEtaPhi (float pt, float eta, float phi)
 set the 4-vec
void setPt (float pt)
 set the Pt
void setEta (float eta)
 set the eta
void setPhi (float phi)
 set the phi

xAOD::Egamma 4x4 Covariance Matrix

typedef Eigen::Matrix< float, 4, 4 > EgammaCovMatrix_t
 4x4 Covariance Matrix in EtEtaPhiM (needs decision)
EgammaCovMatrix_t covMatrix () const
 Returns the 4x4 symmetric covariance matrix .
void setCovMatrix (const EgammaCovMatrix_t &cov)
 set the 4x4 symmetric covariance matrix .

xAOD::Egamma Pointer to CaloClusters

typedef std::vector< ElementLink< CaloClusterContainer > > CLELVec_t
 Helper type definition.
size_t nCaloClusters () const
 Return the number of xAOD::CaloClusters that define the electron candidate.
const xAOD::CaloClustercaloCluster (size_t index=0) const
 Pointer to the xAOD::CaloCluster/s that define the electron candidate.
const ElementLink< CaloClusterContainer > & caloClusterLink (size_t index=0) const
 ElementLink to the xAOD::CaloCluster/s that match the electron candidate.
const CLELVec_tcaloClusterLinks () const
 Get all cluster links.
void setCaloClusterLinks (const CLELVec_t &links)
 set Pointer to the xAOD::CaloCluster

Detailed Description

Definition at line 37 of file Photon_v1.h.

Member Typedef Documentation

◆ Accessor

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

Definition at line 572 of file AuxElement.h.

◆ CLELVec_t

typedef std::vector< ElementLink< CaloClusterContainer > > xAOD::Egamma_v1::CLELVec_t
inherited

Helper type definition.

Definition at line 168 of file Egamma_v1.h.

◆ ConstAccessor

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

Definition at line 569 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 575 of file AuxElement.h.

◆ EgammaCovMatrix_t

typedef Eigen::Matrix<float,4,4> xAOD::Egamma_v1::EgammaCovMatrix_t
inherited

4x4 Covariance Matrix in EtEtaPhiM (needs decision)

Definition at line 142 of file Egamma_v1.h.

◆ FourMom_t

Definition of the 4-momentum type.

Definition at line 104 of file Egamma_v1.h.

◆ GenVecFourMom_t

typedef ROOT::Math::LorentzVector<ROOT::Math::PtEtaPhiM4D<double> > xAOD::Egamma_v1::GenVecFourMom_t
inherited

Base 4 Momentum type for egamma.

Definition at line 119 of file Egamma_v1.h.

◆ TypelessConstAccessor

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

Definition at line 566 of file AuxElement.h.

◆ VxELVec_t

Helper type definition.

Definition at line 94 of file Photon_v1.h.

Member Enumeration Documentation

◆ PrivateStoreState

enum class 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.

132 {
133 NO_PRIVATE = 0,
134 HAVE_PRIVATE = 1,
135 HAD_PRIVATE = 2,
136 };

Constructor & Destructor Documentation

◆ Photon_v1() [1/2]

xAOD::Photon_v1::Photon_v1 ( )

Default constructor.

Definition at line 19 of file Photon_v1.cxx.

20 : Egamma_v1() {
21
22 }
Egamma_v1()
Default constructor.
Definition Egamma_v1.cxx:48

◆ Photon_v1() [2/2]

xAOD::Photon_v1::Photon_v1 ( const Photon_v1 & ph)

Copy ctor.

This involves copying the entire Auxilary store (Deep copy). It is a slow operation which should be used sparingly.

Definition at line 24 of file Photon_v1.cxx.

24 : Egamma_v1(ph){
26 }
void makePrivateStore()
Create a new (empty) private store for this object.

Member Function Documentation

◆ addAuthor()

void xAOD::Egamma_v1::addAuthor ( uint16_t newAuthor)
inherited

add author

Definition at line 161 of file Egamma_v1.cxx.

161 {
162 static const Accessor< uint16_t > acc( "author" );
163 uint16_t author = acc(*this);
164 acc(*this) = author | newAuthor;
165}
SG::Accessor< T, ALLOC > Accessor
Definition AuxElement.h:572
uint16_t author(uint16_t bitmask=EgammaParameters::AuthorALL) const
Get author.
static const SG::AuxElement::Accessor< ElementLink< IParticleContainer > > acc("originalObjectLink")
Object used for setting/getting the dynamic decoration in question.
setWord1 uint16_t

◆ ambiguousObject()

const Egamma_v1 * xAOD::Egamma_v1::ambiguousObject ( ) const
inherited

Get ambiguous.

ambiguous

Definition at line 182 of file Egamma_v1.cxx.

182 {
183
184 if( ! ambiguityLinkAcc.isAvailable( *this ) ) {
185 return nullptr;
186 }
187 const ElementLink< xAOD::EgammaContainer >& link = ambiguityLinkAcc( *this );
188 if( ! link.isValid() ) {
189 return nullptr;
190 }
191 return *link;
192}
static const SG::AuxElement::Accessor< ElementLink< xAOD::EgammaContainer > > ambiguityLinkAcc("ambiguityLink")
Accessor for the "ambiguityLink" dynamic variable.

◆ assign()

void SG::AuxElement::assign ( const AuxElement & other,
bool warnUnlocked = false )
inherited

Assignment.

Parameters
otherThe object from which we're assigning.
warnUnlockedIf true, then warn when we skip unlocked decorations.

We don't copy container/index, as assignment doesn't change where this object is. However, if we have aux data, then we copy aux data if we're copying from an object that also has it; otherwise, if we're copying from an object with no aux data, then we clear ours.

◆ author()

uint16_t xAOD::Egamma_v1::author ( uint16_t bitmask = EgammaParameters::AuthorALL) const
inherited

Get author.

egamma author

Definition at line 155 of file Egamma_v1.cxx.

155 {
156 static const Accessor< uint16_t > acc( "author" );
157 uint16_t author = acc(*this);
158 return author & mask;
159}

◆ 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
nameName 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
nameName 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
nameName of the aux variable
clsnameThe 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.

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

◆ 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
nameName of the aux variable
clsnameThe 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.

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

◆ 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
nameName 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
nameName of the aux variable.
clsnameThe 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
nameName 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
nameName of the aux variable.
clsnameThe 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.

◆ caloCluster()

const xAOD::CaloCluster * xAOD::Egamma_v1::caloCluster ( size_t index = 0) const
inherited

Pointer to the xAOD::CaloCluster/s that define the electron candidate.

Definition at line 377 of file Egamma_v1.cxx.

377 {
378
379 if( index >= nCaloClusters() ) {
380 return nullptr;
381 }
382 const CLELVec_t& cls = caloClusterLinks();
383 if( ! cls[ index ].isValid() ) {
384 return nullptr;
385 }
386 return *( cls[ index ] );
387}
bool isValid(const T &p)
Av: we implement here an ATLAS-sepcific convention: all particles which are 99xxxxx are fine.
Definition AtlasPID.h:878
size_t index() const
Return the index of this element within its container.
size_t nCaloClusters() const
Return the number of xAOD::CaloClusters that define the electron candidate.
std::vector< ElementLink< CaloClusterContainer > > CLELVec_t
Helper type definition.
Definition Egamma_v1.h:168
const CLELVec_t & caloClusterLinks() const
Get all cluster links.

◆ caloClusterLink()

const ElementLink< CaloClusterContainer > & xAOD::Egamma_v1::caloClusterLink ( size_t index = 0) const
inherited

ElementLink to the xAOD::CaloCluster/s that match the electron candidate.

Definition at line 390 of file Egamma_v1.cxx.

390 {
391
392 if( index >= nCaloClusters() ) {
393 static const ElementLink< CaloClusterContainer > dummy;
394 return dummy;
395 }
396 return caloClusterLinks()[ index ];
397}

◆ caloClusterLinks()

const CLELVec_t & xAOD::Egamma_v1::caloClusterLinks ( ) const
inherited

Get all cluster links.

◆ 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 580 of file AuxElement.cxx.

581{
582 if (!m_container) return;
584}
static void clearAuxHelper(AuxVectorData &container, size_t index)
Clear all aux data associated with an element.
const SG::AuxVectorData * container() const
Return the container holding this element.
size_t index() const
Return the index of this element within its container.
const SG::AuxVectorData * m_container
The container of which this object is an element.
Definition AuxElement.h:335

◆ clearAuxHelper()

void SG::AuxElement::clearAuxHelper ( AuxVectorData & container,
size_t index )
staticprivateinherited

Clear all aux data associated with an element.

Parameters
containerContainer of the element.
indexIndex of this element within the container.

If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 639 of file AuxElement.cxx.

640{
641 if (!container.hasStore()) return;
642 if (!container.hasNonConstStore()) {
643 throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
644 }
645
646 SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
647 for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
648 r.clear (auxid, container, index, 1);
649 }
650}
static AuxTypeRegistry & instance()
Return the singleton registry instance.
int r
Definition globals.cxx:22
static const auxid_t null_auxid
To signal no aux data item.
Definition AuxTypes.h:30
size_t auxid_t
Identifier for a particular aux data item.
Definition AuxTypes.h:27

◆ 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 339 of file AuxElement.cxx.

340{
341 if (container())
343}
void clearCache()
Clear the cached aux data pointers.

◆ 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 428 of file AuxElement.cxx.

429{
430 if (havePrivateData())
431 return m_container->clearDecorations();
432 return false;
433}
bool havePrivateData() const
True if this element currently has private data.

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

◆ conversionRadius()

float xAOD::Photon_v1::conversionRadius ( ) const
inline

return the photon conversion radius

Definition at line 129 of file Photon_v1.h.

129 {
131 }
float conversionRadius(const xAOD::Vertex *vx)
return the conversion radius or 9999.

◆ conversionType()

xAOD::EgammaParameters::ConversionType xAOD::Photon_v1::conversionType ( ) const
inline

return the photon conversion type (see EgammaEnums)

Definition at line 124 of file Photon_v1.h.

124 {
126 }
xAOD::EgammaParameters::ConversionType conversionType(const xAOD::Photon *ph)
return the photon conversion type (see EgammaEnums)

◆ copyAux()

void SG::AuxElement::copyAux ( const ConstAuxElement & other,
bool warnUnlocked = false )
privateinherited

Copy aux data from another object.

Parameters
otherThe object from which to copy.
warnUnlockedIf true, then warn when we skip unlocked decorations.

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 600 of file AuxElement.cxx.

602{
603 if (!m_container) return;
604 copyAuxHelper (*container(), index(), other, warnUnlocked);
605}
static void copyAuxHelper(AuxVectorData &container, size_t index, const ConstAuxElement &other, bool warnUnlocked)
Copy aux data from another object.

◆ copyAuxHelper()

void SG::AuxElement::copyAuxHelper ( AuxVectorData & container,
size_t index,
const ConstAuxElement & other,
bool warnUnlocked )
staticprivateinherited

Copy aux data from another object.

Parameters
containerContainer of the element.
indexIndex of this element within the container.
otherThe object from which to copy.
warnUnlockedIf true, then warn when we skip unlocked decorations.

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 667 of file AuxElement.cxx.

671{
672 if (!container.hasStore()) return;
673 if (!container.hasNonConstStore())
674 throw SG::ExcConstAuxData ("copyAux");
675
676 const SG::AuxVectorData* ocont = other.container();
677
678 if (!ocont || !ocont->hasStore()) {
680 return;
681 }
682
683#ifndef XAOD_STANDALONE
684 const SG::auxid_set_t& other_decors = ocont->getDecorIDs();
685#endif
686 SG::auxid_set_t other_ids = ocont->getAuxIDs();
687
688 size_t oindex = other.index();
689 SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
690
691 for (SG::auxid_t auxid : other_ids) {
692#ifndef XAOD_STANDALONE
693 if (other_decors.test (auxid)) {
694 // Don't copy decorations --- another thread may be modifying them.
695 other_ids.reset (auxid);
696 // Warn if we skip a decoration (except for mcEventWeights,
697 // for which this is expected).
698 if (warnUnlocked && r.getName(auxid) != "mcEventWeights") {
699 std::ostringstream ss;
700 ss << "skipped unlocked decoration " << r.getName(auxid)
701 << " (" << auxid << ")";
702 ATHCONTAINERS_WARNING("copyAux", ss.str());
703 }
704 }
705 else
706#endif
707 if (!r.isLinked (auxid)) {
708 r.copy (auxid, container, index, *ocont, oindex, 1);
709 }
710 }
711
712 for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
713 if (!other_ids.test (auxid)) {
714 r.clear (auxid, container, index, 1);
715 }
716 }
717}
static Double_t ss
bool test(bit_t bit) const
Test to see if a bit is set.
const SG::auxid_set_t & getAuxIDs() const
Return a set of identifiers for existing data items in store associated with this object.
const SG::auxid_set_t & getDecorIDs() const
Return a set of identifiers for decorations for this object.
bool hasStore() const
Return true if this object has an associated store.
#define ATHCONTAINERS_WARNING(ctx, msg)
Definition error.h:57

◆ covMatrix()

Egamma_v1::EgammaCovMatrix_t xAOD::Egamma_v1::covMatrix ( ) const
inherited

Returns the 4x4 symmetric covariance matrix .

Definition at line 124 of file Egamma_v1.cxx.

124 {
125
126 static const Accessor< std::vector<float> > acc( "EgammaCovarianceMatrix" );
128 cov.setZero();
129
130 if(!acc.isAvailable(*this) ) {
131 return cov;
132 }
133 const std::vector<float>& v = acc(*this);
134 size_t size= v.size();
135 if(size==16){
136 //up to 21.0.11
137 cov = Eigen::Map<const EgammaCovMatrix_t> (v.data());
138 }
139 else {
140 //from >21.0.11
142 MatrixHelpers::expand(v.begin(),v.end(),cov );
143 }
144 return cov;
145}
Eigen::Matrix< float, 4, 4 > EgammaCovMatrix_t
4x4 Covariance Matrix in EtEtaPhiM (needs decision)
Definition Egamma_v1.h:142
void expand(std::vector< float >::const_iterator it, std::vector< float >::const_iterator, Eigen::Matrix< float, N, N, 0, N, N > &covMatrix)
Definition Egamma_v1.cxx:37

◆ e()

double xAOD::Photon_v1::e ( ) const
finaloverridevirtual

The total energy of the particle.

Reimplemented from xAOD::Egamma_v1.

Definition at line 46 of file Photon_v1.cxx.

46 {
47 // for a massless particle E = pT * cosh(eta)
48 return pt() * std::cosh(eta());
49 }
virtual double pt() const override final
The transverse momentum ( ) of the particle.
Definition Egamma_v1.cxx:66
virtual double eta() const override final
The pseudorapidity ( ) of the particle.
Definition Egamma_v1.cxx:71

◆ eta()

double xAOD::Egamma_v1::eta ( ) const
finaloverridevirtualinherited

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

Implements xAOD::IParticle.

Definition at line 71 of file Egamma_v1.cxx.

71 {
72 static const Accessor<float > acc( "eta" );
73 return acc(*this);
74}

◆ genvecP4()

Egamma_v1::GenVecFourMom_t xAOD::Egamma_v1::genvecP4 ( ) const
inherited

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

Depends on return value optimization.

Definition at line 82 of file Egamma_v1.cxx.

82 {
83 return GenVecFourMom_t(pt(), eta(), phi(), m());
84}
ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > > GenVecFourMom_t
Base 4 Momentum type for egamma.
Definition Egamma_v1.h:119
virtual double phi() const override final
The azimuthal angle ( ) of the particle.
Definition Egamma_v1.cxx:76
virtual double m() const =0
The invariant mass of the particle.

◆ 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 355 of file AuxElement.cxx.

356{
357#ifdef ATHCONTAINERS_R21_COMPAT
358 if (havePrivateData())
359 return m_container->getConstStore()->getAuxIDs();
360 if (container())
361 return container()->getAuxIDs();
362 static const SG::auxid_set_t null_set;
363 return null_set;
364#else
366#endif
367}
const SG::auxid_set_t & getAuxIDs() const
Return a set of identifiers for existing data items for this object.

◆ getConstStore()

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

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 869 of file AuxElement.cxx.

305{
306 if (havePrivateData()) {
307 return m_container->getConstStore();
308 }
309 return 0;
310}

◆ getDecorIDs()

const SG::auxid_set_t & SG::AuxElement::getDecorIDs ( ) const
inherited

Return a set of identifiers for decorations 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 378 of file AuxElement.cxx.

379{
380#ifdef ATHCONTAINERS_R21_COMPAT
381 if (havePrivateData())
382 return m_container->getConstStore()->getDecorIDs();
383 if (container())
384 return container()->getDecorIDs();
385 static const SG::auxid_set_t null_set;
386 return null_set;
387#else
389#endif
390}
const SG::auxid_set_t & getDecorIDs() const
Return a set of identifiers for decorations for this object.

◆ getStore()

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

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 878 of file AuxElement.cxx.

320{
321 if (havePrivateData()) {
322#ifdef ATHCONTAINERS_R21_COMPAT
323 SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = m_container;
324#else
325 SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
326#endif
327 return container_nc->getStore();
328 }
329 return 0;
330}
#define ATLAS_THREAD_SAFE

◆ 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 411 of file AuxElement.cxx.

412{
413 if (havePrivateData())
414 return m_container->hasNonConstStore();
415 return false;
416}

◆ 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 398 of file AuxElement.cxx.

399{
400 if (havePrivateData())
401 return m_container->hasStore();
402 return false;
403}

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const
protectedinherited

True if this element currently has private data.

◆ index()

size_t SG::IAuxElement::index ( ) const
inherited

Return the index of this element within its container.

Inherited from IAuxElement.

◆ 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
nameName of the auxiliary variable
clsnameThe 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.

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

◆ 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
nameName of the aux variable.
clsnameThe 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
nameName of the auxiliary variable
clsnameThe 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.

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

◆ 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
nameName of the aux variable.
clsnameThe 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.

◆ isGoodOQ()

bool xAOD::Egamma_v1::isGoodOQ ( uint32_t mask) const
inherited

Check object quality. Return True is it is Good Object Quality.

Object Quality.

Definition at line 225 of file Egamma_v1.cxx.

225 {
226 static const Accessor< uint32_t > acc( "OQ" );
227 uint32_t OQ = acc(*this);
228 return (OQ & mask)==0;
229}
uint32_t OQ() const
Return the object quality bit word.
setEventNumber uint32_t

◆ isolation() [1/2]

float xAOD::Egamma_v1::isolation ( const Iso::IsolationType information) const
inherited

Accessor to Isolation values , this just returns the value without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 255 of file Egamma_v1.cxx.

255 {
256 const SG::AuxElement::Accessor< float >* acc = getIsolationAccessor( information );
257 if( !acc ) throw std::runtime_error( "Unknown/Unavailable Isolation type requested" );
258 return ( *acc )(*this);
259}
const SG::AuxElement::Accessor< float > * getIsolationAccessor(Iso::IsolationType type)
Get the Accessor object for a given isolation type.

◆ isolation() [2/2]

bool xAOD::Egamma_v1::isolation ( float & value,
const Iso::IsolationType information ) const
inherited

Accessor for Isolation values.

Isolation value.

Definition at line 242 of file Egamma_v1.cxx.

242 {
243 const SG::AuxElement::Accessor< float >* acc = getIsolationAccessor( information );
244 if( !acc ) {
245 return false;
246 }
247 if(!acc->isAvailable(*this) ) {
248 return false;
249 }
250 // Retrieve the value:
251 value = ( *acc )(*this);
252 return true;
253}

◆ isolationCaloCorrection() [1/4]

float xAOD::Egamma_v1::isolationCaloCorrection ( const Iso::IsolationFlavour flavour,
const Iso::IsolationCaloCorrection corr,
const Iso::IsolationCorrectionParameter param ) const
inherited

Accessor for flavour and type depended Isolation Calo corrections , this just returns the correction without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 281 of file Egamma_v1.cxx.

282 {
283
284 const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr,param);
285 if( !acc.isAvailable(*this) ) {throw std::runtime_error( "Unknown/Unavailable Isolation correction requested" );}
286 return acc(*this);
287}
const SG::AuxElement::Accessor< float > getIsolationCorrectionAccessor(Iso::IsolationFlavour type, Iso::IsolationCaloCorrection corr, Iso::IsolationCorrectionParameter param)

◆ isolationCaloCorrection() [2/4]

bool xAOD::Egamma_v1::isolationCaloCorrection ( float & value,
const Iso::IsolationFlavour flavour,
const Iso::IsolationCaloCorrection corr,
const Iso::IsolationCorrectionParameter param ) const
inherited

Accessor for flavour and type depended Isolation Calo correction.

Isolation corrections.

Definition at line 270 of file Egamma_v1.cxx.

271 {
272 const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr,param);
273 if(!acc.isAvailable(*this) ) {
274 return false;
275 }
276 // Retrieve the value:
277 value = acc(*this);
278 return true;
279}

◆ isolationCaloCorrection() [3/4]

bool xAOD::Egamma_v1::isolationCaloCorrection ( float & value,
Iso::IsolationType type,
Iso::IsolationCaloCorrection corr ) const
inherited

Accessor for type depended Isolation Calo correction.

Definition at line 297 of file Egamma_v1.cxx.

297 {
298 const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(type,corr);
299 if(!acc.isAvailable(*this) ) {
300 return false;
301 }
302 // Retrieve the value:
303 value = acc(*this);
304 return true;
305}
virtual Type::ObjectType type() const override=0
The type of the object as a simple enumeration, remains pure virtual in e/gamma.

◆ isolationCaloCorrection() [4/4]

float xAOD::Egamma_v1::isolationCaloCorrection ( Iso::IsolationType type,
Iso::IsolationCaloCorrection corr ) const
inherited

Accessor for type depended Isolation Calo corrections , this just returns the correction without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 307 of file Egamma_v1.cxx.

307 {
308 const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(type,corr);
309 if( !acc.isAvailable(*this) ) {throw std::runtime_error( "Unknown/Unavailable Isolation correction requested" );}
310 return acc(*this);
311}

◆ isolationCorrectionBitset() [1/2]

std::bitset< 32 > xAOD::Egamma_v1::isolationCorrectionBitset ( const Iso::IsolationFlavour flavour) const
inherited

Accessor to Isolation corection Bitset , this just returns the bitset without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 352 of file Egamma_v1.cxx.

352 {
354 if( !acc.isAvailable(*this) ) {throw std::runtime_error( "Unknown/Unavailable Isolation BitSet requested" );}
355 return {acc(*this)};
356}
const SG::AuxElement::Accessor< uint32_t > getIsolationCorrectionBitsetAccessor(Iso::IsolationFlavour type)
Returns an accessor for the correction bitset corresponding to this IsolationType.

◆ isolationCorrectionBitset() [2/2]

bool xAOD::Egamma_v1::isolationCorrectionBitset ( std::bitset< 32 > & value,
const Iso::IsolationFlavour flavour ) const
inherited

Accessor for Isolation corection Bitset.

Definition at line 342 of file Egamma_v1.cxx.

342 {
344 if(!acc.isAvailable(*this) ) {
345 return false;
346 }
347 // Retrieve the value:
348 value = std::bitset<32>(acc(*this));
349 return true;
350}

◆ isolationTrackCorrection() [1/2]

float xAOD::Egamma_v1::isolationTrackCorrection ( const Iso::IsolationFlavour flavour,
const Iso::IsolationTrackCorrection corr ) const
inherited

Accessor to Isolation Track corrections , this just returns the correction without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 329 of file Egamma_v1.cxx.

329 {
330 const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr);
331 if( !acc.isAvailable(*this) ) {throw std::runtime_error( "Unknown/Unavailable Isolation correction requested" );}
332 return acc(*this);
333}

◆ isolationTrackCorrection() [2/2]

bool xAOD::Egamma_v1::isolationTrackCorrection ( float & value,
const Iso::IsolationFlavour flavour,
const Iso::IsolationTrackCorrection corr ) const
inherited

Accessor for Isolation Track correction.

Definition at line 319 of file Egamma_v1.cxx.

319 {
320 const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr);
321 if(!acc.isAvailable(*this) ) {
322 return false;
323 }
324 // Retrieve the value:
325 value = acc(*this);
326 return true;
327}

◆ isolationValue() [1/2]

float xAOD::Egamma_v1::isolationValue ( const Iso::IsolationType information) const
inlineinherited

old Accessor to Isolation values , this just returns the value without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 257 of file Egamma_v1.h.

257 {
258
259 return isolation(information);
260 }
bool isolation(float &value, const Iso::IsolationType information) const
Accessor for Isolation values.

◆ isolationValue() [2/2]

bool xAOD::Egamma_v1::isolationValue ( float & value,
const Iso::IsolationType information ) const
inlineinherited

old Accessor for Isolation values.

Definition at line 251 of file Egamma_v1.h.

251 {
252
253 return isolation(value,information);
254 }

◆ likelihoodValue() [1/2]

float xAOD::Egamma_v1::likelihoodValue ( const std::string & LHValue = std::string("LHValue")) const
inherited

Return the LH value as float If the LH Value is not stored in this xAOD::Egamma, an exception will occur.

◆ likelihoodValue() [2/2]

bool xAOD::Egamma_v1::likelihoodValue ( float & value,
const std::string & LHValue = std::string("LHValue") ) const
inherited

Return the LH value as float If the LH decision is stored in this xAOD::Egamma, then the function fills 'value' with the decision (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.

◆ m()

double xAOD::Photon_v1::m ( ) const
finaloverridevirtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 42 of file Photon_v1.cxx.

42 {
44 }
constexpr double photonMassInMeV
various mass-less particles

◆ 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 192 of file AuxElement.cxx.

193{
194 if (m_container) {
195 throw SG::ExcBadPrivateStore ("store already exists");
196 }
197
198 m_container = new SG::AuxElementPrivateData;
201}
void setIndex(size_t index)
Set the index of this element within its container.
void setHavePrivateData()
Record that this element currently has private data.

◆ makePrivateStore() [2/3]

template<class U1>
void SG::AuxElement::makePrivateStore ( const U1 & other,
bool warnUnlocked = false )
inherited

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

Parameters
otherThe object from which aux data should be copied.
warnUnlockedIf true, then warn when we skip unlocked decorations.

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,
bool warnUnlocked = false )
inherited

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

Parameters
otherThe object from which aux data should be copied.
warnUnlockedIf true, then warn when we skip unlocked decorations.

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,
bool warnUnlocked )
privateinherited

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

Parameters
otherThe object from which aux data should be copied.
warnUnlockedIf true, then warn when we skip unlocked decorations.

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 565 of file AuxElement.cxx.

567{
569 if (other)
570 this->copyAux (*other, warnUnlocked);
571}
void copyAux(const ConstAuxElement &other, bool warnUnlocked=false)
Copy aux data from another object.

◆ makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1 ( const void * other,
bool warnUnlocked )
privateinherited

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

Parameters
otherThe object from which aux data should be copied.
warnUnlockedIf true, then warn when we skip unlocked decorations.

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.

◆ nCaloClusters()

size_t xAOD::Egamma_v1::nCaloClusters ( ) const
inherited

Return the number of xAOD::CaloClusters that define the electron candidate.

Implementation of the CaloCluster accessor functions.

Definition at line 366 of file Egamma_v1.cxx.

366 {
367
369 clusterAcc( "caloClusterLinks" );
370
371 if( clusterAcc.isAvailable(*this) ) {
372 return clusterAcc(*this).size();
373 }
374 return 0;
375}

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const
protectedinherited

True if this element has no private data.

◆ nVertices()

size_t xAOD::Photon_v1::nVertices ( ) const

Return the number xAOD::Vertex/vertices that match the photon candidate.

◆ operator=()

Photon_v1 & xAOD::Photon_v1::operator= ( const Photon_v1 & el)

Assignment Operator. Ends up using the assignment of AuxElement for the store.

Definition at line 28 of file Photon_v1.cxx.

28 {
29
30 if (this != &ph){ // protect against invalid self-assignment
31 this->Egamma_v1::operator=( ph );
32 }
33 // by convention, always return *this
34 return *this;
35 }
Egamma_v1 & operator=(const Egamma_v1 &eg)
Assignment Operator. Using the assignment of SG::AuxElement.
Definition Egamma_v1.cxx:54

◆ OQ()

uint32_t xAOD::Egamma_v1::OQ ( ) const
inherited

Return the object quality bit word.

Definition at line 231 of file Egamma_v1.cxx.

231 {
232 static const Accessor< uint32_t > acc( "OQ" );
233 return acc(*this) ;
234}

◆ p4()

Egamma_v1::FourMom_t xAOD::Egamma_v1::p4 ( ) const
finaloverridevirtualinherited

The full 4-momentum of the particle as a TLoretzVector.

Implements xAOD::IParticle.

Definition at line 94 of file Egamma_v1.cxx.

94 {
96 p4.SetPtEtaPhiM( pt(), eta(), phi(),m());
97 return p4;
98}
IParticle::FourMom_t FourMom_t
Definition of the 4-momentum type.
Definition Egamma_v1.h:104
virtual FourMom_t p4() const override final
The full 4-momentum of the particle as a TLoretzVector.
Definition Egamma_v1.cxx:94

◆ passSelection() [1/2]

bool xAOD::Egamma_v1::passSelection ( bool & value,
const std::string & menu ) const
inherited

Check if the egamma object pass a selection menu (using the name) If the menu decision is stored in this xAOD::Egamma, then the function fills 'value' with the decision (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.

◆ passSelection() [2/2]

bool xAOD::Egamma_v1::passSelection ( const std::string & menu) const
inherited

Check if the egamma object pass a selection menu (using the name) If the particular menu decision is not stored in this xAOD::Egamma, an exception will occur.

◆ phi()

double xAOD::Egamma_v1::phi ( ) const
finaloverridevirtualinherited

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

Implements xAOD::IParticle.

Definition at line 76 of file Egamma_v1.cxx.

76 {
77 static const Accessor< float > acc( "phi" );
78 return acc(*this);
79}

◆ pt()

double xAOD::Egamma_v1::pt ( ) const
finaloverridevirtualinherited

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

Implements xAOD::IParticle.

Definition at line 66 of file Egamma_v1.cxx.

66 {
67 static const Accessor< float > acc( "pt" );
68 return acc(*this);
69}

◆ rapidity()

double xAOD::Photon_v1::rapidity ( ) const
finaloverridevirtual

The true rapidity (y) of the particle.

Reimplemented from xAOD::Egamma_v1.

Definition at line 51 of file Photon_v1.cxx.

51 {
52 // massless rapidity is the same as pseudorapidity
53 return eta();
54 }

◆ 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 210 of file AuxElement.cxx.

211{
212 if (hadPrivateData()) {
213 // We had a private store, but it was released because this object
214 // was added to a container. Just forget about it.
216 return;
217 }
218
219 if (!havePrivateData() ||
220 !m_container ||
221 typeid(*m_container) != typeid(AuxElementPrivateData))
222 {
223 throw SG::ExcBadPrivateStore ("no private store exists");
224 }
225
228 delete m_container;
229 m_container = 0;
230}
bool hadPrivateData() const
True if this element had private data before it was added to its current container.
void setNoPrivateData()
Record that this element does not have private data.

◆ releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )
privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 441 of file AuxElement.cxx.

442{
443#ifdef ATHCONTAINERS_R21_COMPAT
444 if (havePrivateData()) {
445 delete m_container;
446 }
447#else
449#endif
450}
void releasePrivateStoreForDtor()
Out-of-line portion of destructor.

◆ selectionisEM() [1/2]

unsigned int xAOD::Egamma_v1::selectionisEM ( const std::string & isEM) const
inherited

Return the isEM word for a selection menu (using the name) If the particular isEM word is not stored in this xAOD::Egamma, an exception will occur.

Definition at line 431 of file Egamma_v1.cxx.

431 {
433 return acc(*this);
434}

◆ selectionisEM() [2/2]

bool xAOD::Egamma_v1::selectionisEM ( unsigned int & value,
const std::string & isEM ) const
inherited

Return the isEM word for a selection menu If the menu isEM is stored in this xAOD::Egamma, then the function fills 'value' with the isEM (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.

Definition at line 422 of file Egamma_v1.cxx.

422 {
424 if(!acc.isAvailable(*this) ) {
425 return false;
426 }
427 value= acc(*this);
428 return true;
429}

◆ setAuthor()

void xAOD::Egamma_v1::setAuthor ( uint16_t newAuthor)
inherited

set author

Definition at line 167 of file Egamma_v1.cxx.

167 {
168 static const Accessor< uint16_t > acc( "author" );
169 acc(*this) = newAuthor;
170}

◆ setCaloClusterLinks()

void xAOD::Egamma_v1::setCaloClusterLinks ( const CLELVec_t & links)
inherited

set Pointer to the xAOD::CaloCluster

◆ setConstStore()

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

Synonym for setStore with IConstAuxStore.

Parameters
storeThe new store.

◆ setCovMatrix()

void xAOD::Egamma_v1::setCovMatrix ( const EgammaCovMatrix_t & cov)
inherited

set the 4x4 symmetric covariance matrix .

Definition at line 147 of file Egamma_v1.cxx.

147 {
148 //The internal storage is an std::vector
149 static const Accessor< std::vector < float > > acc( "EgammaCovarianceMatrix" );
150 //from >21.0.11
151 MatrixHelpers::compress(cov,acc(*this));
152}
void compress(const Eigen::Matrix< float, N, N, 0, N, N > &covMatrix, std::vector< float > &vec)
Definition Egamma_v1.cxx:28

◆ setEta()

void xAOD::Egamma_v1::setEta ( float eta)
inherited

set the eta

Definition at line 114 of file Egamma_v1.cxx.

114 {
115 static const Accessor< float > acc( "eta" );
116 acc(*this) = eta;
117}

◆ 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
indexThe index of this object within the container.
containerThe 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
indexThe index of this object within the container.
containerThe 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 505 of file AuxElement.cxx.

506{
507#ifdef ATHCONTAINERS_R21_COMPAT
508 if (hadPrivateData()) {
509 // We had a private store, but it was released because we were added
510 // to a container.
511
512 if (container == 0) {
513 // We're being moved out of the container. Make a new private
514 // store, copy the data, and switch to it.
515 auto privateData = new SG::AuxElementPrivateData;
516 AuxElement to (privateData, 0);
517 to.copyAux (*this);
520 m_container = privateData;
521 return true;
522 }
523 }
524 else if (havePrivateData() &&
525 typeid(*m_container) == typeid(AuxElementPrivateData))
526 {
527 // We currently have a private store.
528
529 if (container != 0 && container != m_container) {
530 // We're being added to a container.
531 // Aux data has already been copied.
532 // Release private store.
535 delete m_container;
537 return false;
538 }
539 }
540 else {
541 // We have a standalone store.
542 throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
543 "from a container.");
544 }
545
548 return false;
549#else
551#endif
552}
AuxElement()
Default constructor.
bool setIndexPrivate(size_t index, const SG::AuxVectorData *container)
Set the index/container for this element.
void setHadPrivateData()
Record that this element used to have private data.
CONT to(RANGE &&r)
Definition ranges.h:39

◆ setIsolation()

bool xAOD::Egamma_v1::setIsolation ( float value,
const Iso::IsolationType information )
inherited

set method for Isolation values.

Definition at line 261 of file Egamma_v1.cxx.

261 {
262 const SG::AuxElement::Accessor< float >* acc = getIsolationAccessor( information );
263 if( !acc ) return false;
264 // Set the value:
265 ( *acc )(*this) = value;
266 return true;
267}

◆ setIsolationCaloCorrection() [1/2]

bool xAOD::Egamma_v1::setIsolationCaloCorrection ( float value,
const Iso::IsolationFlavour flavour,
const Iso::IsolationCaloCorrection corr,
const Iso::IsolationCorrectionParameter param )
inherited

set method for flavour and type depended Isolation Calo Corrections.

Definition at line 289 of file Egamma_v1.cxx.

290 {
291 const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr,param);
292 // Set the value:
293 acc(*this) = value;
294 return true;
295}

◆ setIsolationCaloCorrection() [2/2]

bool xAOD::Egamma_v1::setIsolationCaloCorrection ( float value,
Iso::IsolationType type,
Iso::IsolationCaloCorrection corr )
inherited

set method for type depended Isolation Calo Corrections.

Definition at line 313 of file Egamma_v1.cxx.

313 {
314 const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(type,corr);
315 acc(*this) = value;
316 return true;
317}

◆ setIsolationCorrectionBitset()

bool xAOD::Egamma_v1::setIsolationCorrectionBitset ( uint32_t value,
const Iso::IsolationFlavour flavour )
inherited

Set method for Isolation corection Bitset.

Definition at line 358 of file Egamma_v1.cxx.

358 {
360 // Set the value:
361 acc(*this) = value;
362 return true;
363}

◆ setIsolationTrackCorrection()

bool xAOD::Egamma_v1::setIsolationTrackCorrection ( float value,
const Iso::IsolationFlavour flavour,
const Iso::IsolationTrackCorrection corr )
inherited

Set method for Isolation Track Corrections.

Definition at line 335 of file Egamma_v1.cxx.

335 {
336 const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr);
337 // Set the value:
338 acc(*this) = value;
339 return true;
340}

◆ setIsolationValue()

bool xAOD::Egamma_v1::setIsolationValue ( float value,
const Iso::IsolationType information )
inlineinherited

old set method for Isolation values.

Definition at line 262 of file Egamma_v1.h.

262 {
263 return setIsolation(value,information);
264 }
bool setIsolation(float value, const Iso::IsolationType information)
set method for Isolation values.

◆ setLikelihoodValue()

void xAOD::Egamma_v1::setLikelihoodValue ( float value,
const std::string & LHValue = std::string("LHValue") )
inherited

Set the LHValue as float.

◆ setNonConstStore()

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

Synonym for setStore with IAuxStore.

Parameters
storeThe new store.

◆ setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )
privateinherited

Record that this element does not have private data.

◆ setOQ()

void xAOD::Egamma_v1::setOQ ( uint32_t newOQ)
inherited

Set the object quality.

Definition at line 236 of file Egamma_v1.cxx.

236 {
237 static const Accessor< uint32_t > acc( "OQ" );
238 acc(*this) = newOQ;
239}

◆ setPassSelection()

void xAOD::Egamma_v1::setPassSelection ( bool value,
const std::string & menu )
inherited

Set the selection decision for a menu (using the name)

◆ setPhi()

void xAOD::Egamma_v1::setPhi ( float phi)
inherited

set the phi

Definition at line 119 of file Egamma_v1.cxx.

119 {
120 static const Accessor< float > acc( "phi" );
121 acc(*this) = phi;
122}

◆ setPt()

void xAOD::Egamma_v1::setPt ( float pt)
inherited

set the Pt

Definition at line 109 of file Egamma_v1.cxx.

109 {
110 static const Accessor< float > acc( "pt" );
111 acc(*this) = pt;
112}

◆ setPtEtaPhi()

void xAOD::Egamma_v1::setPtEtaPhi ( float pt,
float eta,
float phi )
inherited

set the 4-vec

Definition at line 100 of file Egamma_v1.cxx.

100 {
101 static const Accessor< float > acc1( "pt" );
102 acc1(*this) = pt;
103 static const Accessor< float > acc2( "eta" );
104 acc2(*this) = eta;
105 static const Accessor< float > acc3( "phi" );
106 acc3(*this) = phi;
107}

◆ setSelectionisEM()

void xAOD::Egamma_v1::setSelectionisEM ( unsigned int value,
const std::string & isEM )
inherited

Set the isEM word for a selection menu (using the name)

Definition at line 436 of file Egamma_v1.cxx.

436 {
438 acc(*this)=value;
439}

◆ setShowerShapeValue()

bool xAOD::Egamma_v1::setShowerShapeValue ( float value,
const EgammaParameters::ShowerShapeType information )
inherited

Set method for Shower Shape values.

Definition at line 215 of file Egamma_v1.cxx.

215 {
216 const xAOD::Egamma_v1::Accessor< float >* acc = showerShapeAccessorV1( information );
217 if( !acc ) return false;
218 // Set the value:
219 ( *acc )(*this) = value;
220 return true;
221
222}
const SG::AuxElement::Accessor< float > * showerShapeAccessorV1(xAOD::EgammaParameters::ShowerShapeType type)
Explicit Instantiation of Template.

◆ setStore() [1/3]

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

Set the store associated with this object.

Parameters
storeThe 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
storeLink to the new store.

Definition at line 269 of file AuxElement.cxx.

270{
271 AuxElementStandaloneData* data = setStore1 (store);
272 if (store)
273 data->setStore (store);
274}
char data[hepevt_bytes_allocation_ATLAS]
Definition HepEvt.cxx:11
AuxElementStandaloneData * setStore1(const SG::IConstAuxStore *store)
Set the store associated with this object.

◆ setStore() [2/3]

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

Set the store associated with this object.

Parameters
storeThe 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 241 of file AuxElement.cxx.

242{
243 AuxElementStandaloneData* data = setStore1 (store);
244 if (store)
245 data->setStore (store);
246}

◆ setStore() [3/3]

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

Set the store associated with this object.

Parameters
storeThe 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 257 of file AuxElement.cxx.

258{
259 AuxElementStandaloneData* data = setStore1 (store);
260 if (store)
261 data->setStore (store);
262}

◆ setStore1()

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

Set the store associated with this object.

Parameters
storeThe new store.

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

Parameters
storeThe new store.

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

Definition at line 461 of file AuxElement.cxx.

462{
463 if (store) {
464 // Want this object be standalone.
465 if (!m_container) {
466 // Not in a container (and no private store). Make a new object.
467 AuxElementStandaloneData* data = new AuxElementStandaloneData;
470 return data;
471 }
472 if (usingStandaloneStore()) {
473 // Standalone --- return existing object.
474 return static_cast<AuxElementStandaloneData*> (container());
475 }
476 // Otherwise, it's an error.
477 throw ExcBadPrivateStore ("Attempt to attach a standalone store to an "
478 "object in a container or with a private store.");
479 }
480
481 else {
482 // Getting rid of a standalone store.
483 if (usingStandaloneStore()) {
485 delete m_container;
486 m_container = 0;
487 }
488 else if (m_container != 0)
489 throw ExcBadPrivateStore ("Attempt to remove a standalone store from an "
490 "object in a container or with a private store.");
491 return 0;
492 }
493}
bool usingStandaloneStore() const
Test to see if this object is currently using a standalone store.

◆ setVertexCaloMatchValue()

bool xAOD::Photon_v1::setVertexCaloMatchValue ( const float value,
const EgammaParameters::VertexCaloMatchType information )

Set method for CaloMatch values.

◆ setVertexLinks()

void xAOD::Photon_v1::setVertexLinks ( const VxELVec_t & links)

set Pointer to the xAOD::vertex/vertices that match the photon candidate

◆ showerShapeValue() [1/2]

float xAOD::Egamma_v1::showerShapeValue ( const EgammaParameters::ShowerShapeType information) const
inherited

Accessor to ShowerShape values , this just returns the value without internaly checking if it exists.

Will lead to an exception if the variable is not available

Definition at line 209 of file Egamma_v1.cxx.

209 {
210 const xAOD::Egamma_v1::Accessor< float >* acc = showerShapeAccessorV1( information );
211 if(!acc ) throw std::runtime_error( "Unknown/Unavailable Shower Shape type requested" );
212 return ( *acc )(*this);
213}

◆ showerShapeValue() [2/2]

bool xAOD::Egamma_v1::showerShapeValue ( float & value,
const EgammaParameters::ShowerShapeType information ) const
inherited

Accessor for ShowerShape values.

shower shapes

Definition at line 196 of file Egamma_v1.cxx.

196 {
197 const xAOD::Egamma_v1::Accessor< float >* acc = showerShapeAccessorV1( information );
198 if( !acc ) {
199 return false;
200 }
201 if(!acc->isAvailable(*this) ) {
202 return false;
203 }
204 // Retrieve the value:
205 value = ( *acc )(*this);
206 return true;
207}

◆ 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()

Type::ObjectType xAOD::Photon_v1::type ( ) const
finaloverridevirtual

The type of the object as a simple enumeration.

Implements xAOD::Egamma_v1.

Definition at line 37 of file Photon_v1.cxx.

37 {
38
39 return Type::Photon;
40 }

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const
inherited

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

Definition at line 280 of file AuxElement.cxx.

281{
282 return havePrivateData() &&
283 typeid(*m_container) == typeid(AuxElementPrivateData);
284}

◆ 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 290 of file AuxElement.cxx.

291{
292 return havePrivateData() &&
293 typeid(*m_container) == typeid(AuxElementStandaloneData);
294}

◆ vertex()

const xAOD::Vertex * xAOD::Photon_v1::vertex ( size_t index = 0) const

Pointer to the xAOD::Vertex/es that match the photon candidate.

Definition at line 61 of file Photon_v1.cxx.

61 {
62
63 if( index >= nVertices() ) {
64 return nullptr;
65 }
66 const VxELVec_t& links = vertexLinks();
67 if( ! links[ index ].isValid() ) {
68 return nullptr;
69 }
70 return *( links[ index ] );
71 }
std::vector< ElementLink< VertexContainer > > VxELVec_t
Helper type definition.
Definition Photon_v1.h:94
const VxELVec_t & vertexLinks() const
Get all vertex links.
size_t nVertices() const
Return the number xAOD::Vertex/vertices that match the photon candidate.

◆ vertexCaloMatchValue() [1/2]

float xAOD::Photon_v1::vertexCaloMatchValue ( const EgammaParameters::VertexCaloMatchType information) const

Accessor to vertex to Calo Match Values , this just returns the value without internaly checking if it exists.

Will lead to an exception if the information is not available

◆ vertexCaloMatchValue() [2/2]

bool xAOD::Photon_v1::vertexCaloMatchValue ( float & value,
const EgammaParameters::VertexCaloMatchType information ) const

Accessor to vertex to Calo Match Values If 'information' is stored in this xAOD::Egamma and is of the correct type, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'.

◆ vertexLink()

const ElementLink< VertexContainer > & xAOD::Photon_v1::vertexLink ( size_t index = 0) const

ElementLink to the xAOD::vertex/es that match the electron candidate.

Definition at line 74 of file Photon_v1.cxx.

74 {
75
76 if( index >= nVertices() ) {
77 static const ElementLink< VertexContainer > dummy;
78 return dummy;
79 }
80 return vertexLinks()[ index ];
81 }

◆ vertexLinks()

const VxELVec_t & xAOD::Photon_v1::vertexLinks ( ) const

Get all vertex links.

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 335 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

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 959 of file AuxElement.h.


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