ATLAS Offline Software
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
xAOD::Muon_v1 Class Reference

Class describing a Muon. More...

#include <Muon_v1.h>

Inheritance diagram for xAOD::Muon_v1:
Collaboration diagram for xAOD::Muon_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

 Muon_v1 ()
 inject the enums More...
 
 Muon_v1 (const Muon_v1 &rhs)
 Copy constructor. More...
 
virtual ~Muon_v1 ()
 Destructor. More...
 
Muon_v1operator= (const Muon_v1 &rhs)
 Assignment operator. More...
 
bool isolationCaloCorrection (float &value, const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection type, const Iso::IsolationCorrectionParameter param) const
 Accessor for Isolation Calo correction. More...
 
float isolationCaloCorrection (const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection type, const Iso::IsolationCorrectionParameter param) const
 Accessor to Isolation Calo corrections , this just returns the correction without internaly checking if it exists. More...
 
bool setIsolationCaloCorrection (float value, const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection type, const Iso::IsolationCorrectionParameter param)
 set method for Isolation Calo Corrections. More...
 
bool isolationTrackCorrection (float &value, const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection type) const
 Accessor for Isolation Track correction. More...
 
float isolationTrackCorrection (const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection type) const
 Accessor to Isolation Track corrections , this just returns the correction without internaly checking if it exists. More...
 
bool setIsolationTrackCorrection (float value, const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection type)
 Set method for Isolation Track Corrections. More...
 
bool isolationCorrectionBitset (std::bitset< 32 > &value, const Iso::IsolationFlavour flavour) const
 Accessor for Isolation corection Bitset. More...
 
std::bitset< 32 > isolationCorrectionBitset (const Iso::IsolationFlavour flavour) const
 Accessor to Isolation corection Bitset , this just returns the bitset without internaly checking if it exists. More...
 
bool setIsolationCorrectionBitset (uint32_t value, const Iso::IsolationFlavour flavour)
 Set method for Isolation corection Bitset. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type auxdata (const std::string &name)
 Fetch an aux data variable, as a non-const reference. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type auxdata (const std::string &name) const
 Fetch an aux data variable, as a const reference. More...
 
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool isAvailableWritable (const std::string &name, const std::string &clsname="")
 Check if an aux variable is available for writing. More...
 
void assign (const AuxElement &other, bool warnUnlocked=false)
 Assignment. More...
 
const SG::AuxVectorDatacontainer () const
 Return the container holding this element. More...
 
SG::AuxVectorDatacontainer ()
 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::IConstAuxStoregetConstStore () const
 Return the current store, as a const interface. More...
 
SG::IAuxStoregetStore () const
 Return the current store, as a non-const interface. More...
 
void clearCache ()
 Clear the cached aux data pointers. More...
 
const SG::auxid_set_tgetAuxIDs () const
 Return a set of identifiers for existing data items for this object. More...
 
const SG::auxid_set_tgetDecorIDs () 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...
 

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

Static Private Member Functions

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

Private Attributes

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

Functions for getting and setting user properties

template<class T >
XAOD_AUXDATA_DEPRECATED T & auxdata (const std::string &name, const std::string &clsname="")
 Fetch an aux data variable, as a non-const reference. More...
 
template<class T >
XAOD_AUXDATA_DEPRECATED const T & auxdata (const std::string &name, const std::string &clsname="") const
 Fetch an aux data variable, as a const reference. More...
 
template<class T >
XAOD_AUXDATA_DEPRECATED bool isAvailable (const std::string &name, const std::string &clsname="") const
 Check if a user property is available for reading or not. More...
 
template<class T >
XAOD_AUXDATA_DEPRECATED bool isAvailableWritable (const std::string &name, const std::string &clsname="") const
 Check if a user property is available for writing or not. More...
 

IParticle functions

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

typedef IParticle::FourMom_t FourMom_t
 Definition of the 4-momentum type. More...
 
typedef ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > > GenVecFourMom_t
 Base 4 Momentum type for Muon. More...
 
virtual double pt () const
 The transverse momentum ( \(p_T\)) of the particle. More...
 
virtual double eta () const
 The pseudorapidity ( \(\eta\)) of the particle. More...
 
virtual double phi () const
 The azimuthal angle ( \(\phi\)) of the particle. More...
 
virtual double m () const
 The invariant mass of the particle.. More...
 
virtual double e () const
 The total energy of the particle. More...
 
virtual double rapidity () const
 The true rapidity (y) of the particle. More...
 
void setP4 (double pt, double eta, double phi)
 Set method for IParticle values. More...
 
virtual FourMom_t p4 () const
 The full 4-momentum of the particle. More...
 
GenVecFourMom_t genvecP4 () const
 The full 4-momentum of the particle : GenVector. More...
 
virtual Type::ObjectType type () const
 The type of the object as a simple enumeration. More...
 

Charge

Returns the charge.

float charge () const
 
void setCharge (float charge)
 Set the charge (must be the same as primaryTrackParticle() ) More...
 

Author

Methods to query the author(s) of this Muon

Todo:
  • update and add documentation.

Returns the primary author of this Muon.

Author author () const
 
bool isAuthor (const Author author) const
 Returns 'true' if 'author' is the an author of this muon. More...
 
void setAuthor (Author auth)
 set author More...
 
uint16_t allAuthors () const
 Get all the authors of this Muon. More...
 
void setAllAuthors (uint16_t authors)
 
void addAllAuthor (const Author author)
 add author to all authors More...
 

Summary information

Return summary information about the muon, such as its MuonType, and the TrackSumary values of the primary TrackParticle.

Todo:
Add documentation. Generic accessor to type information.
MuonType muonType () const
 
void setMuonType (MuonType type)
 
bool summaryValue (uint8_t &value, const SummaryType information) const
 Accessor for TrackSummary values (in most cases, retrieved from the 'primary' TrackParticle - though it could be stored on the Muon, depending on the job configuration) If 'information' is stored in the primary TrackParticle/Muon and is of the correct templated type T, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'. More...
 
void setSummaryValue (uint8_t value, const SummaryType information)
 Set method for storing TrackSummary SummaryType information on the Muon (see Aux to see which is already defined as static) More...
 
bool summaryValue (float &value, const SummaryType information) const
 summaryValue(uint8_t& value, const SummaryType information) const; More...
 
bool summaryValue (uint8_t &value, const MuonSummaryType information) const
 Accessor for MuonSummaryType. More...
 
void setSummaryValue (uint8_t value, const MuonSummaryType information)
 Set method for MuonSummaryType. More...
 
