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	Decorator = SG::Decorator<T, ALLOC>

Public Member Functions
	Muon_v1 ()=default
	inject the enums
	Muon_v1 (const Muon_v1 &rhs)
	Copy constructor.
virtual	~Muon_v1 ()=default
	Destructor.
Muon_v1 &	operator= (const Muon_v1 &rhs)
	Assignment operator.
bool	isolationCaloCorrection (float &value, const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection type, const Iso::IsolationCorrectionParameter param) const
	Accessor for Isolation Calo correction.
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.
bool	setIsolationCaloCorrection (float value, const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection type, const Iso::IsolationCorrectionParameter param)
	set method for Isolation Calo Corrections.
bool	isolationTrackCorrection (float &value, const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection type) const
	Accessor for Isolation Track correction.
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.
bool	setIsolationTrackCorrection (float value, const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection type)
	Set method for Isolation Track Corrections.
bool	isolationCorrectionBitset (std::bitset< 32 > &value, const Iso::IsolationFlavour flavour) const
	Accessor for Isolation corection Bitset.
std::bitset< 32 >	isolationCorrectionBitset (const Iso::IsolationFlavour flavour) const
	Accessor to Isolation corection Bitset , this just returns the bitset without internaly checking if it exists.
bool	setIsolationCorrectionBitset (uint32_t value, const Iso::IsolationFlavour flavour)
	Set method for Isolation corection Bitset.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name)
	Fetch an aux data variable, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="")
	Check if an aux variable is available for writing.
void	assign (const AuxElement &other, bool warnUnlocked=false)
	Assignment.
const SG::AuxVectorData *	container () const
	Return the container holding this element.
SG::AuxVectorData *	container ()
	Return the container holding this element.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for writing as a decoration.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name) const
	Fetch an aux decoration, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name, const std::string &clsname) const
	Fetch an aux decoration, as a non-const reference.
void	makePrivateStore ()
	Create a new (empty) private store for this object.
template<class U1>
void	makePrivateStore (const U1 &other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
template<class U1>
void	makePrivateStore (const U1 *other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
void	releasePrivateStore ()
	Release and free any private store associated with this object.
void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object.
void	setStore (SG::IAuxStore *store)
	Set the store associated with this object.
void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object.
void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for `setStore` with `IConstAuxStore`.
void	setNonConstStore (SG::IAuxStore *store)
	Synonym for `setStore` with `IAuxStore`.
bool	usingPrivateStore () const
	Test to see if this object is currently using a private store.
bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store.
void	clearCache ()
	Clear the cached aux data pointers.
const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object.
const SG::auxid_set_t &	getDecorIDs () const
	Return a set of identifiers for decorations for this object.
bool	hasStore () const
	Return true if this object has an associated store.
bool	hasNonConstStore () const
	Return true if this object has an associated non-const store.
bool	clearDecorations () const
	Clear all decorations.
bool	trackIndices () const
	Return true if index tracking is enabled for this object.
size_t	index () const
	Return the index of this element within its container.

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

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

Protected Member Functions
const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface.
SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface.
bool	noPrivateData () const
	True if this element has no private data.
bool	havePrivateData () const
	True if this element currently has private data.
bool	hadPrivateData () const
	True if this element had private data before it was added to its current container.

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

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

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

Private Attributes
const SG::AuxVectorData *	m_container
	The container of which this object is an element.
size_t	m_index
	The index of this element within its container.
PrivateStoreState	m_privateStoreState

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

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

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.
void	setAuthor (Author auth)
	set author
uint16_t	allAuthors () const
	Get all the authors of this Muon.
void	setAllAuthors (uint16_t authors)
void	addAllAuthor (const Author author)
	add author to all authors

Summary information
Return summary information about the muon, such as its MuonType, and the TrackSumary values of the primary TrackParticle.
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'.
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)
bool	summaryValue (float &value, const SummaryType information) const
	summaryValue(uint8_t& value, const SummaryType information) const;
bool	summaryValue (uint8_t &value, const MuonSummaryType information) const
	Accessor for MuonSummaryType.
void	setSummaryValue (uint8_t value, const MuonSummaryType information)
	Set method for MuonSummaryType.
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.
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.
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.
bool	parameter (float &value, const ParamDef parameter) const
	Get a parameter for this Muon - momentumBalanceSignificance for example.
void	setParameter (float value, const ParamDef parameter)
	Set method for parameter values.
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).
bool	parameter (int &value, const ParamDef parameter) const
	Get an integer parameter for this Muon - msInnerMatchDOF for example.
