#include <Egamma_v1.h>

Inheritance diagram for xAOD::Egamma_v1:

Collaboration diagram for xAOD::Egamma_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 >

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

void	assign (const AuxElement &other, bool warnUnlocked=false)
	Assignment. 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, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data. More...

template<class U1 >
void	makePrivateStore (const U1 *other, bool warnUnlocked=false)
	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...

const SG::auxid_set_t &	getDecorIDs () const
	Return a set of identifiers for decorations 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...

xAOD::Egamma Assignment operator
Egamma_v1 &	operator= (const Egamma_v1 &eg)
	Assignment Operator. Using the assignment of SG::AuxElement. 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...

xAOD::Egamma constructors
The xAOD::Egamma is not supposed to be created directly, only via xAOD::Electron and xAOD::Photon. xAOD::Egamma is an abstract class. It does not define the type() pure virtual function from IParticle The default constructors is protected
	Egamma_v1 ()
	Default constructor. More...

	Egamma_v1 (const Egamma_v1 &eg)
	Copy constructor (default implementation) 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 *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data. More...

void	makePrivateStore1 (const AuxElement *other, bool warnUnlocked)
	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, bool warnUnlocked=false)
	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

xAOD::IParticle functions
These are already virtual due to IParticle
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type. More...

virtual double	pt () const override final
	The transverse momentum ( $p_T$ ) of the particle. More...

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

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

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

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

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

virtual FourMom_t	p4 () const override final
	The full 4-momentum of the particle as a TLoretzVector. More...

virtual Type::ObjectType	type () const override=0
	The type of the object as a simple enumeration, remains pure virtual in e/gamma. More...

xAOD::Egamma 4-Mom functions
typedef ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > >	GenVecFourMom_t
	Base 4 Momentum type for egamma. More...

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

void	setP4 (float pt, float eta, float phi, float m)
	set the 4-vec More...

void	setPt (float pt)
	set the Pt More...

void	setEta (float eta)
	set the eta More...

void	setPhi (float phi)
	set the phi More...

void	setM (float m)
	set the Mass More...

xAOD::Egamma 4x4 Covariance Matrix
typedef Eigen::Matrix< float, 4, 4 >	EgammaCovMatrix_t
	4x4 Covariance Matrix in EtEtaPhiM (needs decision) More...

EgammaCovMatrix_t	covMatrix () const
	Returns the 4x4 symmetric covariance matrix . More...

void	setCovMatrix (const EgammaCovMatrix_t &cov)
	set the 4x4 symmetric covariance matrix . More...

xAOD::Egamma Pointer to CaloClusters
typedef std::vector< ElementLink< CaloClusterContainer > >	CLELVec_t
	Helper type definition. More...

size_t	nCaloClusters () const
	Return the number of xAOD::CaloClusters that define the electron candidate. More...

const xAOD::CaloCluster *	caloCluster (size_t index=0) const
	Pointer to the xAOD::CaloCluster/s that define the electron candidate. More...

const ElementLink< CaloClusterContainer > &	caloClusterLink (size_t index=0) const
	ElementLink to the xAOD::CaloCluster/s that match the electron candidate. More...

const CLELVec_t &	caloClusterLinks () const
	Get all cluster links. More...

void	setCaloClusterLinks (const CLELVec_t &links)
	set Pointer to the xAOD::CaloCluster More...

Detailed Description

Definition at line 56 of file Egamma_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 572 of file AuxElement.h.

◆ CLELVec_t

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

Helper type definition.

Definition at line 174 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

4x4 Covariance Matrix in EtEtaPhiM (needs decision)

Definition at line 148 of file Egamma_v1.h.

◆ FourMom_t

typedef IParticle::FourMom_t xAOD::Egamma_v1::FourMom_t

Definition of the 4-momentum type.

Definition at line 107 of file Egamma_v1.h.

◆ GenVecFourMom_t

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

Base 4 Momentum type for egamma.

Definition at line 122 of file Egamma_v1.h.

◆ TypelessConstAccessor

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

inherited

Definition at line 566 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

◆ Egamma_v1() [1/2]

xAOD::Egamma_v1::Egamma_v1 ( )

protected

Default constructor.

Definition at line 47 of file Egamma_v1.cxx.

48 : IParticle() {

49 }

◆ Egamma_v1() [2/2]

xAOD::Egamma_v1::Egamma_v1 ( const Egamma_v1 & eg )

protecteddefault

Copy constructor (default implementation)

Member Function Documentation

◆ addAuthor()

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