float floatSummaryValue (const SummaryType information) const
 Same as bool summaryValue(float& value, const SummaryType &information) const , but without check (will throw exception if value isn't there) Primarily for use in Python. More...
 
uint8_t uint8SummaryValue (const SummaryType information) const
 Same as bool summaryValue(uint8_t& value, const SummaryType &information) const, but without check (will throw exception if value isn't there) Primarily for use in Python. More...
 
float uint8MuonSummaryValue (const MuonSummaryType information) const
 Same as bool summaryValue(uint8_t& value, const MuonSummaryType &information) const, but without check (will throw exception if value isn't there) Primarily for use in Python. More...
 
bool parameter (float &value, const ParamDef parameter) const
 Get a parameter for this Muon - momentumBalanceSignificance for example. More...
 
void setParameter (float value, const ParamDef parameter)
 Set method for parameter values. More...
 
float floatParameter (const ParamDef parameter) const
 Same as bool parameter(float& value, const ParamDef &parameter) const, but without check (will throw exception if value isn't there). More...
 
bool parameter (int &value, const ParamDef parameter) const
 Get an integer parameter for this Muon - msInnerMatchDOF for example. More...
 
void setParameter (int value, const ParamDef parameter)
 Set method for parameter values. More...
 
int intParameter (const ParamDef parameter) const
 Same as bool parameter(float& value, const ParamDef &parameter) const, but without check (will throw exception if value isn't there). More...
 
Quality quality () const
 The Muon Quality information is defined on the MCP twiki: https://twiki.cern.ch/twiki/bin/view/Atlas/MuonSelectionTool#Quality_definition. More...
 
void setQuality (Quality)
 
bool passesIDCuts () const
 Returns true if this Muon passes the MCP ID hit cuts (see the MCP twiki for definitions: https://twiki.cern.ch/twiki/bin/view/AtlasProtected/MuonPerformance) More...
 
void setPassesIDCuts (bool)
 Set whether passes the MCP ID hit cuts. More...
 

Isolation information.

bool isolation (float &value, const Iso::IsolationType information) const
 Accessor for Isolation values. More...
 
float isolation (const Iso::IsolationType information) const
 Accessor to Isolation values , this just returns the value without internaly checking if it exists. More...
 
void setIsolation (float value, const Iso::IsolationType information)
 Set method for Isolation values. More...
 

Links

With the following methods you can retrieve links to the objects used to identify this muon - depending on how the muon was built the link may or may not be valid (i.e.

a muon built from a standalone MS track won't have an ID TrackParticle associated to it).

Todo:
finish documentation
Add some code here, showing how to properly use the element links
Note
Some links were removed from the "Run-1" AOD::muon, in particular

Returns an ElementLink to the primary TrackParticle corresponding to the MuonType of this muon. This is determined in the following order:

  1. CombinedTrackParticle
  2. InnerDetectorTrackParticle
  3. ExtrapolatedMuonSpectrometerTrackParticle
  4. MSOnlyExtrapolatedMuonSpectrometerTrackParticle
  5. MuonSpectrometerTrackParticle This method can throw a std::runtime_error exception if either the 'muontype' is unknown, or if the type is MuonStandAlone, but there is no available extrapolatedMuonSpectrometerTrackParticleLink or muonSpectrometerTrackParticleLink to return.
const ElementLink< TrackParticleContainer > & primaryTrackParticleLink () const
 
const TrackParticleprimaryTrackParticle () const
 Returns a pointer (which should not usually be NULL, but might be if the muon has been stripped of information) to the primary TrackParticle corresponding to the MuonType of this muon. More...
 
const ElementLink< TrackParticleContainer > & inDetTrackParticleLink () const
 Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon. More...
 
const ElementLink< TrackParticleContainer > & muonSpectrometerTrackParticleLink () const
 Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon. More...
 
const ElementLink< TrackParticleContainer > & combinedTrackParticleLink () const
 Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon. More...
 
const ElementLink< TrackParticleContainer > & extrapolatedMuonSpectrometerTrackParticleLink () const
 Returns an ElementLink to the Extrapolated Muon Spectrometer TrackParticle used in identification of this muon. More...
 
const ElementLink< TrackParticleContainer > & msOnlyExtrapolatedMuonSpectrometerTrackParticleLink () const
 Returns an ElementLink to the MS-only Extrapolated Muon Spectrometer TrackParticle used in identification of this muon. More...
 
const ElementLink< TrackParticleContainer > & trackParticleLink (TrackParticleType type) const
 Returns an ElementLink to the TrackParticle used in identification of this muon. More...
 
void setTrackParticleLink (TrackParticleType type, const ElementLink< TrackParticleContainer > &link)
 Set method for TrackParticle links. More...
 
const TrackParticletrackParticle (TrackParticleType type) const
 Returns a pointer (which can be NULL) to the TrackParticle used in identification of this muon. More...
 
const ElementLink< CaloClusterContainer > & clusterLink () const
 Returns an ElementLinkto the cluster associated to this muon. More...
 
void setClusterLink (const ElementLink< CaloClusterContainer > &link)
 Set method for cluster links. More...
 
const CaloClustercluster () const
 Retrieve the associated cluster with a bare pointer. More...
 
EnergyLossType energyLossType (void) const
 Energy determined from parametrization or not (measured). More...
 
void setEnergyLossType (EnergyLossType type)
 Set method for the type. More...
 
const std::vector< ElementLink< MuonSegmentContainer > > & muonSegmentLinks () const
 Returns a vector of ElementLinks to the MuonSegments used to create this Muon. More...
 
void setMuonSegmentLinks (const std::vector< ElementLink< MuonSegmentContainer > > &segments)
 Set the vector of ElementLinks to the MuonSegments used to create this Muon. More...
 
size_t nMuonSegments () const
 Number of MuonSegments linked to by this Muon. More...
 
const MuonSegmentmuonSegment (size_t i) const
 Returns a pointer to the specified MuonSegment. More...
 
const ElementLink< MuonSegmentContainer > & muonSegmentLink (size_t i) const
 Returns a link to the specified MuonSegment. More...
 

Detailed Description

Class describing a Muon.

Author
Edward Moyse Edwar.nosp@m.d.Mo.nosp@m.yse@c.nosp@m.ern..nosp@m.ch

Definition at line 38 of file Muon_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.

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

◆ FourMom_t

Definition of the 4-momentum type.

Definition at line 74 of file Muon_v1.h.

◆ GenVecFourMom_t

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

Base 4 Momentum type for Muon.

Definition at line 80 of file Muon_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.

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

Constructor & Destructor Documentation

◆ Muon_v1() [1/2]

xAOD::Muon_v1::Muon_v1 ( )

inject the enums

Default constructor

Definition at line 27 of file Muon_v1.cxx.

28  : IParticle() {
29  }

◆ Muon_v1() [2/2]

xAOD::Muon_v1::Muon_v1 ( const Muon_v1 rhs)

Copy constructor.

Definition at line 31 of file Muon_v1.cxx.

32  : IParticle(rhs) //IParticle does not have a copy constructor. AuxElement has one with same behavior as default ctor
33  {
34  this->makePrivateStore(rhs);
35  }

◆ ~Muon_v1()

xAOD::Muon_v1::~Muon_v1 ( )
virtual

Destructor.

Definition at line 48 of file Muon_v1.cxx.

48  {
49  }

Member Function Documentation

◆ addAllAuthor()

void xAOD::Muon_v1::addAllAuthor ( const Author  author)

add author to all authors

Definition at line 107 of file Muon_v1.cxx.

107  {
108  static const Accessor< uint16_t > acc( "allAuthors" );
109  acc(*this) |= 1<<static_cast<unsigned int>(author);
110  }

◆ allAuthors()

uint16_t xAOD::Muon_v1::allAuthors ( ) const

Get all the authors of this Muon.

For example during overlap checking, the same Muon may have been reconstructed by many different algorithms. This method returns a 16bit number, where each bit represents a muon algorithm, defined as follows (the lowest bit is indicates that something has gone wrong): unknown | MuidCo | STACO | MuTag | MuTagIMO | MuidSA | MuGirl | MuGirlLowBeta | CaloTag | CaloLikelihood | CaloScore | ExtrapolateMuonToIP | MuonCombinedRefit | ExtrapolateMuonToIP | Commissioning

Returns
16-bit word, 1-bit reserved for each muon Algorithm:

◆ assign()

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

Assignment.

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

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

◆ author()

Author xAOD::Muon_v1::author ( ) const

◆ auxdata() [1/4]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata ( const std::string &  name)
inherited

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

Parameters
nameName of the aux variable.

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

◆ auxdata() [2/4]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata ( const std::string &  name) const
inherited

Fetch an aux data variable, as a const reference.

Parameters
nameName of the aux variable.

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

◆ auxdata() [3/4]

template<class T >
XAOD_AUXDATA_DEPRECATED T& xAOD::IParticle::auxdata ( const std::string &  name,
const std::string &  clsname = "" 
)
inlineinherited

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

This function provides an easy way for users to decorate objects with auxiliary data.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters
nameName of the aux variable
clsnameThe name of the associated class. May be blank
Returns
A modifiable reference to the decoration

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

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

◆ auxdata() [4/4]

template<class T >
XAOD_AUXDATA_DEPRECATED const T& xAOD::IParticle::auxdata ( const std::string &  name,
const std::string &  clsname = "" 
) const
inlineinherited

Fetch an aux data variable, as a const reference.

This function provides an easy way for users to retrieve auxiliary decorations from an object.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters
nameName of the aux variable
clsnameThe name of the associated class. May be blank
Returns
A constant reference to the decoration

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

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

◆ auxdataConst() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string &  name) const
inherited

Fetch an aux data variable, as a const reference.

Parameters
nameName of the aux variable.

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

◆ auxdataConst() [2/2]

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

Fetch an aux data variable, as a const reference.

Parameters
nameName of the aux variable.
clsnameThe name of the associated class. May be blank.

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

◆ auxdecor() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string &  name) const
inherited

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

Parameters
nameName of the aux variable.

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

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

◆ auxdecor() [2/2]

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

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

Parameters
nameName of the aux variable.
clsnameThe name of the associated class. May be blank.

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

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

◆ charge()

float xAOD::Muon_v1::charge ( ) 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 580 of file AuxElement.cxx.

581 {
582  if (!m_container) return;
584 }

◆ clearAuxHelper()

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

Clear all aux data associated with an element.

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

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

Definition at line 639 of file AuxElement.cxx.

640 {
641  if (!container.hasStore()) return;
642  if (!container.hasNonConstStore()) {
643  throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
644  }
645 
647  for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
648  r.clear (auxid, container, index, 1);
649  }
650 }

◆ clearCache()

void SG::AuxElement::clearCache ( )
inherited

Clear the cached aux data pointers.

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

Definition at line 339 of file AuxElement.cxx.

340 {
341  if (container())
342  container()->clearCache();
343 }

◆ clearDecorations()

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

Clear all decorations.

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

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

Definition at line 428 of file AuxElement.cxx.

429 {
430  if (havePrivateData())
431  return m_container->clearDecorations();
432  return false;
433 }

◆ cluster()

const CaloCluster * xAOD::Muon_v1::cluster ( ) const

Retrieve the associated cluster with a bare pointer.

Definition at line 535 of file Muon_v1.cxx.

535  {
536 
537  static const Accessor< ElementLink< TrackParticleContainer > > acc( "inDetTrackParticleLink" );
538  if( ! acc.isAvailable( *this ) ) {
539  return nullptr;
540  }
541  const ElementLink< TrackParticleContainer >& link = acc( *this );
542  if( ! link.isValid() ) {
543  return nullptr;
544  }
545 
546  // Get the ElementLink pointing to the calo cluster:
548  // If it's invalid, return a null pointer:
549  if( ! el.isValid() ) {
550  return nullptr;
551  }
552  // If it's valid, let's de-reference it:
553  return *el;
554  }

◆ clusterLink()

const ElementLink<CaloClusterContainer>& xAOD::Muon_v1::clusterLink ( ) const

Returns an ElementLinkto the cluster associated to this muon.

Todo:
Why just one?

◆ combinedTrackParticleLink()

const ElementLink< TrackParticleContainer >& xAOD::Muon_v1::combinedTrackParticleLink ( ) const

Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon.

◆ 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
otherThe object from which to copy.
warnUnlockedIf true, then warn when we skip unlocked decorations.

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

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

Definition at line 600 of file AuxElement.cxx.

602 {
603  if (!m_container) return;
604  copyAuxHelper (*container(), index(), other, warnUnlocked);
605 }

◆ copyAuxHelper()

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

Copy aux data from another object.

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

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

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

Definition at line 667 of file AuxElement.cxx.

671 {
672  if (!container.hasStore()) return;
674  throw SG::ExcConstAuxData ("copyAux");
675 
676  const SG::AuxVectorData* ocont = other.container();
677 
678  if (!ocont || !ocont->hasStore()) {
680  return;
681  }
682 
683 #ifndef XAOD_STANDALONE
684  const SG::auxid_set_t& other_decors = ocont->getDecorIDs();
685 #endif
686  SG::auxid_set_t other_ids = ocont->getAuxIDs();
687 
688  size_t oindex = other.index();
690 
691  for (SG::auxid_t auxid : other_ids) {
692 #ifndef XAOD_STANDALONE
693  if (other_decors.test (auxid)) {
694  // Don't copy decorations --- another thread may be modifying them.
695  other_ids.reset (auxid);
696  // Warn if we skip a decoration (except for mcEventWeights,
697  // for which this is expected).
698  if (warnUnlocked && r.getName(auxid) != "mcEventWeights") {
699  std::ostringstream ss;
700  ss << "skipped unlocked decoration " << r.getName(auxid)
701  << " (" << auxid << ")";
702  ATHCONTAINERS_WARNING("copyAux", ss.str());
703  }
704  }
705  else
706 #endif
707  if (!r.isLinked (auxid)) {
708  r.copy (auxid, container, index, *ocont, oindex, 1);
709  }
710  }
711 
712  for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
713  if (!other_ids.test (auxid)) {
714  r.clear (auxid, container, index, 1);
715  }
716  }
717 }

◆ e()

double xAOD::Muon_v1::e ( ) const
virtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 58 of file Muon_v1.cxx.

58  {
59  // FIXME - optimise?
60  return genvecP4().E();
61  }

◆ energyLossType()

EnergyLossType xAOD::Muon_v1::energyLossType ( void  ) const

Energy determined from parametrization or not (measured).

The actual energy loss is returned via

float etCore;
bool hasEnergyLoss = parameter(float& value, const ParamDef parameter)

◆ eta()

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

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

Implements xAOD::IParticle.

◆ extrapolatedMuonSpectrometerTrackParticleLink()

const ElementLink< TrackParticleContainer >& xAOD::Muon_v1::extrapolatedMuonSpectrometerTrackParticleLink ( ) const

Returns an ElementLink to the Extrapolated Muon Spectrometer TrackParticle used in identification of this muon.

◆ floatParameter()

float xAOD::Muon_v1::floatParameter ( const ParamDef  parameter) const

Same as bool parameter(float& value, const ParamDef &parameter) const, but without check (will throw exception if value isn't there).

Primarily for use in Python.

Definition at line 192 of file Muon_v1.cxx.

192  {
193  const xAOD::Muon_v1::Accessor< float >* acc = parameterAccessorV1<float>( information );
194  return ( *acc )( *this );
195  }

◆ floatSummaryValue()

float xAOD::Muon_v1::floatSummaryValue ( const SummaryType  information) const

Same as bool summaryValue(float& value, const SummaryType &information) const , but without check (will throw exception if value isn't there) Primarily for use in Python.

Definition at line 150 of file Muon_v1.cxx.

150  {
151  const Muon_v1::Accessor< float >* acc = trackSummaryAccessorV1< float >( information );
152  return ( *acc )( *this );
153  }

◆ genvecP4()

Muon_v1::GenVecFourMom_t xAOD::Muon_v1::genvecP4 ( ) const

The full 4-momentum of the particle : GenVector.

Definition at line 87 of file Muon_v1.cxx.

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

◆ getAuxIDs()

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

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

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

Definition at line 355 of file AuxElement.cxx.

356 {
357 #ifdef ATHCONTAINERS_R21_COMPAT
358  if (havePrivateData())
359  return m_container->getConstStore()->getAuxIDs();
360  if (container())
361  return container()->getAuxIDs();
362  static const SG::auxid_set_t null_set;
363  return null_set;
364 #else
366 #endif
367 }

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

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

◆ getDecorIDs()

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

Return a set of identifiers for decorations for this object.

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

Definition at line 378 of file AuxElement.cxx.

379 {
380 #ifdef ATHCONTAINERS_R21_COMPAT
381  if (havePrivateData())
383  if (container())
384  return container()->getDecorIDs();
385  static const SG::auxid_set_t null_set;
386  return null_set;
387 #else
389 #endif
390 }

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

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

◆ hadPrivateData()

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

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

◆ hasNonConstStore()

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

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

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

Definition at line 411 of file AuxElement.cxx.

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

◆ hasStore()

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

Return true if this object has an associated store.

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

Definition at line 398 of file AuxElement.cxx.

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

◆ havePrivateData()

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

True if this element currently has private data.

◆ inDetTrackParticleLink()

const ElementLink< TrackParticleContainer >& xAOD::Muon_v1::inDetTrackParticleLink ( ) const

Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon.

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

◆ intParameter()

int xAOD::Muon_v1::intParameter ( const ParamDef  parameter) const

Same as bool parameter(float& value, const ParamDef &parameter) const, but without check (will throw exception if value isn't there).

Primarily for use in Python.

Definition at line 215 of file Muon_v1.cxx.

215  {
216  const xAOD::Muon_v1::Accessor< int >* acc = parameterAccessorV1<int>( information );
217  return ( *acc )( *this );
218  }

◆ isAuthor()

bool xAOD::Muon_v1::isAuthor ( const Author  author) const

Returns 'true' if 'author' is the an author of this muon.

Definition at line 112 of file Muon_v1.cxx.

112  {
113  static const Accessor< uint16_t > acc( "allAuthors" );
114  return (acc(*this)& (1<<static_cast<unsigned int>(author)));
115  }

◆ isAvailable()

template<class T >
XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailable ( const std::string &  name,
const std::string &  clsname = "" 
) const
inlineinherited

Check if a user property is available for reading or not.

This function should be used to check if a user property which may or may not exist, is set on the object.

Parameters
nameName of the auxiliary variable
clsnameThe name of the associated class. May be blank
Returns
Whether the decoration exists or not

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

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

◆ isAvailableWritable() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritable ( const std::string &  name,
const std::string &  clsname = "" 
)
inherited

Check if an aux variable is available for writing.

Parameters
nameName of the aux variable.
clsnameThe name of the associated class. May be blank.

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

◆ isAvailableWritable() [2/2]

template<class T >
XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailableWritable ( const std::string &  name,
const std::string &  clsname = "" 
) const
inlineinherited

Check if a user property is available for writing or not.

This function can be used to check whether it will be possible to set a user property on the object.

Parameters
nameName of the auxiliary variable
clsnameThe name of the associated class. May be blank
Returns
Whether the decoration is possible to set

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

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

◆ isAvailableWritableAsDecoration()

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritableAsDecoration ( const std::string &  name,
const std::string &  clsname = "" 
) const
inherited

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

Parameters
nameName of the aux variable.
clsnameThe name of the associated class. May be blank.

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

◆ isolation() [1/2]

float xAOD::Muon_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 273 of file Muon_v1.cxx.

273  {
275  if( !acc ) throw std::runtime_error( "Unknown/Unavailable Isolation type requested" );
276  return ( *acc )( *this );
277  }

◆ isolation() [2/2]

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

Accessor for Isolation values.

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

Definition at line 262 of file Muon_v1.cxx.

262  {
264 
265  if( ! acc ) return false;
266  if( !acc->isAvailable( *this) ) return false;
267 
268  // Retrieve the value:
269  value = ( *acc )( *this );
270  return true;
271  }

◆ isolationCaloCorrection() [1/2]

float xAOD::Muon_v1::isolationCaloCorrection ( const Iso::IsolationFlavour  flavour,
const Iso::IsolationCaloCorrection  type,
const Iso::IsolationCorrectionParameter  param 
) const

Accessor to 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 296 of file Muon_v1.cxx.

297  {
298 
300  if( !acc.isAvailable( *this) ) throw std::runtime_error( "Unknown/Unavailable Isolation correction requested" );
301  return acc( *this );
302  }

◆ isolationCaloCorrection() [2/2]

bool xAOD::Muon_v1::isolationCaloCorrection ( float value,
const Iso::IsolationFlavour  flavour,
const Iso::IsolationCaloCorrection  type,
const Iso::IsolationCorrectionParameter  param 
) const

Accessor for Isolation Calo correction.

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

Definition at line 286 of file Muon_v1.cxx.

288  {
290  if( !acc.isAvailable( *this) ) return false;
291  // Retrieve the value:
292  value = acc( *this );
293  return true;
294  }

◆ isolationCorrectionBitset() [1/2]

std::bitset< 32 > xAOD::Muon_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 342 of file Muon_v1.cxx.

342  {
344  if( !acc.isAvailable( *this) ) throw std::runtime_error( "Unknown/Unavailable Isolation BitSet requested" );
345  return std::bitset<32>( acc( *this ) );
346  }

◆ isolationCorrectionBitset() [2/2]

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

Accessor for Isolation corection Bitset.

Definition at line 334 of file Muon_v1.cxx.

334  {
336  if( !acc.isAvailable( *this) ) return false;
337  // Retrieve the value:
338  value = std::bitset<32>(acc( *this ));
339  return true;
340  }

◆ isolationTrackCorrection() [1/2]

float xAOD::Muon_v1::isolationTrackCorrection ( const Iso::IsolationFlavour  flavour,
const Iso::IsolationTrackCorrection  type 
) 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 320 of file Muon_v1.cxx.

320  {
321 
323  if( !acc.isAvailable( *this) ) throw std::runtime_error( "Unknown/Unavailable Isolation correction requested" );
324  return acc( *this );
325  }

◆ isolationTrackCorrection() [2/2]

bool xAOD::Muon_v1::isolationTrackCorrection ( float value,
const Iso::IsolationFlavour  flavour,
const Iso::IsolationTrackCorrection  type 
) const

Accessor for Isolation Track correction.

Definition at line 312 of file Muon_v1.cxx.

312  {
314  if( !acc.isAvailable( *this) ) return false;
315  // Retrieve the value:
316  value = acc( *this );
317  return true;
318  }

◆ m()

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

The invariant mass of the particle..

Implements xAOD::IParticle.

Definition at line 63 of file Muon_v1.cxx.

63  {
65  }

◆ makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )
inherited

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

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

Definition at line 192 of file AuxElement.cxx.

193 {
194  if (m_container) {
195  throw SG::ExcBadPrivateStore ("store already exists");
196  }
197 
201 }

◆ makePrivateStore() [2/3]

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

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

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

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

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

◆ makePrivateStore() [3/3]

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

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

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

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

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

◆ makePrivateStore1() [1/2]

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

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

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

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

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

Definition at line 565 of file AuxElement.cxx.

567 {
569  if (other)
570  this->copyAux (*other, warnUnlocked);
571 }

◆ makePrivateStore1() [2/2]

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

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

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

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

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

◆ msOnlyExtrapolatedMuonSpectrometerTrackParticleLink()

const ElementLink< TrackParticleContainer >& xAOD::Muon_v1::msOnlyExtrapolatedMuonSpectrometerTrackParticleLink ( ) const

Returns an ElementLink to the MS-only Extrapolated Muon Spectrometer TrackParticle used in identification of this muon.

◆ muonSegment()

const MuonSegment * xAOD::Muon_v1::muonSegment ( size_t  i) const

Returns a pointer to the specified MuonSegment.

Parameters
iIndex of the MuonSegment requested. If i is not in range (0<i<nMuonSegments()) an exception will be thrown.

Definition at line 582 of file Muon_v1.cxx.

582  {
583  // Get the ElementLink pointing to the requested muon segment:
585  muonSegmentLink( i );
586  // If it's invalid, return a null pointer:
587  if( ! el.isValid() ) {
588  return nullptr;
589  }
590  // If it's valid, let's de-reference it:
591  return *el;
592  }

◆ muonSegmentLink()

const ElementLink< MuonSegmentContainer > & xAOD::Muon_v1::muonSegmentLink ( size_t  i) const

Returns a link to the specified MuonSegment.

Parameters
iIndex of the MuonSegment requested. If i is not in range (0<i<nMuonSegments()) an exception will be thrown.

Definition at line 572 of file Muon_v1.cxx.

572  {
573  // If a Trk::Track link was not set (yet), return a dummy object:
574  // FIXME - maybe
575  if( ! muonSegmentsAcc.isAvailable( *this ) ) {
577  return dummy;
578  }
579  return muonSegmentsAcc(*this).at(i);
580  }

◆ muonSegmentLinks()

const std::vector< ElementLink< MuonSegmentContainer > >& xAOD::Muon_v1::muonSegmentLinks ( ) const

Returns a vector of ElementLinks to the MuonSegments used to create this Muon.

Todo:
complete the various calo energy additions (i.e. depositInCalo etc)

◆ muonSpectrometerTrackParticleLink()

const ElementLink< TrackParticleContainer >& xAOD::Muon_v1::muonSpectrometerTrackParticleLink ( ) const

Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon.

◆ muonType()

MuonType xAOD::Muon_v1::muonType ( ) const

◆ nMuonSegments()

size_t xAOD::Muon_v1::nMuonSegments ( ) const

Number of MuonSegments linked to by this Muon.

Definition at line 564 of file Muon_v1.cxx.

564  {
565  // If a link was not set (yet), return zero.
566  if( ! muonSegmentsAcc.isAvailable( *this ) ) {
567  return 0;
568  }
569  return muonSegmentsAcc(*this).size();
570  }

◆ noPrivateData()

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

True if this element has no private data.

◆ operator=()

Muon_v1 & xAOD::Muon_v1::operator= ( const Muon_v1 rhs)

Assignment operator.

Definition at line 37 of file Muon_v1.cxx.

37  {
38  if(this == &rhs) return *this;
39 
40  if( ( ! hasStore() ) && ( ! container() ) ) {
42  }
43  this->IParticle::operator=( rhs );
44 
45  return *this;
46  }

◆ p4()

Muon_v1::FourMom_t xAOD::Muon_v1::p4 ( ) const
virtual

The full 4-momentum of the particle.

Implements xAOD::IParticle.

Definition at line 80 of file Muon_v1.cxx.

80  {
82  p4.SetPtEtaPhiM( pt(), eta(), phi(), m() );
83  return p4;
84  }

◆ parameter() [1/2]

bool xAOD::Muon_v1::parameter ( float value,
const ParamDef  parameter 
) const

Get a parameter for this Muon - momentumBalanceSignificance for example.

Todo:
Finish documentation include matchChi2, muonentrancechi2 (instead of outerMatchChi2).

Store chi2/dof instead of two? fitChi2 comes from TrackParticle.

◆ parameter() [2/2]

bool xAOD::Muon_v1::parameter ( int value,
const ParamDef  parameter 
) const

Get an integer parameter for this Muon - msInnerMatchDOF for example.

◆ passesIDCuts()

bool xAOD::Muon_v1::passesIDCuts ( ) const

Returns true if this Muon passes the MCP ID hit cuts (see the MCP twiki for definitions: https://twiki.cern.ch/twiki/bin/view/AtlasProtected/MuonPerformance)

Definition at line 242 of file Muon_v1.cxx.

242  {
243  static const Accessor< uint8_t > acc( "quality" );
244  uint8_t temp = acc( *this );
245  // We use 4th bit for 'passesIDCuts'
246  return temp&8;
247  }

◆ phi()

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

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

Implements xAOD::IParticle.

◆ primaryTrackParticle()

const xAOD::TrackParticle * xAOD::Muon_v1::primaryTrackParticle ( ) const

Returns a pointer (which should not usually be NULL, but might be if the muon has been stripped of information) to the primary TrackParticle corresponding to the MuonType of this muon.

This is determined in the following order:

  1. CombinedTrackParticle
  2. InnerDetectorTrackParticle
  3. ExtrapolatedMuonSpectrometerTrackParticle
  4. MSOnlyExtrapolatedMuonSpectrometerTrackParticle
  5. MuonSpectrometerTrackParticle

Definition at line 401 of file Muon_v1.cxx.

401  {
402 
403  MuonType type = muonType();
404  switch( type ) {
405  case Combined:
406  case SiliconAssociatedForwardMuon :
407  {
408  static const Accessor< ElementLink< TrackParticleContainer > > acc( "combinedTrackParticleLink" );
409  if( ! acc.isAvailable( *this ) ) return nullptr;
410 
411  const ElementLink< TrackParticleContainer >& link = acc( *this );
412  if( ! link.isValid() ) return nullptr;
413 
414  return *link;
415  }
416  case SegmentTagged:
417  case CaloTagged :
418  {
419  static const Accessor< ElementLink< TrackParticleContainer > > acc( "inDetTrackParticleLink" );
420  if( ! acc.isAvailable( *this ) ) return nullptr;
421 
422  const ElementLink< TrackParticleContainer >& link = acc( *this );
423  if( ! link.isValid() ) return nullptr;
424 
425  return *link;
426  }
427  case MuonStandAlone :
428  {
429  // Want to return link to extrapolated MS track particle if possible.
430  static const Accessor< ElementLink< TrackParticleContainer > > acc1( "extrapolatedMuonSpectrometerTrackParticleLink" );
431  if ( acc1.isAvailable( *this ) ) {
432  const ElementLink< TrackParticleContainer >& link = acc1( *this );
433  if ( link.isValid() ) return *link;
434  }
435 
436  //if no, maybe the MS-only extrapolated track particle?
437  static const Accessor< ElementLink< TrackParticleContainer > > acc2( "msOnlyExtrapolatedMuonSpectrometerTrackParticleLink" );
438  if ( acc2.isAvailable( *this ) ) {
439  const ElementLink< TrackParticleContainer >& link = acc2( *this );
440  if ( link.isValid() ) return *link;
441  }
442 
443  // Try fallback (non-extrapolated MS track particle)...
444  static const Accessor< ElementLink< TrackParticleContainer > > acc3( "muonSpectrometerTrackParticleLink" );
445  if ( acc3.isAvailable( *this ) ) {
446  const ElementLink< TrackParticleContainer >& link = acc3( *this );
447  if ( link.isValid() ) return *link;
448  }
449 
450  return nullptr;
451  }
452  default:
453  {
454  // No valid link.
455  return nullptr;
456  }
457  }
458  }

◆ primaryTrackParticleLink()

const ElementLink< TrackParticleContainer > & xAOD::Muon_v1::primaryTrackParticleLink ( ) const

Definition at line 361 of file Muon_v1.cxx.

361  {
362  MuonType type = muonType();
363  switch ( type ) {
364  case Combined :
365  case SiliconAssociatedForwardMuon :
366  return combinedTrackParticleLink();
367  break;
368  case SegmentTagged :
369  case CaloTagged :
370  return inDetTrackParticleLink();
371  break;
372  case MuonStandAlone :
373  {
374  // Not checking if links are valid here - this is the job of the client (as per the cases above).
375  // But we DO check that the link is available, so we can check for both types of links.
376 
377  static const Accessor< ElementLink< TrackParticleContainer > > acc1( "extrapolatedMuonSpectrometerTrackParticleLink" );
378  if ( acc1.isAvailable( *this ) && acc1( *this ).isValid() ) {
379  return acc1( *this );
380  }
381 
382  static const Accessor< ElementLink< TrackParticleContainer > > acc2( "msOnlyExtrapolatedMuonSpectrometerTrackParticleLink" );
383  if ( acc2.isAvailable( *this ) && acc2( *this ).isValid() ) {
384  return acc2( *this );
385  }
386 
387  static const Accessor< ElementLink< TrackParticleContainer > > acc3( "muonSpectrometerTrackParticleLink" );
388  if ( acc3.isAvailable( *this ) && acc3( *this ).isValid()) {
389  return acc3( *this );
390  }
391  // We could also just return a dummy EL here, but the link is part of the aux store, and so it might be that something bad has happened...?
392  throw std::runtime_error("Type is MuonStandAlone but no available link to return!");
393  }
394  default:
395  throw std::runtime_error("Unknown primary type - not sure which track particle to return!");
396  }
397  // static ElementLink< TrackParticleContainer > dummy;
398  // return dummy;
399  }

◆ pt()

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

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

Implements xAOD::IParticle.

◆ quality()

xAOD::Muon_v1::Quality xAOD::Muon_v1::quality ( ) const

The Muon Quality information is defined on the MCP twiki: https://twiki.cern.ch/twiki/bin/view/Atlas/MuonSelectionTool#Quality_definition.

Todo:
Finish documentation

Definition at line 228 of file Muon_v1.cxx.

228  {
229  static const Accessor< uint8_t > acc( "quality" );
230  uint8_t temp = acc( *this );
231  return static_cast<Quality>(temp&3);
232  }

◆ rapidity()

double xAOD::Muon_v1::rapidity ( ) const
virtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 76 of file Muon_v1.cxx.

76  {
77  return genvecP4().Rapidity();
78  }

◆ releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )
inherited

Release and free any private store associated with this object.

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

Definition at line 210 of file AuxElement.cxx.

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

◆ releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )
privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 441 of file AuxElement.cxx.

442 {
443 #ifdef ATHCONTAINERS_R21_COMPAT
444  if (havePrivateData()) {
445  delete m_container;
446  }
447 #else
449 #endif
450 }

◆ setAllAuthors()

void xAOD::Muon_v1::setAllAuthors ( uint16_t  authors)

◆ setAuthor()

void xAOD::Muon_v1::setAuthor ( Author  auth)

set author

◆ setCharge()

void xAOD::Muon_v1::setCharge ( float  charge)

Set the charge (must be the same as primaryTrackParticle() )

◆ setClusterLink()

void xAOD::Muon_v1::setClusterLink ( const ElementLink< CaloClusterContainer > &  link)

Set method for cluster links.

◆ setConstStore()

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

Synonym for setStore with IConstAuxStore.

Parameters
storeThe new store.

◆ setEnergyLossType()

void xAOD::Muon_v1::setEnergyLossType ( EnergyLossType  type)

Set method for the type.

◆ setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )
privateinherited

Record that this element used to have private data.

◆ setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )
privateinherited

Record that this element currently has private data.

◆ setIndex()

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

Set the index/container for this element.

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

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

◆ setIndexPrivate()

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

Set the index/container for this element.

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

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

Definition at line 505 of file AuxElement.cxx.

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

◆ setIsolation()

void xAOD::Muon_v1::setIsolation ( float  value,
const Iso::IsolationType  information 
)

Set method for Isolation values.

Definition at line 279 of file Muon_v1.cxx.

279  {
281  if( !acc ) throw std::runtime_error( "Unknown/Unavailable Isolation type requested" );
282  // Set the value:
283  ( *acc )( *this ) = value;
284  }

◆ setIsolationCaloCorrection()

bool xAOD::Muon_v1::setIsolationCaloCorrection ( float  value,
const Iso::IsolationFlavour  flavour,
const Iso::IsolationCaloCorrection  type,
const Iso::IsolationCorrectionParameter  param 
)

set method for Isolation Calo Corrections.

Definition at line 304 of file Muon_v1.cxx.

305  {
307  // Set the value:
308  acc( *this ) = value;
309  return true;
310  }

◆ setIsolationCorrectionBitset()

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

Set method for Isolation corection Bitset.

Definition at line 348 of file Muon_v1.cxx.

348  {
350  // Set the value:
351  acc( *this ) = value;
352  return true;
353  }

◆ setIsolationTrackCorrection()

bool xAOD::Muon_v1::setIsolationTrackCorrection ( float  value,
const Iso::IsolationFlavour  flavour,
const Iso::IsolationTrackCorrection  type 
)

Set method for Isolation Track Corrections.

Definition at line 327 of file Muon_v1.cxx.

327  {
329  // Set the value:
330  acc( *this ) = value;
331  return true;
332  }

◆ setMuonSegmentLinks()

void xAOD::Muon_v1::setMuonSegmentLinks ( const std::vector< ElementLink< MuonSegmentContainer > > &  segments)

Set the vector of ElementLinks to the MuonSegments used to create this Muon.

◆ setMuonType()

void xAOD::Muon_v1::setMuonType ( MuonType  type)
Todo:
  • do we actually need this? Deduce it from other information?

◆ setNonConstStore()

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

Synonym for setStore with IAuxStore.

Parameters
storeThe new store.

◆ setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )
privateinherited

Record that this element does not have private data.

◆ setP4()

void xAOD::Muon_v1::setP4 ( double  pt,
double  eta,
double  phi 
)

Set method for IParticle values.

Definition at line 67 of file Muon_v1.cxx.

67  {
68  static const Accessor< float > acc1( "pt" );
69  static const Accessor< float > acc2( "eta" );
70  static const Accessor< float > acc3( "phi" );
71  acc1( *this )=pt;
72  acc2( *this )=eta;
73  acc3( *this )=phi;
74  }

◆ setParameter() [1/2]

void xAOD::Muon_v1::setParameter ( float  value,
const ParamDef  parameter 
)

Set method for parameter values.

◆ setParameter() [2/2]

void xAOD::Muon_v1::setParameter ( int  value,
const ParamDef  parameter 
)

Set method for parameter values.

◆ setPassesIDCuts()

void xAOD::Muon_v1::setPassesIDCuts ( bool  value)

Set whether passes the MCP ID hit cuts.

Definition at line 249 of file Muon_v1.cxx.

249  {
250  static const Accessor< uint8_t > acc( "quality" );
251  // We use 4th bit for 'passesIDCuts'
252  if (value) acc( *this ) |= 8;
253  else acc( *this ) &= 247;
254  return;
255  }

◆ setQuality()

void xAOD::Muon_v1::setQuality ( Quality  )

Definition at line 234 of file Muon_v1.cxx.

234  {
235  static const Accessor< uint8_t > acc( "quality" );
236  uint8_t temp = static_cast< uint8_t >(value);
237  acc( *this ) = acc( *this ) & ~(0x7); // Reset the first 3 bits.
238  acc( *this ) |= temp;
239  return;
240  }

◆ setStore() [1/3]

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

Set the store associated with this object.

Parameters
storeThe new store.

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

Parameters
storeLink to the new store.

Definition at line 269 of file AuxElement.cxx.

270 {
271  AuxElementStandaloneData* data = setStore1 (store);
272  if (store)
273  data->setStore (store);
274 }

◆ setStore() [2/3]

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

Set the store associated with this object.

Parameters
storeThe new store.

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

Definition at line 241 of file AuxElement.cxx.

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

◆ setStore() [3/3]

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

Set the store associated with this object.

Parameters
storeThe new store.

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

Definition at line 257 of file AuxElement.cxx.

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

◆ setStore1()

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

Set the store associated with this object.

Parameters
storeThe new store.

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

Parameters
storeThe new store.

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

Definition at line 461 of file AuxElement.cxx.

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

◆ setSummaryValue() [1/2]

void xAOD::Muon_v1::setSummaryValue ( uint8_t  value,
const MuonSummaryType  information 
)

Set method for MuonSummaryType.

Definition at line 176 of file Muon_v1.cxx.

176  {
177  const Muon_v1::Accessor< uint8_t >* acc = muonTrackSummaryAccessorV1( information );
178  // Set the value:
179  ( *acc )( *this ) = value;
180  }

◆ setSummaryValue() [2/2]

void xAOD::Muon_v1::setSummaryValue ( uint8_t  value,
const SummaryType  information 
)

Set method for storing TrackSummary SummaryType information on the Muon (see Aux to see which is already defined as static)

FIXME!

Definition at line 136 of file Muon_v1.cxx.

136  {
137  const Muon_v1::Accessor< uint8_t >* acc = trackSummaryAccessorV1<uint8_t>( information );
138  // Set the value:
139  ( *acc )( *this ) = value;
140  }

◆ setTrackParticleLink()

void xAOD::Muon_v1::setTrackParticleLink ( TrackParticleType  type,
const ElementLink< TrackParticleContainer > &  link 
)

Set method for TrackParticle links.

Definition at line 506 of file Muon_v1.cxx.

506  {
507  switch ( type ) {
508  case InnerDetectorTrackParticle :
509  static const Accessor< ElementLink< TrackParticleContainer > > acc1( "inDetTrackParticleLink" );
510  acc1(*this)=link;
511  break;
512  case MuonSpectrometerTrackParticle :
513  static const Accessor< ElementLink< TrackParticleContainer > > acc2( "muonSpectrometerTrackParticleLink" );
514  acc2(*this)=link;
515  break;
516  case CombinedTrackParticle :
517  static const Accessor< ElementLink< TrackParticleContainer > > acc3( "combinedTrackParticleLink" );
518  acc3(*this)=link;
519  break;
520  case ExtrapolatedMuonSpectrometerTrackParticle :
521  static const Accessor< ElementLink< TrackParticleContainer > > acc4( "extrapolatedMuonSpectrometerTrackParticleLink" );
522  acc4(*this)=link;
523  break;
524  case MSOnlyExtrapolatedMuonSpectrometerTrackParticle :
525  static const Accessor< ElementLink< TrackParticleContainer > > acc5( "msOnlyExtrapolatedMuonSpectrometerTrackParticleLink" );
526  acc5(*this)=link;
527  break;
528  case Primary :
529  default:
530  throw std::runtime_error("Unknown or Primary TrackParticleType - not sure which track particle to set!");
531  }
532  }

◆ summaryValue() [1/3]

bool xAOD::Muon_v1::summaryValue ( float value,
const SummaryType  information 
) const

summaryValue(uint8_t& value, const SummaryType information) const;

summaryValue(uint8_t& value, const SummaryType information) const;

Definition at line 144 of file Muon_v1.cxx.

144  {
146  if (!el.isValid()) return false;
147  return (*el)->summaryValue(value,information);
148  }

◆ summaryValue() [2/3]

bool xAOD::Muon_v1::summaryValue ( uint8_t value,
const MuonSummaryType  information 
) const

Accessor for MuonSummaryType.

Definition at line 160 of file Muon_v1.cxx.

160  {
161  const Muon_v1::Accessor< uint8_t >* acc = muonTrackSummaryAccessorV1( information );
162  if( ! acc ) return false;
163  if( ! acc->isAvailable( *this ) ) return false;
164 
165  // Retrieve the value:
166  value = ( *acc )( *this );
167  return true;
168  }

◆ summaryValue() [3/3]

bool xAOD::Muon_v1::summaryValue ( uint8_t value,
const SummaryType  information 
) const

Accessor for TrackSummary values (in most cases, retrieved from the 'primary' TrackParticle - though it could be stored on the Muon, depending on the job configuration) If 'information' is stored in the primary TrackParticle/Muon and is of the correct templated type T, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'.

See below for an example of how this is intended to be used.

ATH_MSG_INFO("Successfully retrieved the integer value, numberOfInnermostPixelLayerHits");
}
float numberOfCscPhiHits=0.0; //Wrong! This is actually an int too.
if( !myParticle.summaryValue<float>(numberOfCscPhiHits,numberOfCscPhiHits) ){
ATH_MSG_INFO("Types must match!");
}
Parameters
[in]informationThe information being requested. This is not guaranteed to be stored in all Muons (or primary TrackParticle).
[out]valueOnly filled if this Muon (or its primary TrackParticle) contains 'information', and the types match.
Returns
Returns 'true' if the Muon contains 'information', and its concrete type matches 'value' (templated type T).