void	setParameter (int value, const ParamDef parameter)
	Set method for parameter values.
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).
Quality	quality () const
	Muon CP quality accessors.
void	setQuality (Quality)
bool	passesIDCuts () const
	MCP ID hit cuts - get/set the corresponding status bit in the quality decoration.
void	setPassesIDCuts (bool)

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

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: CombinedTrackParticle InnerDetectorTrackParticle ExtrapolatedMuonSpectrometerTrackParticle MSOnlyExtrapolatedMuonSpectrometerTrackParticle 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 TrackParticle *	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.
const ElementLink< TrackParticleContainer > &	inDetTrackParticleLink () const
	Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon.
const ElementLink< TrackParticleContainer > &	muonSpectrometerTrackParticleLink () const
	Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon.
const ElementLink< TrackParticleContainer > &	combinedTrackParticleLink () const
	Returns an ElementLink to the InnerDetector TrackParticle used in identification of this muon.
const ElementLink< TrackParticleContainer > &	extrapolatedMuonSpectrometerTrackParticleLink () const
	Returns an ElementLink to the Extrapolated Muon Spectrometer TrackParticle used in identification of this muon.
const ElementLink< TrackParticleContainer > &	msOnlyExtrapolatedMuonSpectrometerTrackParticleLink () const
	Returns an ElementLink to the MS-only Extrapolated Muon Spectrometer TrackParticle used in identification of this muon.
const ElementLink< TrackParticleContainer > &	trackParticleLink (TrackParticleType type) const
	Returns an ElementLink to the TrackParticle used in identification of this muon.
void	setTrackParticleLink (TrackParticleType type, const ElementLink< TrackParticleContainer > &link)
	Set method for TrackParticle links.
const TrackParticle *	trackParticle (TrackParticleType type) const
	Returns a pointer (which can be NULL) to the TrackParticle used in identification of this muon.
const ElementLink< CaloClusterContainer > &	clusterLink () const
	Returns an ElementLinkto the cluster associated to this muon.
void	setClusterLink (const ElementLink< CaloClusterContainer > &link)
	Set method for cluster links.
const CaloCluster *	cluster () const
	Retrieve the associated cluster with a bare pointer.
EnergyLossType	energyLossType (void) const
	Energy determined from parametrization or not (measured).
void	setEnergyLossType (EnergyLossType type)
	Set method for the type.
const std::vector< ElementLink< MuonSegmentContainer > > &	muonSegmentLinks () const
	Returns a vector of ElementLinks to the MuonSegments used to create this Muon.
void	setMuonSegmentLinks (const std::vector< ElementLink< MuonSegmentContainer > > &segments)
	Set the vector of ElementLinks to the MuonSegments used to create this Muon.
size_t	nMuonSegments () const
	Number of MuonSegments linked to by this Muon.
const MuonSegment *	muonSegment (size_t i) const
	Returns a pointer to the specified MuonSegment.
const ElementLink< MuonSegmentContainer > &	muonSegmentLink (size_t i) const
	Returns a link to the specified MuonSegment.

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

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

protectedinherited

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

typedef IParticle::FourMom_t xAOD::Muon_v1::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 class SG::IAuxElement::PrivateStoreState : uint8_t

strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE
HAVE_PRIVATE
HAD_PRIVATE

Definition at line 131 of file IAuxElement.h.

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

Constructor & Destructor Documentation

◆ Muon_v1() [1/2]

xAOD::Muon_v1::Muon_v1 ( )

default

inject the enums

Default constructor

◆ Muon_v1() [2/2]

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

Copy constructor.

Definition at line 25 of file Muon_v1.cxx.

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

◆ ~Muon_v1()

virtual xAOD::Muon_v1::~Muon_v1 ( )

