A detector object made of other lower level object(s) More...

#include <FlowElement_v1.h>

Inheritance diagram for xAOD::FlowElement_v1:

Collaboration diagram for xAOD::FlowElement_v1:

Public Types
enum	SignalType { Neutral = 0x1000, Charged = 0x2000, Combined = 0x4000, CaloCluster = Neutral \| 0x0100, Track = Charged \| 0x0200, Muon = Charged \| 0x0400, PFlow = 0x0010, NeutralPFlow = Neutral \| PFlow, ChargedPFlow = Charged \| PFlow, TCC = 0x0020, NeutralTCC = Neutral \| TCC, ChargedTCC = Charged \| TCC, UFO = 0x0001, NeutralUFO = Neutral \| UFO, ChargedUFO = Charged \| UFO, Unknown = 0x0000 }
	Enum to encode the nature of the object this FlowElement represents. More...

enum	MatchedPVType { Undefined = 0x00, HardScatter = 0x10, Pileup = 0x20, PileupSideBand = 0x21 }
	Enum to encode high-level information on the vertex associated to this FlowElement. More...

typedef unsigned long	signal_t

typedef short	vertex_t

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

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
	IParticle ()=default

	IParticle (const IParticle &)=default

	IParticle (IParticle &&)=delete

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


virtual double	pt () const override

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

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

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

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

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

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

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

void	setP4 (float pt, float eta, float phi, float m)

void	setP4 (const FourMom_t &p4)


signal_t	signalType () const

void	setSignalType (signal_t t)


bool	isMatchedToPV (MatchedPVType vxtype=HardScatter) const

vertex_t	vertexType () const

void	setVertexType (vertex_t t)


bool	isCharged () const

float	charge () const

void	setCharge (float c)


std::vector< const xAOD::IParticle * >	chargedObjects () const

std::vector< std::pair< const xAOD::IParticle *, float > >	chargedObjectsAndWeights () const

std::size_t	nChargedObjects () const

const xAOD::IParticle *	chargedObject (std::size_t i) const

std::pair< const xAOD::IParticle *, float >	chargedObjectAndWeight (std::size_t i) const


const std::vector< ElementLink< IParticleContainer > > &	chargedObjectLinks () const
	Access to the EL. More...

const std::vector< float > &	chargedObjectWeights () const

void	setChargedObjectLinks (const std::vector< ElementLink< IParticleContainer >> &elV)

void	setChargedObjectLinks (const std::vector< ElementLink< IParticleContainer >> &elV, const std::vector< float > &wV)


std::vector< const xAOD::IParticle * >	otherObjects () const

std::vector< std::pair< const xAOD::IParticle *, float > >	otherObjectsAndWeights () const

std::size_t	nOtherObjects () const

const xAOD::IParticle *	otherObject (std::size_t i) const

std::pair< const xAOD::IParticle *, float >	otherObjectAndWeight (std::size_t i) const


const std::vector< ElementLink< IParticleContainer > > &	otherObjectLinks () const

const std::vector< float > &	otherObjectWeights () const

void	setOtherObjectLinks (const std::vector< ElementLink< IParticleContainer >> &elV)

void	setOtherObjectLinks (const std::vector< ElementLink< IParticleContainer >> &elV, const std::vector< float > &wV)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrivateStoreState	m_privateStoreState

Detailed Description

A detector object made of other lower level object(s)

This class is intended to describe reconstruction objects coumpound of lower level detector objects. Typically it provides links to tracks and calo clusters such as is needed for particle flow objects.

The class is kept minimal and very generic so it can cover many use cases, including a generic type to describe jet constituents.

Definition at line 25 of file FlowElement_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 522 of file AuxElement.h.

◆ ConstAccessor

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

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

inherited

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

◆ FourMom_t

typedef TLorentzVector xAOD::IParticle::FourMom_t

Definition of the 4-momentum type.

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

◆ signal_t

typedef unsigned long xAOD::FlowElement_v1::signal_t

Definition at line 30 of file FlowElement_v1.h.

◆ TypelessConstAccessor

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

inherited

Definition at line 516 of file AuxElement.h.

◆ vertex_t

typedef short xAOD::FlowElement_v1::vertex_t

Definition at line 31 of file FlowElement_v1.h.

Member Enumeration Documentation

◆ MatchedPVType

enum xAOD::FlowElement_v1::MatchedPVType

Enum to encode high-level information on the vertex associated to this FlowElement.

Enumerator
Undefined
HardScatter
Pileup
PileupSideBand