add author

Definition at line 172 of file Egamma_v1.cxx.

                                             {
   static const Accessor< uint16_t > acc( "author" );
   uint16_t author = acc(*this);
   acc(*this) = author | newAuthor;
 }

◆ ambiguousObject()

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

Get ambiguous.

ambiguous

Definition at line 193 of file Egamma_v1.cxx.

                                                   {
  
    if( ! ambiguityLinkAcc.isAvailable( *this ) ) {
       return nullptr;
    }
    const ElementLink< xAOD::EgammaContainer >& link = ambiguityLinkAcc( *this );
    if( ! link.isValid() ) {
       return nullptr;
    }
    return *link;
 }

◆ assign()

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

inherited

Assignment.

Parameters

other	The object from which we're assigning.
warnUnlocked	If 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

Get author.

egamma author

Definition at line 166 of file Egamma_v1.cxx.

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

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

◆ caloCluster()

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

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

Definition at line 388 of file Egamma_v1.cxx.

                                                                   {
  
   if( index >= nCaloClusters() ) {
     return nullptr;
   }
   const CLELVec_t& cls = caloClusterLinks();
   if( ! cls[ index ].isValid() ) {
     return nullptr;
   }
   return *( cls[ index ] );
 }

◆ caloClusterLink()

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

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

Definition at line 401 of file Egamma_v1.cxx.

                                                {
  
   if( index >= nCaloClusters() ) {
     static const ElementLink< CaloClusterContainer > dummy;
     return dummy;
   }
   return caloClusterLinks()[ index ];
 }

◆ caloClusterLinks()

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

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.

 {
   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 339 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 428 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,
		bool	warnUnlocked = `false`
	)

privateinherited

Copy aux data from another object.

Parameters

other	The object from which to copy.
warnUnlocked	If 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 607 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();
 #ifndef XAOD_STANDALONE
   SG::auxid_set_t other_decors = ocont->getDecorIDs();
 #endif
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  
   SG::AuxVectorData& cont = *container();
   for (SG::auxid_t auxid : other_ids) {
 #ifndef XAOD_STANDALONE
     if (other_decors.test (auxid)) {
       // Don't copy decorations --- another thread may be modifying them.
       other_ids.reset (auxid);
       // Warn if we skip a decoration (except for mcEventWeights,
       // for which this is expected).
       if (warnUnlocked && r.getName(auxid) != "mcEventWeights") {
         std::ostringstream ss;
         ss << "skipped unlocked decoration " << r.getName(auxid)
            << " (" << auxid << ")";
         ATHCONTAINERS_WARNING("copyAux", ss.str());
       }
     }
     else
 #endif
     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);
     }
   }
 }

◆ covMatrix()

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

Returns the 4x4 symmetric covariance matrix .

Definition at line 135 of file Egamma_v1.cxx.

                                                      {
  
   static const Accessor< std::vector<float> > acc( "EgammaCovarianceMatrix" );
   EgammaCovMatrix_t cov;
   cov.setZero();
  
   if(!acc.isAvailable(*this) ) {
     return cov;
   }
   const std::vector<float>& v = acc(*this);
   size_t size= v.size();
   if(size==16){
     //up to 21.0.11
     cov = Eigen::Map<const EgammaCovMatrix_t> (v.data());
   }
   else {
     //from >21.0.11
     EgammaCovMatrix_t cov;
     MatrixHelpers::expand(v.begin(),v.end(),cov );
   }
   return cov;
 }

◆ e()

double xAOD::Egamma_v1::e ( ) const

finaloverridevirtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 90 of file Egamma_v1.cxx.

                          {
   return genvecP4().E();
 }

◆ eta()

double xAOD::Egamma_v1::eta ( ) const

finaloverridevirtual

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

Implements xAOD::IParticle.

Definition at line 70 of file Egamma_v1.cxx.

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

◆ genvecP4()

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

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

Depends on return value optimization.

Definition at line 86 of file Egamma_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 355 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 304 of file AuxElement.cxx.

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

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

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

◆ 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 319 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 411 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 398 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.

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

◆ isGoodOQ()

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

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

Object Quality.

Definition at line 236 of file Egamma_v1.cxx.

                                             {
   static const Accessor< uint32_t > acc( "OQ" );
   uint32_t OQ = acc(*this);
   return (OQ & mask)==0;
 }

◆ isolation() [1/2]

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

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 266 of file Egamma_v1.cxx.

                                                                      {
   const SG::AuxElement::Accessor< float >* acc = getIsolationAccessor( information );
   if( !acc ) throw std::runtime_error( "Unknown/Unavailable Isolation type requested" );
   return  ( *acc )(*this);
 }