virtualdefault

Destructor.

Member Function Documentation

◆ addAllAuthor()

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

add author to all authors

Definition at line 92 of file Muon_v1.cxx.

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

◆ allAuthors()

uint16_t xAOD::Muon_v1::allAuthors ( ) const

Get all the authors of this Muon.

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

other	The object from which we're assigning.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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

◆ author()

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

name	Name of the aux variable.

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

◆ auxdata() [2/4]

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

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

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

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

◆ auxdata() [3/4]

template<class T>

XAOD_AUXDATA_DEPRECATED T & xAOD::IParticle::auxdata	(	const std::string &	name,
		const std::string &	clsname = "" )

inlineinherited

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

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

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

Parameters

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

Returns: A modifiable reference to the decoration

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

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

◆ auxdata() [4/4]

template<class T>

XAOD_AUXDATA_DEPRECATED const T & xAOD::IParticle::auxdata	(	const std::string &	name,
		const std::string &	clsname = "" ) const

inlineinherited

Fetch an aux data variable, as a const reference.

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

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

Parameters

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

Returns: A constant reference to the decoration

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

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

◆ auxdataConst() [1/2]

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

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

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

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

◆ auxdataConst() [2/2]

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

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

inherited

Fetch an aux data variable, as a const reference.

Parameters

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

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

◆ auxdecor() [1/2]

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

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

inherited

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

Parameters

name	Name of the aux variable.

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

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

◆ auxdecor() [2/2]

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

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

inherited

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

Parameters

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

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

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

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

{
  if (!m_container) return;
  clearAuxHelper (*container(), index());
}

◆ clearAuxHelper()

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

staticprivateinherited

Clear all aux data associated with an element.

Parameters

container	Container of the element.
index	Index of this element within the container.

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

Definition at line 639 of file AuxElement.cxx.

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

◆ clearCache()

void SG::AuxElement::clearCache ( )

inherited

Clear the cached aux data pointers.

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

Definition at line 339 of file AuxElement.cxx.

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

◆ clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

inherited

Clear all decorations.

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

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

Definition at line 428 of file AuxElement.cxx.

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

◆ cluster()

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

Retrieve the associated cluster with a bare pointer.

Definition at line 530 of file Muon_v1.cxx.

                                            { 
    
    static const Accessor< ElementLink< TrackParticleContainer > > acc( "inDetTrackParticleLink" );
    if( ! acc.isAvailable( *this ) ) {
       return nullptr;
    }
    const ElementLink< TrackParticleContainer >& link = acc( *this );
    if( ! link.isValid() ) {
       return nullptr;
    }
    
    // Get the ElementLink pointing to the calo cluster: 
    const ElementLink< CaloClusterContainer >& el = clusterLink(); 
    // If it's invalid, return a null pointer: 
    if( ! el.isValid() ) { 
      return nullptr; 
    } 
    // If it's valid, let's de-reference it: 
    return *el; 
  } 

◆ 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

other	The object from which to copy.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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

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

Definition at line 600 of file AuxElement.cxx.

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

◆ copyAuxHelper()

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

staticprivateinherited

Copy aux data from another object.

Parameters

container	Container of the element.
index	Index of this element within the container.
other	The object from which to copy.
warnUnlocked	If 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.

{
  if (!container.hasStore()) return;
  if (!container.hasNonConstStore())
    throw SG::ExcConstAuxData ("copyAux");
 
  const SG::AuxVectorData* ocont = other.container();
 
  if (!ocont || !ocont->hasStore()) {
    AuxElement::clearAuxHelper (container, index);
    return;
  }
 
#ifndef XAOD_STANDALONE
  const SG::auxid_set_t& other_decors = ocont->getDecorIDs();
#endif
  SG::auxid_set_t other_ids = ocont->getAuxIDs();
 
  size_t oindex = other.index();
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
 
  for (SG::auxid_t auxid : other_ids) {
#ifndef XAOD_STANDALONE
    if (other_decors.test (auxid)) {
      // Don't copy decorations --- another thread may be modifying them.
      other_ids.reset (auxid);
      // Warn if we skip a decoration (except for mcEventWeights,
      // for which this is expected).
      if (warnUnlocked && r.getName(auxid) != "mcEventWeights") {
        std::ostringstream ss;
        ss << "skipped unlocked decoration " << r.getName(auxid)
           << " (" << auxid << ")";
        ATHCONTAINERS_WARNING("copyAux", ss.str());
      }
    }
    else
#endif
    if (!r.isLinked (auxid)) {
      r.copy (auxid, container, index, *ocont, oindex, 1);
    }
  }
 
  for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
    if (!other_ids.test (auxid)) {
      r.clear (auxid, container, index, 1);
    }
  }
}