Definition at line 120 of file Muon_v1.cxx.

120  {
121  // Here we want to check if this information has been added to the Muon, and use this first if so.
122  // @todo ?Could further optimise the below, to see first if the SummaryType value is one of the ones we write to Muons?
123  // @todo ?Is there a better way than catching the exception?
124  try {
125  const Muon_v1::Accessor< uint8_t >* acc = trackSummaryAccessorV1<uint8_t>( information );
126  value = ( *acc )( *this );
127  return true;
128  } catch ( SG::ExcBadAuxVar& ) {}
129 
130  // Okay - fallback: try to get from TrackParticle.
132  if (!el.isValid()) return false;
133  return (*el)->summaryValue(value,information);
134  }

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

◆ trackParticle()

const xAOD::TrackParticle * xAOD::Muon_v1::trackParticle ( TrackParticleType  type) const

Returns a pointer (which can be NULL) to the TrackParticle used in identification of this muon.

Definition at line 487 of file Muon_v1.cxx.

487  {
488  // TODO - perhaps we can get rid of this try/catch clause?
489  try {
490  // Get the ElementLink pointing to the requested track particle:
493 
494  // If it's invalid, return a null pointer:
495  if( ! el.isValid() ) {
496  return nullptr;
497  }
498 
499  // If it's valid, let's de-reference it:
500  return *el;
501  } catch ( SG::ExcBadAuxVar& ) {
502  return nullptr;
503  }
504  }