Definition at line 62 of file FlowElement_v1.h.

                        {
             Undefined = 0x00, HardScatter = 0x10, Pileup = 0x20, PileupSideBand = 0x21
     };

◆ 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,
   };

◆ SignalType

enum xAOD::FlowElement_v1::SignalType

Enum to encode the nature of the object this FlowElement represents.

Enumerator
Neutral
Charged
Combined
CaloCluster
Track
Muon
PFlow
NeutralPFlow
ChargedPFlow
TCC
NeutralTCC
ChargedTCC
UFO
NeutralUFO
ChargedUFO
Unknown

Definition at line 35 of file FlowElement_v1.h.

                     { 
              // global characteristics
              Neutral      = 0x1000,
              Charged      = 0x2000,
              Combined     = 0x4000, //needed??
  
              // detector level signals and flow objects
              CaloCluster  = Neutral | 0x0100,
              Track        = Charged | 0x0200,
              Muon         = Charged | 0x0400,
              PFlow        = 0x0010,
              NeutralPFlow = Neutral | PFlow,
              ChargedPFlow = Charged | PFlow,
  
              // higher level flow objects
              TCC          = 0x0020,
              NeutralTCC   = Neutral | TCC,
              ChargedTCC   = Charged | TCC,
              UFO          = 0x0001,
              NeutralUFO   = Neutral | UFO,
              ChargedUFO   = Charged | UFO,
  
              // unknown
              Unknown      = 0x0000
     };

Member Function Documentation

◆ auxdata() [1/4]

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

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

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 >

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 modifyable reference to the decoration

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

                                                   {
  
          return SG::AuxElement::auxdata< T >( name, clsname );
       }

◆ auxdata() [4/4]

template<class T >

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 115 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                               {
  
          return SG::AuxElement::auxdata< T >( name, clsname );
       }

◆ auxdataConst() [1/2]

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

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

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

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

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.

◆ charge()

float xAOD::FlowElement_v1::charge ( ) const

◆ chargedObject()

const xAOD::IParticle * xAOD::FlowElement_v1::chargedObject ( std::size_t i ) const

Definition at line 127 of file FlowElement_v1.cxx.

                                                                        {
     const auto & elV = chargedObjectLinks();
     // should we check if i >= size() and throw ourselves ? or trust the user ?
     return elV[i].isValid()? *(elV[i]) : nullptr ;
   }

◆ chargedObjectAndWeight()

std::pair< const xAOD::IParticle *, float > xAOD::FlowElement_v1::chargedObjectAndWeight ( std::size_t i ) const

Definition at line 133 of file FlowElement_v1.cxx.

                                                                                                   {
     const auto & elV = chargedObjectLinks();
     const std::vector<float> & wV = chargedObjectWeights();
  
     if( elV[i].isValid() )  return { *(elV[i]), wV[i] } ;
     else return {nullptr, wV[i] } ;    
   }

◆ chargedObjectLinks()

const std::vector<ElementLink<IParticleContainer> >& xAOD::FlowElement_v1::chargedObjectLinks ( ) const

Access to the EL.

◆ chargedObjects()

std::vector< const xAOD::IParticle * > xAOD::FlowElement_v1::chargedObjects ( ) const

Access directly the charged underlying IParticle (typically : TrackParticle) nullptr are returned if the ElementLink to the IParticle are invalid (ex: after thinning)

Definition at line 94 of file FlowElement_v1.cxx.

                                                                        {
     const auto & elV = chargedObjectLinks();
     std::vector<const xAOD::IParticle*> result;
     result.reserve( elV.size() );
     for(const auto& el: elV ){
       result.push_back( el.isValid() ? *el : nullptr ) ; 
     }
     return result;
   }

◆ chargedObjectsAndWeights()

std::vector< std::pair< const xAOD::IParticle *, float > > xAOD::FlowElement_v1::chargedObjectsAndWeights ( ) const

Definition at line 104 of file FlowElement_v1.cxx.

                                                                                                  {
  
     const auto & elV = chargedObjectLinks();
     const std::vector<float> & wV = chargedObjectWeights();
     std::vector< std::pair<const xAOD::IParticle*,float> > result;
     result.reserve( elV.size() );
     if(wV.empty()) {
       for(const auto& el: elV ){
     result.emplace_back( el.isValid() ? *el : nullptr , 1. ) ; 
       }
     } else {
       for(size_t i=0;i<elV.size();i++){
     const xAOD::IParticle* p = elV[i].isValid() ? *(elV[i]) : nullptr;
     result.emplace_back(p , wV[i] ); 
       }
     }      
     return result;
   }