◆ e()

double xAOD::Muon_v1::e ( ) const

virtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 49 of file Muon_v1.cxx.

                          {
    // FIXME - optimise?
    return genvecP4().E();
  }

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

xAOD::Muon_v1::parameter

bool parameter(float &value, const ParamDef parameter) const

Get a parameter for this Muon - momentumBalanceSignificance for example.

◆ 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 178 of file Muon_v1.cxx.

                                                                        {
    float sumVal{0.f};
    parameter(sumVal, information);
    return sumVal;
  }

◆ 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 133 of file Muon_v1.cxx.

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

◆ genvecP4()

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

The full 4-momentum of the particle : GenVector.

Definition at line 78 of file Muon_v1.cxx.

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

◆ getAuxIDs()

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

inherited

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

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

Definition at line 355 of file AuxElement.cxx.

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

◆ getConstStore()

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

protectedinherited

Return the current store, as a const interface.

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

Definition at line 869 of file AuxElement.cxx.

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

◆ getDecorIDs()

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

inherited

Return a set of identifiers for decorations for this object.

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

Definition at line 378 of file AuxElement.cxx.

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

◆ getStore()

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

protectedinherited

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

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

Definition at line 878 of file AuxElement.cxx.

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

◆ hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

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

◆ hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

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

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

Definition at line 411 of file AuxElement.cxx.

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

◆ hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

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

Definition at line 398 of file AuxElement.cxx.

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

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

◆ inDetTrackParticleLink()

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

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

◆ index()

size_t SG::IAuxElement::index ( ) const

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 205 of file Muon_v1.cxx.

                                                                    {
      int sumValue{0};
      parameter(sumValue, information);
      return sumValue;
  }

◆ isAuthor()

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

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

Definition at line 97 of file Muon_v1.cxx.

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

◆ isAvailable()

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailable	(	const std::string &	name,
		const std::string &	clsname = "" ) const

inlineinherited

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

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

Parameters

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

Returns: Whether the decoration exists or not

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

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

◆ isAvailableWritable() [1/2]

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

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

inherited

Check if an aux variable is available for writing.

Parameters

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

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

◆ isAvailableWritable() [2/2]

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailableWritable	(	const std::string &	name,
		const std::string &	clsname = "" ) const

inlineinherited

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

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

Parameters

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

Returns: Whether the decoration is possible to set

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

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

◆ isAvailableWritableAsDecoration()

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

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

inherited

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

Parameters

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

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

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

                                                                     {
    float isoVal{0.f};
    isolation(isoVal, information);
    return isoVal;
  }

◆ 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 254 of file Muon_v1.cxx.

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

◆ 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 291 of file Muon_v1.cxx.

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

◆ 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 281 of file Muon_v1.cxx.

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

◆ 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 337 of file Muon_v1.cxx.

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

◆ 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 329 of file Muon_v1.cxx.

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

◆ isolationTrackCorrection() [1/2]

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

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

◆ 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 307 of file Muon_v1.cxx.

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

◆ m()

double xAOD::Muon_v1::m ( ) const

virtual

The invariant mass of the particle..

Implements xAOD::IParticle.

Definition at line 54 of file Muon_v1.cxx.

                          {
    return ParticleConstants::muonMassInMeV;
  }

◆ makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )

inherited

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

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

Definition at line 192 of file AuxElement.cxx.

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

◆ makePrivateStore() [2/3]

template<class U1>

void SG::AuxElement::makePrivateStore	(	const U1 &	other,
		bool	warnUnlocked = false )

