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

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

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.

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.

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:

author()

Author xAOD::Muon_v1::author

(

)

const

auxdata() [1/2]

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() [2/2]

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 );
      }

charge()

float xAOD::Muon_v1::charge

(

)

const

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.

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)

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());
  }

inDetTrackParticleLink()

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

(

)

const

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

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

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);
      }

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

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();
  }

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:

1. CombinedTrackParticle
2. InnerDetectorTrackParticle
3. ExtrapolatedMuonSpectrometerTrackParticle
4. MSOnlyExtrapolatedMuonSpectrometerTrackParticle
5. 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();
  }

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.

setEnergyLossType()

void xAOD::Muon_v1::setEnergyLossType

(

EnergyLossType

type

)

Set method for the type.

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?

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

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;

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

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 );   
  }

---

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

• Muon_v1.h
• Muon_v1.cxx