◆ chargedObjectWeights()

const std::vector<float>& xAOD::FlowElement_v1::chargedObjectWeights ( ) const

◆ clearAux()

void SG::AuxElement::clearAux ( )

privateinherited

Clear all aux data associated with this element.

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

Definition at line 535 of file AuxElement.cxx.

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

◆ clearCache()

void SG::AuxElement::clearCache ( )

inherited

Clear the cached aux data pointers.

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

Definition at line 319 of file AuxElement.cxx.

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

◆ clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

inherited

Clear all decorations.

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

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

Definition at line 385 of file AuxElement.cxx.

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

◆ container() [1/2]

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

inherited

Return the container holding this element.

◆ container() [2/2]

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

inherited

Return the container holding this element.

◆ copyAux()

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

privateinherited

Copy aux data from another object.

Parameters

other The object from which to copy.

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

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

Definition at line 561 of file AuxElement.cxx.

 {
   if (!m_container) return;
   if (!m_container->hasStore()) return;
   if (!m_container->hasNonConstStore())
     throw SG::ExcConstAuxData ("copyAux");
  
   const SG::AuxVectorData* ocont = other.container();
  
   if (!ocont || !ocont->hasStore()) {
     this->clearAux();
     return;
   }
  
   size_t oindex = other.index();
   SG::auxid_set_t other_ids = ocont->getAuxIDs();
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  
   SG::AuxVectorData& cont = *container();
   for (SG::auxid_t auxid : other_ids) {
     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);
     }
   }
 }

◆ e()

double xAOD::FlowElement_v1::e ( ) const

overridevirtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 25 of file FlowElement_v1.cxx.

                                  {
     return PtEtaPhiMVector(pt(), eta(), phi(), m() ).E();
   }

◆ eta()

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

overridevirtual

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

Implements xAOD::IParticle.

◆ getAuxIDs()

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

inherited

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

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

Definition at line 335 of file AuxElement.cxx.

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

◆ getConstStore()

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

inherited

Return the current store, as a const interface.

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

Definition at line 284 of file AuxElement.cxx.

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

◆ getStore()

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

inherited

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

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

Definition at line 299 of file AuxElement.cxx.

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

◆ hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

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

◆ hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

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

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

Definition at line 368 of file AuxElement.cxx.

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

◆ hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

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

Definition at line 355 of file AuxElement.cxx.

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

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

◆ index() [1/2]

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

◆ index() [2/2]

size_t SG::IAuxElement::index

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

◆ IParticle() [1/3]

xAOD::IParticle::IParticle

default

◆ IParticle() [2/3]

xAOD::IParticle::IParticle

default

◆ IParticle() [3/3]

xAOD::IParticle::IParticle

delete

◆ isAvailable()

template<class T >

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 131 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                               {
  
          return SG::AuxElement::isAvailable< T >( name, clsname );
       }

◆ isAvailableWritable() [1/2]

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

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 >

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 147 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                                       {
  
          return SG::AuxElement::isAvailableWritable< T >( name, clsname );
       }

◆ isAvailableWritableAsDecoration()

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

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.

◆ isCharged()

bool xAOD::FlowElement_v1::isCharged ( ) const

Access charge

Definition at line 56 of file FlowElement_v1.cxx.

56 { return !bool( signalType()& Neutral );}

◆ isMatchedToPV()

bool xAOD::FlowElement_v1::isMatchedToPV ( MatchedPVType vxtype = HardScatter ) const

Acess vertex types

Definition at line 63 of file FlowElement_v1.cxx.

                                                                 {
     return (vertexType()==vxtype);
   }

◆ m()

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

overridevirtual

The invariant mass of the particle.

Implements xAOD::IParticle.

◆ makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )

inherited

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

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

Definition at line 172 of file AuxElement.cxx.

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

◆ makePrivateStore() [2/3]

template<class U1 >

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

inherited

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

Parameters

other The object from which aux data should be copied.

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

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

◆ makePrivateStore() [3/3]

template<class U1 >

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

inherited

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

Parameters

other The object from which aux data should be copied.

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

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

◆ makePrivateStore1() [1/2]

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

privateinherited

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

Parameters

other The object from which aux data should be copied.

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

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

Definition at line 521 of file AuxElement.cxx.

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

◆ makePrivateStore1() [2/2]

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

privateinherited

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

Parameters

other The object from which aux data should be copied.

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

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

◆ nChargedObjects()

std::size_t xAOD::FlowElement_v1::nChargedObjects ( ) const