inherited

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

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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

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

◆ makePrivateStore() [3/3]

template<class U1>

void SG::AuxElement::makePrivateStore	(	const U1 *	other,
		bool	warnUnlocked = false )

inherited

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

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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

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

◆ makePrivateStore1() [1/2]

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

privateinherited

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

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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

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

Definition at line 565 of file AuxElement.cxx.

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

◆ makePrivateStore1() [2/2]

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

privateinherited

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

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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

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

◆ 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

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

Definition at line 577 of file Muon_v1.cxx.

                                                         {  
      // Get the ElementLink pointing to the requested muon segment:
    const ElementLink< MuonSegmentContainer >& el =
      muonSegmentLink( i );
      // If it's invalid, return a null pointer:
    if( ! el.isValid() ) {
      return nullptr;
    }
      // If it's valid, let's de-reference it:
    return *el;
  }

◆ muonSegmentLink()

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

Returns a link to the specified MuonSegment.

Parameters

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

Definition at line 567 of file Muon_v1.cxx.

                                                                                      {
        // If a Trk::Track link was not set (yet), return a dummy object:
      // FIXME - maybe 
    if( ! muonSegmentsAcc.isAvailable( *this ) ) {
      static const ElementLink< MuonSegmentContainer > dummy;
      return dummy;
    }
    return muonSegmentsAcc(*this).at(i);
  }

◆ 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

Todo: Add documentation. Generic accessor to type information.

◆ nMuonSegments()

size_t xAOD::Muon_v1::nMuonSegments ( ) const

Number of MuonSegments linked to by this Muon.

Definition at line 559 of file Muon_v1.cxx.

                                      {
        // If a link was not set (yet), return zero.
    if( ! muonSegmentsAcc.isAvailable( *this ) ) {
      return 0;
    }
    return muonSegmentsAcc(*this).size();
  }

◆ 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 31 of file Muon_v1.cxx.

                                                {
    if(this == &rhs) return *this;
 
    if( ( ! hasStore() ) && ( ! container() ) ) {
       makePrivateStore();
    }
    this->IParticle::operator=( rhs );
    
    return *this;
  }

◆ p4()

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

virtual

The full 4-momentum of the particle.

Implements xAOD::IParticle.

Definition at line 71 of file Muon_v1.cxx.

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

◆ 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

MCP ID hit cuts - get/set the corresponding status bit in the quality decoration.

Definition at line 234 of file Muon_v1.cxx.

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

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

CombinedTrackParticle
InnerDetectorTrackParticle
ExtrapolatedMuonSpectrometerTrackParticle
MSOnlyExtrapolatedMuonSpectrometerTrackParticle
MuonSpectrometerTrackParticle

Definition at line 396 of file Muon_v1.cxx.

                                                              {
    
    MuonType type = muonType();      
    switch( type ) {
      case Combined:
      case SiliconAssociatedForwardMuon :
         {
            static const Accessor< ElementLink< TrackParticleContainer > > acc( "combinedTrackParticleLink" );
            if( ! acc.isAvailable( *this ) ) return nullptr;
          
            const ElementLink< TrackParticleContainer >& link = acc( *this );
            if( ! link.isValid() ) return nullptr;
            
            return *link;
         }
      case SegmentTagged:
      case CaloTagged :
        {
           static const Accessor< ElementLink< TrackParticleContainer > > acc( "inDetTrackParticleLink" );
           if( ! acc.isAvailable( *this ) ) return nullptr;
           
           const ElementLink< TrackParticleContainer >& link = acc( *this );
           if( ! link.isValid() ) return nullptr;
           
           return *link;
        }
      case MuonStandAlone :
        {
          // Want to return link to extrapolated MS track particle if possible.
          static const Accessor< ElementLink< TrackParticleContainer > > acc1( "extrapolatedMuonSpectrometerTrackParticleLink" );
          if ( acc1.isAvailable( *this ) ) {            
            const ElementLink< TrackParticleContainer >& link = acc1( *this );
            if ( link.isValid() ) return *link;
          }
 
      //if no, maybe the MS-only extrapolated track particle?
          static const Accessor< ElementLink< TrackParticleContainer > > acc2( "msOnlyExtrapolatedMuonSpectrometerTrackParticleLink" );
          if ( acc2.isAvailable( *this ) ) {
            const ElementLink< TrackParticleContainer >& link = acc2( *this );
            if ( link.isValid() ) return *link;
          }
          
          // Try fallback (non-extrapolated MS track particle)...
          static const Accessor< ElementLink< TrackParticleContainer > > acc3( "muonSpectrometerTrackParticleLink" );
          if ( acc3.isAvailable( *this ) ) {            
            const ElementLink< TrackParticleContainer >& link = acc3( *this );
            if ( link.isValid() ) return *link;
          }
 
          return nullptr;
        }
      default:
        {
          // No valid link.
          return nullptr;
        }
      }
  }