◆ isolation() [2/2]

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

Accessor for Isolation values.

Isolation value.

Definition at line 253 of file Egamma_v1.cxx.

                                                                                   {
   const SG::AuxElement::Accessor< float >* acc = getIsolationAccessor( information );
   if( !acc ) {
     return false;
   }
   if(!acc->isAvailable(*this) ) {
     return  false;
   }
   // Retrieve the value:
   value = ( *acc )(*this);
   return true;
 }

◆ isolationCaloCorrection() [1/4]

float xAOD::Egamma_v1::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.

Will lead to an exception if the information is not available

Definition at line 292 of file Egamma_v1.cxx.

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

◆ isolationCaloCorrection() [2/4]

bool xAOD::Egamma_v1::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.

Isolation corrections.

Definition at line 281 of file Egamma_v1.cxx.

                                                                                           {
   const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr,param);
   if(!acc.isAvailable(*this) ) {
     return  false;
   }
   // Retrieve the value:
   value = acc(*this);
   return true;
 }

◆ isolationCaloCorrection() [3/4]

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

Accessor for type depended Isolation Calo correction.

Definition at line 308 of file Egamma_v1.cxx.

                                                                                                                    {
   const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(type,corr);
   if(!acc.isAvailable(*this) ) {
     return  false;
   }
   // Retrieve the value:
   value = acc(*this);
   return true;
 }

◆ isolationCaloCorrection() [4/4]

float xAOD::Egamma_v1::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.

Will lead to an exception if the information is not available

Definition at line 318 of file Egamma_v1.cxx.

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

◆ isolationCorrectionBitset() [1/2]

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

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 363 of file Egamma_v1.cxx.

                                                                                           {
   const SG::AuxElement::Accessor< uint32_t > acc = getIsolationCorrectionBitsetAccessor( flavour );
   if( !acc.isAvailable(*this) ) {throw std::runtime_error( "Unknown/Unavailable Isolation BitSet requested" );}
   return  {acc(*this)};
 }

◆ isolationCorrectionBitset() [2/2]

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

Accessor for Isolation corection Bitset.

Definition at line 353 of file Egamma_v1.cxx.

                                                                                                         {
   const SG::AuxElement::Accessor< uint32_t > acc = getIsolationCorrectionBitsetAccessor( flavour );
   if(!acc.isAvailable(*this) ) {
     return false;
   }
   // Retrieve the value:
   value =  std::bitset<32>(acc(*this));
   return true;
 }

◆ isolationTrackCorrection() [1/2]

float xAOD::Egamma_v1::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.

Will lead to an exception if the information is not available

Definition at line 340 of file Egamma_v1.cxx.

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

◆ isolationTrackCorrection() [2/2]

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

Accessor for Isolation Track correction.

Definition at line 330 of file Egamma_v1.cxx.

                                                                                                                                      {
   const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr);
   if(!acc.isAvailable(*this) ) {
     return  false;
   }
   // Retrieve the value:
   value = acc(*this);
   return true;
 }

◆ isolationValue() [1/2]

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

inline

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 263 of file Egamma_v1.h.

                                                                   {
  
       return isolation(information);
     }

◆ isolationValue() [2/2]

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

inline

old Accessor for Isolation values.

Definition at line 257 of file Egamma_v1.h.

                                                                                  {
  
       return isolation(value,information);
     }

◆ likelihoodValue() [1/2]

float xAOD::Egamma_v1::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.

◆ likelihoodValue() [2/2]

bool xAOD::Egamma_v1::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'.

◆ m()

double xAOD::Egamma_v1::m ( ) const

finaloverridevirtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 80 of file Egamma_v1.cxx.

                           {
   static const Accessor< float> acc( "m" );
   return acc(*this);
 }

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

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

inherited

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

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If 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

other	The object from which aux data should be copied.
warnUnlocked	If 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

other	The object from which aux data should be copied.
warnUnlocked	If 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.

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

◆ 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

other	The object from which aux data should be copied.
warnUnlocked	If 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

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

Implementation of the CaloCluster accessor functions.

Definition at line 377 of file Egamma_v1.cxx.

                                       {
  
   static const SG::AuxElement::Accessor< Egamma_v1::CLELVec_t >
     clusterAcc( "caloClusterLinks" );
  
   if( clusterAcc.isAvailable(*this) ) {
     return clusterAcc(*this).size();
   }
   return 0;
 }

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ operator=()