Definition at line 123 of file FlowElement_v1.cxx.

                                                   {
     return chargedObjectLinks().size();
   }

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ nOtherObjects()

std::size_t xAOD::FlowElement_v1::nOtherObjects ( ) const

Definition at line 192 of file FlowElement_v1.cxx.

                                                 {
     return otherObjectLinks().size();
   }

◆ otherObject()

const xAOD::IParticle * xAOD::FlowElement_v1::otherObject ( std::size_t i ) const

Definition at line 196 of file FlowElement_v1.cxx.

                                                                      {
     const auto & elV = otherObjectLinks();
     // should we check if i >= size() and throw ourselves ? or trust the user ?
     return elV[i].isValid()? *(elV[i]) : nullptr ;
   }

◆ otherObjectAndWeight()

std::pair< const xAOD::IParticle *, float > xAOD::FlowElement_v1::otherObjectAndWeight ( std::size_t i ) const

Definition at line 202 of file FlowElement_v1.cxx.

                                                                                                  {
     const auto & elV = otherObjectLinks();
     const std::vector<float> & wV = otherObjectWeights();
  
     if( elV[i].isValid() )  return { *(elV[i]), wV[i] };
     else return {nullptr, wV[i] } ;    
   }

◆ otherObjectLinks()

const std::vector<ElementLink<IParticleContainer> >& xAOD::FlowElement_v1::otherObjectLinks ( ) const

Access to the EL

◆ otherObjects()

std::vector< const xAOD::IParticle * > xAOD::FlowElement_v1::otherObjects ( ) const

Access directly the 'other' underlying IParticle (typically neutral CaloCluster) nullptr are returned if the ElementLink to the IParticle are invalid (ex: after thinning)

Definition at line 163 of file FlowElement_v1.cxx.

                                                                      {
     const auto & elV = otherObjectLinks();
     std::vector<const xAOD::IParticle*> result;
     result.reserve( elV.size() );
     for(const auto& el: elV ){
       result.push_back( el.isValid() ? *el : nullptr ) ; 
     }
     return result;
   }

◆ otherObjectsAndWeights()

std::vector< std::pair< const xAOD::IParticle *, float > > xAOD::FlowElement_v1::otherObjectsAndWeights ( ) const

Definition at line 173 of file FlowElement_v1.cxx.

                                                                                                {
  
     const auto & elV = otherObjectLinks();
     const std::vector<float> & wV = otherObjectWeights();
     std::vector< std::pair<const xAOD::IParticle*,float> > result;
     result.reserve( elV.size() );
     if(wV.empty()) {
       for(const auto& el: elV ){
     result.emplace_back( el.isValid() ? *el : nullptr , 1. ) ; 
       }
     } else {
       for(size_t i=0;i<elV.size();i++){
     const xAOD::IParticle* p = elV[i].isValid() ? *(elV[i]) : nullptr;
     result.emplace_back(p , wV[i] ); 
       }
     }      
     return result;
   }

◆ otherObjectWeights()

const std::vector<float>& xAOD::FlowElement_v1::otherObjectWeights ( ) const

◆ p4()

FlowElement_v1::FourMom_t xAOD::FlowElement_v1::p4 ( ) const

overridevirtual

The full 4-momentum of the particle.

Implements xAOD::IParticle.

Definition at line 33 of file FlowElement_v1.cxx.

                                                    {
     FourMom_t p4;
     p4.SetPtEtaPhiE( pt(), eta(), phi(), e() );       
     return p4;
   }

◆ phi()

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

overridevirtual

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

Implements xAOD::IParticle.

◆ pt()

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

overridevirtual

kinematics (IParticle interface)

Implements xAOD::IParticle.

◆ rapidity()

double xAOD::FlowElement_v1::rapidity ( ) const

overridevirtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 29 of file FlowElement_v1.cxx.

                                         {
     return PtEtaPhiMVector(pt(), eta(), phi(), m() ).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 190 of file AuxElement.cxx.

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

◆ releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )

privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 398 of file AuxElement.cxx.

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

◆ setCharge()

void xAOD::FlowElement_v1::setCharge ( float c )

◆ setChargedObjectLinks() [1/2]

void xAOD::FlowElement_v1::setChargedObjectLinks ( const std::vector< ElementLink< IParticleContainer >> & elV )

◆ setChargedObjectLinks() [2/2]

void xAOD::FlowElement_v1::setChargedObjectLinks	(	const std::vector< ElementLink< IParticleContainer >> &	elV,
		const std::vector< float > &	wV
	)

◆ setConstStore()

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

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

◆ setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

◆ setIndex()

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