◆ primaryTrackParticleLink()

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

Definition at line 356 of file Muon_v1.cxx.

                                                                                      {
    MuonType type = muonType();
    switch ( type ) {
      case Combined :
      case SiliconAssociatedForwardMuon :
        return combinedTrackParticleLink();
        break;
      case SegmentTagged :
      case CaloTagged :
        return inDetTrackParticleLink();
        break;
      case MuonStandAlone :
        {          
          // Not checking if links are valid here - this is the job of the client (as per the cases above).
          // But we DO check that the link is available, so we can check for both types of links.
          
          static const Accessor< ElementLink< TrackParticleContainer > > acc1( "extrapolatedMuonSpectrometerTrackParticleLink" );
          if ( acc1.isAvailable( *this ) && acc1( *this ).isValid() ) {
            return acc1( *this );
          }
 
          static const Accessor< ElementLink< TrackParticleContainer > > acc2( "msOnlyExtrapolatedMuonSpectrometerTrackParticleLink" );
          if ( acc2.isAvailable( *this ) && acc2( *this ).isValid() ) {
            return acc2( *this );
          }
          
          static const Accessor< ElementLink< TrackParticleContainer > > acc3( "muonSpectrometerTrackParticleLink" );
          if ( acc3.isAvailable( *this ) && acc3( *this ).isValid()) {            
            return acc3( *this );
          }
          // 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...?
          throw std::runtime_error("Type is MuonStandAlone but no available link to return!");
        }
      default:
        throw std::runtime_error("Unknown primary type - not sure which track particle to return!");
    }
    // static ElementLink< TrackParticleContainer > dummy;
    // return dummy;
  }

◆ 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

Muon CP quality accessors.

These methods get/set the muon's "quality" decoration, which is a bitfield:

Bits 0-2 hold the xAOD::Muon::Quality enum (Tight -> VeryLoose).
Higher bits may store auxiliary flags (e.g. ID hit-cuts). This decoration is currently populated by MuonSelectionTool (see MCP documentation). get/set the Quality enum in bits 0-2, preserving higher-bit flags

Definition at line 220 of file Muon_v1.cxx.

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

◆ rapidity()

double xAOD::Muon_v1::rapidity ( ) const

virtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 67 of file Muon_v1.cxx.

                                 {
    return genvecP4().Rapidity();
  }

◆ releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )

inherited

Release and free any private store associated with this object.

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

Definition at line 210 of file AuxElement.cxx.

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

◆ releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )

privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 441 of file AuxElement.cxx.

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

◆ 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

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

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

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

◆ setIndexPrivate()

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

privateinherited

Set the index/container for this element.

Parameters

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

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

Definition at line 505 of file AuxElement.cxx.

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

◆ setIsolation()

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

Set method for Isolation values.

Definition at line 272 of file Muon_v1.cxx.

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

◆ 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 299 of file Muon_v1.cxx.

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

◆ setIsolationCorrectionBitset()

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

Set method for Isolation corection Bitset.

Definition at line 343 of file Muon_v1.cxx.

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

◆ 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 322 of file Muon_v1.cxx.

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

◆ 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

store The 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 58 of file Muon_v1.cxx.

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

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

Definition at line 241 of file Muon_v1.cxx.

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

◆ setQuality()

void xAOD::Muon_v1::setQuality ( Quality )