Egamma_v1 & xAOD::Egamma_v1::operator= ( const Egamma_v1 & eg )

Assignment Operator. Using the assignment of SG::AuxElement.

Definition at line 53 of file Egamma_v1.cxx.

                                                    {
  
   if (this != &eg){ // protect against invalid self-assignment
     if (!this->container() && !this->hasStore() ) {
       makePrivateStore();
     }
     this->IParticle::operator=( eg );
   }
   // by convention, always return *this
   return *this;
 }

◆ OQ()

uint32_t xAOD::Egamma_v1::OQ ( ) const

Return the object quality bit word.

Definition at line 242 of file Egamma_v1.cxx.

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

◆ p4()

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

finaloverridevirtual

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

Implements xAOD::IParticle.

Definition at line 98 of file Egamma_v1.cxx.

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

◆ passSelection() [1/2]

bool xAOD::Egamma_v1::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'.

◆ passSelection() [2/2]

bool xAOD::Egamma_v1::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.

◆ phi()

double xAOD::Egamma_v1::phi ( ) const

finaloverridevirtual

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

Implements xAOD::IParticle.

Definition at line 75 of file Egamma_v1.cxx.

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

◆ pt()

double xAOD::Egamma_v1::pt ( ) const

finaloverridevirtual

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

Implements xAOD::IParticle.

Definition at line 65 of file Egamma_v1.cxx.

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

◆ rapidity()

double xAOD::Egamma_v1::rapidity ( ) const

finaloverridevirtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 94 of file Egamma_v1.cxx.

                                  {
   return genvecP4().Rapidity();
 }

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

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

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

◆ selectionisEM() [1/2]

unsigned int xAOD::Egamma_v1::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.

Definition at line 442 of file Egamma_v1.cxx.

                                                                 {
   const SG::AuxElement::Accessor< unsigned int > acc( isEM );
   return acc(*this);
 }

◆ selectionisEM() [2/2]

bool xAOD::Egamma_v1::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'.

Definition at line 433 of file Egamma_v1.cxx.

                                                                               {
   const SG::AuxElement::Accessor< unsigned int > acc( isEM );
   if(!acc.isAvailable(*this) ) {
     return  false;
   }
   value= acc(*this);
   return true;
 }

◆ setAuthor()

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

set author

Definition at line 178 of file Egamma_v1.cxx.

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

◆ setCaloClusterLinks()

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

set Pointer to the xAOD::CaloCluster

◆ setConstStore()

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

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ setCovMatrix()

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

set the 4x4 symmetric covariance matrix .

Definition at line 158 of file Egamma_v1.cxx.

                                                                  {
   //The internal storage is an std::vector
   static const Accessor< std::vector < float > > acc( "EgammaCovarianceMatrix" );
   //from >21.0.11
   MatrixHelpers::compress(cov,acc(*this));
 }

◆ setEta()

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

set the eta

Definition at line 120 of file Egamma_v1.cxx.

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

◆ 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 505 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
 }

◆ setIsolation()

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

set method for Isolation values.

Definition at line 272 of file Egamma_v1.cxx.

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

◆ setIsolationCaloCorrection() [1/2]

bool xAOD::Egamma_v1::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.

Definition at line 300 of file Egamma_v1.cxx.

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

◆ setIsolationCaloCorrection() [2/2]

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

set method for type depended Isolation Calo Corrections.

Definition at line 324 of file Egamma_v1.cxx.

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

◆ setIsolationCorrectionBitset()

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

Set method for Isolation corection Bitset.

Definition at line 369 of file Egamma_v1.cxx.

                                                                                                {
   const SG::AuxElement::Accessor< uint32_t > acc = getIsolationCorrectionBitsetAccessor( flavour );
   // Set the value:
   acc(*this) = value;
   return true;
 }

◆ setIsolationTrackCorrection()

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

Set method for Isolation Track Corrections.

Definition at line 346 of file Egamma_v1.cxx.

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

◆ setIsolationValue()

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

inline

old set method for Isolation values.

Definition at line 268 of file Egamma_v1.h.

                                                                            {
       return setIsolation(value,information);
     }

◆ setLikelihoodValue()

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

Set the LHValue as float.

◆ setM()

void xAOD::Egamma_v1::setM ( float m )

set the Mass

Definition at line 130 of file Egamma_v1.cxx.

                            {
   static const Accessor< float > acc( "m" );
   acc(*this) = m;
 }

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

◆ setOQ()

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