◆ trackParticleLink()

const ElementLink< TrackParticleContainer > & xAOD::Muon_v1::trackParticleLink ( TrackParticleType  type) const

Returns an ElementLink to the TrackParticle used in identification of this muon.

Definition at line 460 of file Muon_v1.cxx.

460  {
461  switch ( type ) {
462  case Primary :
463  return primaryTrackParticleLink();
464  break;
465  case CombinedTrackParticle :
466  return combinedTrackParticleLink();
467  break;
468  case InnerDetectorTrackParticle :
469  return inDetTrackParticleLink();
470  break;
471  case MuonSpectrometerTrackParticle :
473  break;
474  case ExtrapolatedMuonSpectrometerTrackParticle :
476  break;
477  case MSOnlyExtrapolatedMuonSpectrometerTrackParticle :
479  break;
480  default:
481  throw std::runtime_error("Unknown TrackParticleType - not sure which track particle to return!");
482  }
483  // static ElementLink< TrackParticleContainer > dummy;
484  // return dummy;
485  }

◆ type()

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

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 97 of file Muon_v1.cxx.

97  {
98  return Type::Muon;
99  }

◆ uint8MuonSummaryValue()

float xAOD::Muon_v1::uint8MuonSummaryValue ( const MuonSummaryType  information) const