privateinherited

Set the index/container for this element.

Parameters

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

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

◆ setIndexPrivate()

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

privateinherited

Set the index/container for this element.

Parameters

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

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

Definition at line 462 of file AuxElement.cxx.

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

◆ setNonConstStore()

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

inherited

Synonym for setStore with IAuxStore.

Parameters

store The new store.

◆ setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )

privateinherited

Record that this element does not have private data.

◆ setOtherObjectLinks() [1/2]

void xAOD::FlowElement_v1::setOtherObjectLinks ( const std::vector< ElementLink< IParticleContainer >> & elV )

◆ setOtherObjectLinks() [2/2]

void xAOD::FlowElement_v1::setOtherObjectLinks	(	const std::vector< ElementLink< IParticleContainer >> &	elV,
		const std::vector< float > &	wV
	)

◆ setP4() [1/2]

void xAOD::FlowElement_v1::setP4 ( const FourMom_t & p4 )

Definition at line 51 of file FlowElement_v1.cxx.

                                                {
     setP4(p4.Pt(), p4.Eta(), p4.Phi(), p4.M());
   }

◆ setP4() [2/2]

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

Definition at line 39 of file FlowElement_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;     
  
   }

◆ setSignalType()

void xAOD::FlowElement_v1::setSignalType ( signal_t t )

◆ setStore() [1/3]

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

inherited

Set the store associated with this object.

Parameters

store The new store.

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

Parameters

store Link to the new store.

Definition at line 249 of file AuxElement.cxx.

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

◆ setStore() [2/3]

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

inherited

Set the store associated with this object.

Parameters

store The new store.

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

Definition at line 221 of file AuxElement.cxx.

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

◆ setStore() [3/3]

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

inherited

Set the store associated with this object.

Parameters

store The new store.

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

Definition at line 237 of file AuxElement.cxx.

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

◆ setStore1()

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

privateinherited

Set the store associated with this object.

Parameters

store The new store.

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

Parameters

store The new store.

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

Definition at line 418 of file AuxElement.cxx.

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

◆ setVertexType()

void xAOD::FlowElement_v1::setVertexType ( vertex_t t )

◆ signalType()

signal_t xAOD::FlowElement_v1::signalType ( ) const

Access signal type

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

overridevirtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 68 of file FlowElement_v1.cxx.

                                             {
     return Type::FlowElement;
   }

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

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

Definition at line 260 of file AuxElement.cxx.

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

◆ usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

inherited

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

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

Definition at line 270 of file AuxElement.cxx.

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

◆ vertexType()

vertex_t xAOD::FlowElement_v1::vertexType ( ) const

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 298 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 883 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

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ Decorator

◆ FourMom_t

◆ signal_t

◆ TypelessConstAccessor

◆ vertex_t

Member Enumeration Documentation

◆ MatchedPVType

◆ PrivateStoreState

◆ SignalType

Member Function Documentation

◆ auxdata() [1/4]

◆ auxdata() [2/4]

◆ auxdata() [3/4]

◆ auxdata() [4/4]

◆ auxdataConst() [1/2]

◆ auxdataConst() [2/2]

◆ auxdecor() [1/2]

◆ auxdecor() [2/2]

◆ charge()

◆ chargedObject()

◆ chargedObjectAndWeight()

◆ chargedObjectLinks()

◆ chargedObjects()

◆ chargedObjectsAndWeights()

◆ chargedObjectWeights()

◆ clearAux()

◆ clearCache()

◆ clearDecorations()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ e()

◆ eta()

◆ getAuxIDs()

◆ getConstStore()

◆ getStore()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ havePrivateData()

◆ index() [1/2]

◆ index() [2/2]

◆ IParticle() [1/3]

◆ IParticle() [2/3]

◆ IParticle() [3/3]

◆ isAvailable()

◆ isAvailableWritable() [1/2]

◆ isAvailableWritable() [2/2]

◆ isAvailableWritableAsDecoration()

◆ isCharged()

◆ isMatchedToPV()

◆ m()

◆ makePrivateStore() [1/3]

◆ makePrivateStore() [2/3]

◆ makePrivateStore() [3/3]

◆ makePrivateStore1() [1/2]

◆ makePrivateStore1() [2/2]

◆ nChargedObjects()

◆ noPrivateData()

◆ nOtherObjects()

◆ otherObject()

◆ otherObjectAndWeight()

◆ otherObjectLinks()

◆ otherObjects()

◆ otherObjectsAndWeights()

◆ otherObjectWeights()

◆ p4()

◆ phi()

◆ pt()