Set the object quality.

Definition at line 247 of file Egamma_v1.cxx.

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

◆ setP4()

void xAOD::Egamma_v1::setP4	(	float	pt,
		float	eta,
		float	phi,
		float	m
	)

set the 4-vec

Definition at line 104 of file Egamma_v1.cxx.

                                                             {
   static const Accessor< float > acc1( "pt" );
   acc1(*this) = pt;
   static const Accessor< float > acc2( "eta" );
   acc2(*this) = eta;
   static const Accessor< float > acc3( "phi" );
   acc3(*this) = phi;
   static const Accessor< float > acc4( "m" );
   acc4(*this) = m;
 }

◆ setPassSelection()

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

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

◆ setPhi()

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

set the phi

Definition at line 125 of file Egamma_v1.cxx.

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

◆ setPt()

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

set the Pt

Definition at line 115 of file Egamma_v1.cxx.

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

◆ setSelectionisEM()

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

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

Definition at line 447 of file Egamma_v1.cxx.

                                                                          {
   const SG::AuxElement::Accessor< unsigned int > acc( isEM );
   acc(*this)=value;
 }

◆ setShowerShapeValue()

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

Set method for Shower Shape values.

Definition at line 226 of file Egamma_v1.cxx.

                                                                                                  {
   const xAOD::Egamma_v1::Accessor< float >* acc = showerShapeAccessorV1( information );
   if( !acc ) return false;
   // Set the value:
   ( *acc )(*this) = value;
   return true;
  
 }

◆ 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 269 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 241 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 257 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 461 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;
   }
 }

◆ showerShapeValue() [1/2]

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

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 220 of file Egamma_v1.cxx.

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

◆ showerShapeValue() [2/2]

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

Accessor for ShowerShape values.

shower shapes

Definition at line 207 of file Egamma_v1.cxx.

                                                                                                        {
   const xAOD::Egamma_v1::Accessor< float >* acc = showerShapeAccessorV1( information );
   if( !acc ) {
     return false;
   }
   if(!acc->isAvailable(*this) ) {
     return  false;
   }
   // Retrieve the value:
   value = ( *acc )(*this);
   return true;
 }

◆ 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::Egamma_v1::type ( ) const

overridepure virtual

The type of the object as a simple enumeration, remains pure virtual in e/gamma.

Implements xAOD::IParticle.

Implemented in xAOD::Electron_v1, and xAOD::Photon_v1.

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

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

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

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

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

xAOD::IParticle functions

xAOD::Egamma 4-Mom functions

xAOD::Egamma 4x4 Covariance Matrix

xAOD::Egamma Pointer to CaloClusters

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ CLELVec_t

◆ ConstAccessor

◆ Decorator

◆ EgammaCovMatrix_t

◆ FourMom_t

◆ GenVecFourMom_t

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ Egamma_v1() [1/2]

◆ Egamma_v1() [2/2]

Member Function Documentation

◆ addAuthor()

◆ ambiguousObject()

◆ assign()

◆ author()

◆ auxdata() [1/4]

◆ auxdata() [2/4]

◆ auxdata() [3/4]

◆ auxdata() [4/4]

◆ auxdataConst() [1/2]

◆ auxdataConst() [2/2]

◆ auxdecor() [1/2]

◆ auxdecor() [2/2]

◆ caloCluster()

◆ caloClusterLink()

◆ caloClusterLinks()

◆ clearAux()

◆ clearCache()

◆ clearDecorations()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ covMatrix()

◆ e()

◆ eta()

◆ genvecP4()

◆ getAuxIDs()

◆ getConstStore()

◆ getDecorIDs()

◆ getStore()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ havePrivateData()

◆ index() [1/2]

◆ index() [2/2]

◆ isAvailable()

◆ isAvailableWritable() [1/2]

◆ isAvailableWritable() [2/2]

◆ isAvailableWritableAsDecoration()

◆ isGoodOQ()

◆ isolation() [1/2]

◆ isolation() [2/2]

◆ isolationCaloCorrection() [1/4]

◆ isolationCaloCorrection() [2/4]

◆ isolationCaloCorrection() [3/4]

◆ isolationCaloCorrection() [4/4]

◆ isolationCorrectionBitset() [1/2]

◆ isolationCorrectionBitset() [2/2]

◆ isolationTrackCorrection() [1/2]

◆ isolationTrackCorrection() [2/2]

◆ isolationValue() [1/2]

◆ isolationValue() [2/2]

◆ likelihoodValue() [1/2]