Definition at line 226 of file Muon_v1.cxx.

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

◆ setStore() [1/3]

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

inherited

Set the store associated with this object.

Parameters

store The new store.

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

Parameters

store Link to the new store.

Definition at line 269 of file AuxElement.cxx.

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

◆ setStore() [2/3]

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

inherited

Set the store associated with this object.

Parameters

store The new store.

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

Definition at line 241 of file AuxElement.cxx.

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

◆ setStore() [3/3]

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

inherited

Set the store associated with this object.

Parameters

store The new store.

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

Definition at line 257 of file AuxElement.cxx.

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

◆ setStore1()

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

privateinherited

Set the store associated with this object.

Parameters

store The new store.

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

Parameters

store The new store.

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

Definition at line 461 of file AuxElement.cxx.

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

◆ setSummaryValue() [1/2]

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

Set method for MuonSummaryType.

Definition at line 161 of file Muon_v1.cxx.

                                                                                {
    const auto& acc = muonTrackSummaryAccessorV1( information );
    // Set the value:
    acc(*this) =  value;
  }

◆ 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 119 of file Muon_v1.cxx.

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

◆ setTrackParticleLink()

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

Set method for TrackParticle links.

Definition at line 501 of file Muon_v1.cxx.

                                                                                                             {
    switch ( type ) {
      case InnerDetectorTrackParticle :
        static const Accessor< ElementLink< TrackParticleContainer > > acc1( "inDetTrackParticleLink" );
        acc1(*this)=link;
        break;
      case MuonSpectrometerTrackParticle :
        static const Accessor< ElementLink< TrackParticleContainer > > acc2( "muonSpectrometerTrackParticleLink" );
        acc2(*this)=link;
        break;
      case CombinedTrackParticle :
        static const Accessor< ElementLink< TrackParticleContainer > > acc3( "combinedTrackParticleLink" );
        acc3(*this)=link;          
        break;
      case ExtrapolatedMuonSpectrometerTrackParticle :
        static const Accessor< ElementLink< TrackParticleContainer > > acc4( "extrapolatedMuonSpectrometerTrackParticleLink" );
        acc4(*this)=link;
        break;
      case MSOnlyExtrapolatedMuonSpectrometerTrackParticle :
        static const Accessor< ElementLink< TrackParticleContainer > > acc5( "msOnlyExtrapolatedMuonSpectrometerTrackParticleLink" );
    acc5(*this)=link;
    break;
      case Primary :
      default:
        throw std::runtime_error("Unknown or Primary TrackParticleType - not sure which track particle to set!");
    }
  }

◆ summaryValue() [1/3]

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

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

Definition at line 127 of file Muon_v1.cxx.

                                                                               {
    const ElementLink< TrackParticleContainer >& el= primaryTrackParticleLink();
    if (!el.isValid()) return false;
    return (*el)->summaryValue(value,information);
  }  

◆ summaryValue() [2/3]

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

Accessor for MuonSummaryType.

Definition at line 143 of file Muon_v1.cxx.

                                                                                     {
    const auto& acc = muonTrackSummaryAccessorV1( information );
    if( !acc.isAvailable( *this ) ) {
      value = 0;
      return false;
    }
    // Retrieve the value:
    value = acc( *this );
    return true;
  }

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

uint8_t numberOfInnermostPixelLayerHits=0;
if( myParticle.summaryValue<uint8_t>(numberOfInnermostPixelLayerHits,numberOfInnermostPixelLayerHits) ){
  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]	information	The information being requested. This is not guaranteed to be stored in all Muons (or primary TrackParticle).
[out]	value	Only 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 105 of file Muon_v1.cxx.

                                                                                 {
    const auto* acc = trackSummaryAccessorV1<uint8_t>( information );
    if (acc->isAvailable(*this))  {
        value = (*acc)( *this );
        return true;
    }
    // Okay - fallback: try to get from TrackParticle.
    const xAOD::TrackParticle* primTrk = primaryTrackParticle();
    if (primTrk) {
        return primTrk->summaryValue(value, information);
    } 
    return false;
  }  