Same as bool summaryValue(uint8_t& value, const MuonSummaryType &information) const, but without check (will throw exception if value isn't there) Primarily for use in Python.

Definition at line 170 of file Muon_v1.cxx.

170  {
171  const Muon_v1::Accessor< uint8_t >* acc = muonTrackSummaryAccessorV1( information );
172  return ( *acc )( *this );
173  }

◆ uint8SummaryValue()

uint8_t xAOD::Muon_v1::uint8SummaryValue ( const SummaryType  information) const

Same as bool summaryValue(uint8_t& value, const SummaryType &information) const, but without check (will throw exception if value isn't there) Primarily for use in Python.

Definition at line 155 of file Muon_v1.cxx.

155  {
156  const Muon_v1::Accessor< uint8_t >* acc = trackSummaryAccessorV1< uint8_t >( information );
157  return ( *acc )( *this );
158  }

◆ usingPrivateStore()

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

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

Definition at line 280 of file AuxElement.cxx.

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

◆ usingStandaloneStore()

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

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

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

Definition at line 290 of file AuxElement.cxx.

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

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:
python.CaloBCIDAvgAlgConfig.acc3
def acc3
Definition: CaloBCIDAvgAlgConfig.py:69
xAOD::Muon_v1::primaryTrackParticleLink
const ElementLink< TrackParticleContainer > & primaryTrackParticleLink() const
Definition: Muon_v1.cxx:361
SG::AuxVectorData::getConstStore
const SG::IConstAuxStore * getConstStore() const
Return the current store, as a const interface.
SGTest::store
TestStore store
Definition: TestStore.cxx:23
beamspotman.r
def r
Definition: beamspotman.py:674
SG::ConstAuxElement::getAuxIDs
const SG::auxid_set_t & getAuxIDs() const
Return a set of identifiers for existing data items for this object.
Definition: AuxElement.cxx:153
data
char data[hepevt_bytes_allocation_ATLAS]
Definition: HepEvt.cxx:11
xAOD::name
name
Definition: TriggerMenuJson_v1.cxx:29
xAOD::trackSummaryAccessorV1< float >
const SG::AuxElement::Accessor< float > * trackSummaryAccessorV1< float >(xAOD::SummaryType type)
Definition: TrackSummaryAccessors_v1.cxx:127
PowhegControl_ttHplus_NLO.ss
ss
Definition: PowhegControl_ttHplus_NLO.py:83
xAOD::Muon_v1::msOnlyExtrapolatedMuonSpectrometerTrackParticleLink
const ElementLink< TrackParticleContainer > & msOnlyExtrapolatedMuonSpectrometerTrackParticleLink() const
Returns an ElementLink to the MS-only Extrapolated Muon Spectrometer TrackParticle used in identifica...
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
xAOD::uint8_t
uint8_t
Definition: Muon_v1.cxx:558
SG::AuxTypeRegistry::instance
static AuxTypeRegistry & instance()
Return the singleton registry instance.
Definition: AuxTypeRegistry.cxx:639
SG::Accessor< T >
SG::AuxVectorData::getDecorIDs
const SG::auxid_set_t & getDecorIDs() const
Return a set of identifiers for decorations for this object.
Definition: AuxVectorData.cxx:215
xAOD::Muon_v1::p4
virtual FourMom_t p4() const
The full 4-momentum of the particle.
Definition: Muon_v1.cxx:80
SG::AuxVectorData::getWritableAuxIDs
const SG::auxid_set_t & getWritableAuxIDs() const
Return a set of identifiers for writable data items in this store.
Definition: AuxVectorData.cxx:231
index
Definition: index.py:1
xAOD::Muon_v1::phi
virtual double phi() const
The azimuthal angle ( ) of the particle.
SG::ConstAuxElement::m_container
const SG::AuxVectorData * m_container
The container of which this object is an element.
Definition: AuxElement.h:335
ParticleConstants::PDG2011::muonMassInMeV
constexpr double muonMassInMeV
the mass of the muon (in MeV)
Definition: ParticleConstants.h:29
SG::AuxElement::clearAuxHelper
static void clearAuxHelper(AuxVectorData &container, size_t index)
Clear all aux data associated with an element.
Definition: AuxElement.cxx:639
xAOD::Muon_v1::eta
virtual double eta() const
The pseudorapidity ( ) of the particle.
SG::AuxVectorData::hasNonConstStore
bool hasNonConstStore() const
Return true if this object has an associated non-const store.
egammaParameters::ParamDef
ParamDef
Definition: egammaParamDefs.h:99
athena.value
value
Definition: athena.py:124
SG::AuxElement::usingStandaloneStore
bool usingStandaloneStore() const
Test to see if this object is currently using a standalone store.
Definition: AuxElement.cxx:290
SG::ConstAuxElement::setIndexPrivate
bool setIndexPrivate(size_t index, const SG::AuxVectorData *container)
Set the index/container for this element.
Definition: AuxElement.cxx:97
xAOD::Muon_v1::author
Author author() const
SG::ConstAccessor< T >
xAOD::trackSummaryAccessorV1< uint8_t >
const SG::AuxElement::Accessor< uint8_t > * trackSummaryAccessorV1< uint8_t >(xAOD::SummaryType type)
Definition: TrackSummaryAccessors_v1.cxx:25
SG::ExcConstAuxData
Exception — Non-const operation performed on const aux data.
Definition: Control/AthContainers/AthContainers/exceptions.h:77
SG::IAuxElement::setNoPrivateData
void setNoPrivateData()
Record that this element does not have private data.
SG::AuxVectorData::getAuxIDs
const SG::auxid_set_t & getAuxIDs() const
Return a set of identifiers for existing data items in store associated with this object.
Definition: AuxVectorData.cxx:203
xAOD::getIsolationCorrectionAccessor
const SG::AuxElement::Accessor< float > getIsolationCorrectionAccessor(Iso::IsolationFlavour type, Iso::IsolationCaloCorrection corr, Iso::IsolationCorrectionParameter param)
Definition: getIsolationCorrectionAccessor.cxx:19
xAOD::muonTrackSummaryAccessorV1
const SG::AuxElement::Accessor< uint8_t > * muonTrackSummaryAccessorV1(xAOD::MuonSummaryType type)
Helper function for managing MuonTrackSummary Accessor objects.
Definition: MuonTrackSummaryAccessors_v1.cxx:23
SG::AuxTypeRegistry
Handle mappings between names and auxid_t.
Definition: AuxTypeRegistry.h:61
xAOD::Muon_v1::trackParticleLink
const ElementLink< TrackParticleContainer > & trackParticleLink(TrackParticleType type) const
Returns an ElementLink to the TrackParticle used in identification of this muon.
Definition: Muon_v1.cxx:460
InDet::ExclusiveOrigin::Primary
@ Primary
Definition: InDetTrackTruthOriginDefs.h:163
SG::IAuxElement::index
size_t index() const
Return the index of this element within its container.
xAOD::Muon_v1::clusterLink
const ElementLink< CaloClusterContainer > & clusterLink() const
Returns an ElementLinkto the cluster associated to this muon.
SG::IAuxElement::setHadPrivateData
void setHadPrivateData()
Record that this element used to have private data.
SG::auxid_t
size_t auxid_t
Identifier for a particular aux data item.
Definition: AuxTypes.h:27
histSizes.code
code
Definition: histSizes.py:129
SG::ExcBadAuxVar
Exception — Attempt to retrieve nonexistent aux data item.
Definition: Control/AthContainers/AthContainers/exceptions.h:59
xAOD::Muon_v1::FourMom_t
IParticle::FourMom_t FourMom_t
Definition of the 4-momentum type.
Definition: Muon_v1.h:74
lumiFormat.i
int i
Definition: lumiFormat.py:85
SG::AuxElement::copyAux
void copyAux(const ConstAuxElement &other, bool warnUnlocked=false)
Copy aux data from another object.
Definition: AuxElement.cxx:600
SG::AuxElement::AuxElement
AuxElement()
Default constructor.
DMTest::links
links
Definition: CLinks_v1.cxx:22
python.CaloBCIDAvgAlgConfig.acc1
def acc1
Definition: CaloBCIDAvgAlgConfig.py:49
SG::IAuxElement::havePrivateData
bool havePrivateData() const
True if this element currently has private data.
ATHCONTAINERS_WARNING
#define ATHCONTAINERS_WARNING(ctx, msg)
Definition: error.h:57
xAOD::Muon_v1::parameter
bool parameter(float &value, const ParamDef parameter) const
Get a parameter for this Muon - momentumBalanceSignificance for example.
SG::AuxVectorData::getStore
SG::IAuxStore * getStore()
Return the current store, as a non-const interface.
xAOD::Muon_v1::muonSpectrometerTrackParticleLink
const ElementLink< TrackParticleContainer > & muonSpectrometerTrackParticleLink() const
Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon.
CalibDbCompareRT.dummy
dummy
Definition: CalibDbCompareRT.py:59
SG::ConstAuxElement::getDecorIDs
const SG::auxid_set_t & getDecorIDs() const
Return a set of identifiers for decorations for this object.
Definition: AuxElement.cxx:172
python.CaloBCIDAvgAlgConfig.acc2
def acc2
Definition: CaloBCIDAvgAlgConfig.py:59
plotIsoValidation.el
el
Definition: plotIsoValidation.py:197
xAOD::Muon_v1::pt
virtual double pt() const
The transverse momentum ( ) of the particle.
AthenaPoolTestRead.acc
acc
Definition: AthenaPoolTestRead.py:16
SG::AuxElementPrivateData
Internal data container for private store.
Definition: AuxElement.cxx:46
xAOD::Muon_v1::m
virtual double m() const
The invariant mass of the particle..
Definition: Muon_v1.cxx:63
xAOD::getIsolationAccessor
const SG::AuxElement::Accessor< float > * getIsolationAccessor(Iso::IsolationType type)
Get the Accessor object for a given isolation type.
Definition: getIsolationAccessor.cxx:24
SG::AuxVectorData::hasStore
bool hasStore() const
Return true if this object has an associated store.
python.LArRecUtilsConfig.acc4
def acc4
Definition: LArRecUtilsConfig.py:196
python.LArRecUtilsConfig.acc5
def acc5
Definition: LArRecUtilsConfig.py:205
xAOD::Muon_v1::type
virtual Type::ObjectType type() const
The type of the object as a simple enumeration.
Definition: Muon_v1.cxx:97
Trk::Combined
@ Combined
Definition: TrackSummaryTool.h:32
SG::IAuxElement::setHavePrivateData
void setHavePrivateData()
Record that this element currently has private data.
SG::AuxVectorData::clearCache
void clearCache()
Clear the cached aux data pointers.
SG::AuxElement::makePrivateStore
void makePrivateStore()
Create a new (empty) private store for this object.
Definition: AuxElement.cxx:192
CxxUtils::to
CONT to(RANGE &&r)
Definition: ranges.h:39
Muon
struct TBPatternUnitContext Muon
SG::AuxElement::hasStore
bool hasStore() const
Return true if this object has an associated store.
Definition: AuxElement.cxx:398
xAOD::IParticle::IParticle
IParticle()=default
xAOD::Muon_v1::inDetTrackParticleLink
const ElementLink< TrackParticleContainer > & inDetTrackParticleLink() const
Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon.
SG::IAuxElement::setIndex
void setIndex(size_t index)
Set the index of this element within its container.
InDetDD::other
@ other
Definition: InDetDD_Defs.h:16
SG::AuxVectorData::clearDecorations
bool clearDecorations() const
Clear all decorations.
Definition: AuxVectorData.cxx:653
SG::ExcBadPrivateStore
Exception — Bad use of private store.
Definition: Control/AthContainers/AthContainers/exceptions.h:113
xAOD::Muon_v1::GenVecFourMom_t
ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > > GenVecFourMom_t
Base 4 Momentum type for Muon.
Definition: Muon_v1.h:80
SG::Accessor::isAvailableWritable
bool isAvailableWritable(ELT &e) const
Test to see if this variable exists in the store and is writable.
SG::IConstAuxStore::getDecorIDs
virtual const SG::auxid_set_t & getDecorIDs() const =0
Return a set of identifiers for decorations in this store.
xAOD::getIsolationCorrectionBitsetAccessor
const SG::AuxElement::Accessor< uint32_t > getIsolationCorrectionBitsetAccessor(Iso::IsolationFlavour type)
Returns an accessor for the correction bitset corresponding to this IsolationType.
Definition: getIsolationCorrectionAccessor.cxx:12
xAOD::Muon_v1::genvecP4
GenVecFourMom_t genvecP4() const
The full 4-momentum of the particle : GenVector.
Definition: Muon_v1.cxx:87
xAOD::Muon_v1::muonSegmentLink
const ElementLink< MuonSegmentContainer > & muonSegmentLink(size_t i) const
Returns a link to the specified MuonSegment.
Definition: Muon_v1.cxx:572
xAOD::Muon_v1::extrapolatedMuonSpectrometerTrackParticleLink
const ElementLink< TrackParticleContainer > & extrapolatedMuonSpectrometerTrackParticleLink() const
Returns an ElementLink to the Extrapolated Muon Spectrometer TrackParticle used in identification of ...
SG::auxid_set_t
A set of aux data identifiers.
Definition: AuxTypes.h:47
SG::ConstAccessor::isAvailable
bool isAvailable(const ELT &e) const
Test to see if this variable exists in the store.
SG::AuxVectorData
Manage lookup of vectors of auxiliary data.
Definition: AuxVectorData.h:168
ATLAS_THREAD_SAFE
#define ATLAS_THREAD_SAFE
Definition: checker_macros.h:211
SG::ConstAuxElement::releasePrivateStoreForDtor
void releasePrivateStoreForDtor()
Out-of-line portion of destructor.
Definition: AuxElement.cxx:80
SG::AuxElement::container
const SG::AuxVectorData * container() const
Return the container holding this element.
Trk::numberOfCscPhiHits
@ numberOfCscPhiHits
Definition: Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h:107
SG::IAuxElement::hadPrivateData
bool hadPrivateData() const
True if this element had private data before it was added to its current container.
xAOD::IParticle::operator=
IParticle & operator=(const IParticle &)=default
SG::AuxElement::copyAuxHelper
static void copyAuxHelper(AuxVectorData &container, size_t index, const ConstAuxElement &other, bool warnUnlocked)
Copy aux data from another object.
Definition: AuxElement.cxx:667
SG::IConstAuxStore::getAuxIDs
virtual const SG::auxid_set_t & getAuxIDs() const =0
Return a set of identifiers for existing data items in this store.
SG::AuxElement::setStore1
AuxElementStandaloneData * setStore1(const SG::IConstAuxStore *store)
Set the store associated with this object.
Definition: AuxElement.cxx:461
xAOD::numberOfInnermostPixelLayerHits
@ numberOfInnermostPixelLayerHits
these are the hits in the 0th pixel barrel layer
Definition: TrackingPrimitives.h:238
xAOD::Muon_v1::combinedTrackParticleLink
const ElementLink< TrackParticleContainer > & combinedTrackParticleLink() const
Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon.
xAOD::Muon_v1::muonType
MuonType muonType() const
CxxUtils::ConcurrentBitset::test
bool test(bit_t bit) const
Test to see if a bit is set.