◆ 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 482 of file Muon_v1.cxx.

                                                                                     {
    // TODO - perhaps we can get rid of this try/catch clause?
    try {
      // Get the ElementLink pointing to the requested track particle:
      const ElementLink< TrackParticleContainer >& el =
        trackParticleLink( type );
      
      // If it's invalid, return a null pointer:
      if( ! el.isValid() ) {
        return nullptr;
      }
      
      // If it's valid, let's de-reference it:
      return *el;
    } catch ( SG::ExcBadAuxVar& ) {
      return nullptr;
    }
  }

◆ 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 455 of file Muon_v1.cxx.

                                                                                                             {
    switch ( type ) {
      case Primary :
        return primaryTrackParticleLink();
        break;
      case CombinedTrackParticle :
        return combinedTrackParticleLink();
        break;
      case InnerDetectorTrackParticle :
        return inDetTrackParticleLink();
        break;
      case MuonSpectrometerTrackParticle :
        return muonSpectrometerTrackParticleLink();
        break;
      case ExtrapolatedMuonSpectrometerTrackParticle :
        return extrapolatedMuonSpectrometerTrackParticleLink();
        break;
      case MSOnlyExtrapolatedMuonSpectrometerTrackParticle :
    return msOnlyExtrapolatedMuonSpectrometerTrackParticleLink();
    break;
      default:
        throw std::runtime_error("Unknown TrackParticleType - not sure which track particle to return!");
    }
    // static ElementLink< TrackParticleContainer > dummy;
    // return dummy;
  }

◆ type()

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

virtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 82 of file Muon_v1.cxx.

                                     {
    return Type::Muon;
  }  

◆ 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 154 of file Muon_v1.cxx.

                                                                             {
    uint8_t sumVal{0};
    summaryValue(sumVal, information);
    return sumVal;
  }

◆ 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 138 of file Muon_v1.cxx.

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

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

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

Definition at line 280 of file AuxElement.cxx.

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

◆ usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

inherited

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

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

Definition at line 290 of file AuxElement.cxx.

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

Member Data Documentation

◆ m_container

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

privateinherited

The container of which this object is an element.

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

Definition at line 335 of file AuxElement.h.

◆ m_index

size_t SG::IAuxElement::m_index

privateinherited

The index of this element within its container.

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

Definition at line 128 of file IAuxElement.h.

◆ m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState

privateinherited

Definition at line 137 of file IAuxElement.h.

◆ supportsThinning

bool SG::AuxElement::supportsThinning = true

staticconstexprinherited

Mark that this type supports thinning operations.

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

Definition at line 959 of file AuxElement.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

IParticle functions

Charge

Author

Summary information

Isolation information.

Links

Functions for getting and setting user properties

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ Decorator

◆ FourMom_t

◆ GenVecFourMom_t

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ Muon_v1() [1/2]

◆ Muon_v1() [2/2]

◆ ~Muon_v1()

Member Function Documentation

◆ addAllAuthor()

◆ allAuthors()

◆ assign()

◆ author()

◆ auxdata() [1/4]

◆ auxdata() [2/4]

◆ auxdata() [3/4]

◆ auxdata() [4/4]

◆ auxdataConst() [1/2]

◆ auxdataConst() [2/2]

◆ auxdecor() [1/2]

◆ auxdecor() [2/2]

◆ charge()

◆ clearAux()

◆ clearAuxHelper()

◆ clearCache()

◆ clearDecorations()

◆ cluster()

◆ clusterLink()

◆ combinedTrackParticleLink()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ copyAuxHelper()

◆ e()

◆ energyLossType()

◆ eta()

◆ extrapolatedMuonSpectrometerTrackParticleLink()

◆ floatParameter()

◆ floatSummaryValue()

◆ genvecP4()

◆ getAuxIDs()

◆ getConstStore()

◆ getDecorIDs()

◆ getStore()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ havePrivateData()

◆ inDetTrackParticleLink()

◆ index()

◆ intParameter()

◆ isAuthor()

◆ isAvailable()

◆ isAvailableWritable() [1/2]

◆ isAvailableWritable() [2/2]

◆ isAvailableWritableAsDecoration()

◆ isolation() [1/2]

◆ isolation() [2/2]