Class-algorithm for muon particle collection merging. More...

#include <MuonLRTOverlapRemovalTool.h>

Inheritance diagram for CP::MuonLRTOverlapRemovalTool:

Collaboration diagram for CP::MuonLRTOverlapRemovalTool:

Public Types
enum	overlapStrategy { defaultStrategy =0, passThroughAndDecorate =1 }
	Allow to specify a number of MCP-supported overlap removal strategies. More...

Public Member Functions
	MuonLRTOverlapRemovalTool (const std::string &name)
	Standard Algotithm methods: More...

virtual	~MuonLRTOverlapRemovalTool ()=default

virtual StatusCode	initialize ()
	Dummy implementation of the initialisation function. More...

virtual std::pair< bool, bool >	resolveOverlap (const xAOD::Muon promptMuon, const xAOD::Muon lrtMuon) const
	resolve the overlap between a pair of muons, one from the prompt and one from the LRT pass. More...

virtual std::tuple< int, int >	checkOverlapForDecor (const xAOD::Muon promptMuon, const xAOD::Muon lrtMuon) const
	checks for overlap between a pair of muons, one from the prompt and one from the LRT pass. More...

virtual void	checkOverlap (const xAOD::MuonContainer &promptCollection, const xAOD::MuonContainer &lrtCollection, std::vector< bool > &promptMuonsSelectedToKeep, std::vector< bool > &lrtMuonsSelectedToKeep) const
	check the overlap between the prompt and LRT muon collections. More...

virtual bool	hasOverlap (const xAOD::Muon promptMuon, const xAOD::Muon lrtMuon) const
	checks the overlap between a pair of muons, one from the prompt and one from the LRT pass. More...

virtual float	getIDMEdEta (const xAOD::Muon *muon) const
	checks the eta difference between the ID and ME track particles which is used for the final overlap resolution. More...

virtual void	print () const =0
	Print the state of the tool. More...

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
Gaudi::Property< int >	m_strategy {this, "overlapStrategy", CP::IMuonLRTOverlapRemovalTool::defaultStrategy, "Overlap removal strategy to use (0 = default, 1 = write all muons and decorate with overlap type)"}
	This allows to configure the OR strategy in the future, if more than one is supported by MCP. More...

Gaudi::Property< bool >	m_useRun3WP {this, "UseRun3WP", false, "Switch to toggle the run 2 & run 3 geometry for the muon ID working points used in the prompt-LRT overlap resolution. Set to true for run 3 and false for run 2."}
	This allows to configure the geometry used for the muon selection tool (run 2 or run 3). More...

ToolHandle< CP::IMuonSelectionTool >	m_muonSelectionTool {this, "MuonSelectionTool", "", "tool to determine the working point of the muons"}
	This is the muon selection tool. No particular configuration required, the loosest WP is used as a tie breaker in overlaps. More...

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Class-algorithm for muon particle collection merging.

Definition at line 24 of file MuonLRTOverlapRemovalTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ overlapStrategy

enum CP::IMuonLRTOverlapRemovalTool::overlapStrategy

inherited

Allow to specify a number of MCP-supported overlap removal strategies.

Enumerator
defaultStrategy
passThroughAndDecorate

Definition at line 37 of file IMuonLRTOverlapRemovalTool.h.

                      {
             defaultStrategy=0, //default strategy which does a basic overlap removal.
             passThroughAndDecorate=1 //writes all the muons in the combined container irrespective of overlap, 
                                 //and adds a decoration `MuonLRTOverlapDecision` which contains overlap information for all muons.
         } overlapStrategy;

Constructor & Destructor Documentation

◆ MuonLRTOverlapRemovalTool()

CP::MuonLRTOverlapRemovalTool::MuonLRTOverlapRemovalTool ( const std::string & name )

Standard Algotithm methods:

Definition at line 15 of file MuonLRTOverlapRemovalTool.cxx.

                                                                             :
     asg::AsgTool(name)
   {
     // nothing to do here
   }

◆ ~MuonLRTOverlapRemovalTool()

virtual CP::MuonLRTOverlapRemovalTool::~MuonLRTOverlapRemovalTool ( )

virtualdefault

Member Function Documentation

◆ checkOverlap()

void CP::MuonLRTOverlapRemovalTool::checkOverlap	(	const xAOD::MuonContainer &	promptCollection,
		const xAOD::MuonContainer &	lrtCollection,
		std::vector< bool > &	promptMuonsSelectedToKeep,
		std::vector< bool > &	lrtMuonsSelectedToKeep
	)		const

virtual

check the overlap between the prompt and LRT muon collections.

Will populate the two vectors passed by ref with a decision for each muon in each collection. "true" entries are to be kept, "false" to be discarded. If the strategy passThroughAndDecorate is selected, muons are decorated with a variable MuonLRTOverlapDecision which is 0 for muons which don't overlap, 1 if they overlap and are discareded, and 2 if they overlap and are retained. In this strategy, the two vectors will be returned with all elements "true" i.e. no muons should be discarded.

pre-fill vectors with the default 'accept' decision

pre-fill vectors with the default '0 = no overlap decision'

Baseline strategy

passThroughAndDecorate strategy

Implements CP::IMuonLRTOverlapRemovalTool.

Definition at line 42 of file MuonLRTOverlapRemovalTool.cxx.

   {
  
     promptMuonsSelectedToKeep.resize(promptMuonCol.size(), true); 
     lrtMuonsSelectedToKeep.resize(LRTMuonCol.size(), true); 
     std::fill(promptMuonsSelectedToKeep.begin(), promptMuonsSelectedToKeep.end(), true); 
     std::fill(lrtMuonsSelectedToKeep.begin(), lrtMuonsSelectedToKeep.end(), true); 
  
     std::vector<int> promptMuonsOverlapDecision, lrtMuonsOverlapDecision;
     promptMuonsOverlapDecision.resize(promptMuonCol.size(), 0);
     lrtMuonsOverlapDecision.resize(LRTMuonCol.size(), 0);
  
     // loop over prompt muons
     u_int promptMuonIndex = 0;
     for (const xAOD::Muon* promptMuon : promptMuonCol){
  
       // loop over LRT muons
       u_int lrtMuonIndex = 0;
       for( const xAOD::Muon* lrtMuon : LRTMuonCol){
         // check for overlap
         std::pair<bool,bool> writeDecision = {true,true};
         switch(m_strategy){
           case CP::IMuonLRTOverlapRemovalTool::defaultStrategy:
             if(hasOverlap(promptMuon,lrtMuon)) { writeDecision = resolveOverlap(promptMuon, lrtMuon); }
             break;
           case CP::IMuonLRTOverlapRemovalTool::passThroughAndDecorate:
             if ( (promptMuonsOverlapDecision.at(promptMuonIndex) == 0) && (lrtMuonsOverlapDecision.at(lrtMuonIndex) == 0) ) {
               // overwrite the decision only if no overlaps have been found yet. Do not check again if either of the leptons have found overlaps previously.
               std::tie(promptMuonsOverlapDecision.at(promptMuonIndex), lrtMuonsOverlapDecision.at(lrtMuonIndex)) = checkOverlapForDecor(promptMuon, lrtMuon);
             }
             break;
           default:
             ATH_MSG_FATAL("Unsupported overlap removal strategy type. Choose from 0 (`defaultStrategy`) or 1 (`passThroughAndDecorate`)");
             break;
         }
         // write decision into vectors
         if(!writeDecision.first){
           promptMuonsSelectedToKeep.at(promptMuon->index()) = false;
         }
         if(!writeDecision.second){
           lrtMuonsSelectedToKeep.at(lrtMuon->index()) = false;
         }
         ++lrtMuonIndex;
       } // LRT muon loop ends
       ++promptMuonIndex;
     } // prompt muon loop ends
  
     if (m_strategy == CP::IMuonLRTOverlapRemovalTool::passThroughAndDecorate) {
       // if the passThroughAndDecorate strategy is selected, run a final loop over the collections to decorate the muons with the overlap resolution result.
       static const SG::AuxElement::Decorator<int> MuonLRTOverlapDecision("MuonLRTOverlapDecision"); //0 if no overlap, 1 if overlaps and rejected, 2 if overlaps and retained
       //final loop over prompt muons
       u_int promptMuonIndex = 0;
       for (const xAOD::Muon* promptMuon : promptMuonCol){
         MuonLRTOverlapDecision(*promptMuon) = promptMuonsOverlapDecision.at(promptMuonIndex);
         ++promptMuonIndex;
       }
       //final loop over LRT muons
       u_int lrtMuonIndex = 0;
       for (const xAOD::Muon* lrtMuon : LRTMuonCol){
         MuonLRTOverlapDecision(*lrtMuon) = lrtMuonsOverlapDecision.at(lrtMuonIndex);
         ++lrtMuonIndex;
       }
     }
  
   }

◆ checkOverlapForDecor()

std::tuple< int, int > CP::MuonLRTOverlapRemovalTool::checkOverlapForDecor	(	const xAOD::Muon *	promptMuon,
		const xAOD::Muon *	lrtMuon
	)		const

virtual

checks for overlap between a pair of muons, one from the prompt and one from the LRT pass.

using the same set of rules as resolveOverlap, it returns a tuple for the prompt and LRT muon resp. with value 0 for muons which don't overlap, 1 if they overlap and are discareded, and 2 if they overlap and are retained.

Implements CP::IMuonLRTOverlapRemovalTool.

Definition at line 176 of file MuonLRTOverlapRemovalTool.cxx.

                                                                                      {
     //return values: 0 if no overlap, 1 if overlaps and rejected, 2 if overlaps and retained.
  
     if (!hasOverlap(promptMuon, lrtMuon)){
       return std::make_tuple(0, 0);
     }
     else {
       std::pair<bool, bool> overlapDecision = resolveOverlap(promptMuon, lrtMuon);
       if (overlapDecision.first && !overlapDecision.second) {
         return std::make_tuple(2, 1);
       }
       else {
         return std::make_tuple(1, 2);
       }
     }
   }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getIDMEdEta()

float CP::MuonLRTOverlapRemovalTool::getIDMEdEta ( const xAOD::Muon * muon ) const

virtual

checks the eta difference between the ID and ME track particles which is used for the final overlap resolution.

Definition at line 194 of file MuonLRTOverlapRemovalTool.cxx.

                                                                         {
     const xAOD::TrackParticle* ID_track = muon->trackParticle(xAOD::Muon::InnerDetectorTrackParticle);
     const xAOD::TrackParticle* ME_track = muon->trackParticle(xAOD::Muon::ExtrapolatedMuonSpectrometerTrackParticle);
     if (!ID_track || !ME_track) return FLT_MAX;
     return ( std::abs( ID_track->eta() - ME_track->eta() ) );
   }

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                     {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getKey( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       return ( proxy == nullptr ? 0 : proxy->sgkey() );
 #endif // XAOD_STANDALONE
    }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                             {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getName( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       static const std::string dummy = "";
       return ( proxy == nullptr ? dummy : proxy->name() );
 #endif // XAOD_STANDALONE
    }

◆ getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ hasOverlap()

bool CP::MuonLRTOverlapRemovalTool::hasOverlap	(	const xAOD::Muon *	promptMuon,
		const xAOD::Muon *	lrtMuon
	)		const

virtual

checks the overlap between a pair of muons, one from the prompt and one from the LRT pass.

returns true if they do overlap and false if they don't.

Implements CP::IMuonLRTOverlapRemovalTool.

Definition at line 115 of file MuonLRTOverlapRemovalTool.cxx.

                                                                            {
  
     // we compare based on MS track information to detect re-use of the same track  
     const xAOD::TrackParticle* lrtMsTrack = lrtMuon->trackParticle( xAOD::Muon::MuonSpectrometerTrackParticle );
     const xAOD::TrackParticle* promptMsTrack = promptMuon->trackParticle( xAOD::Muon::MuonSpectrometerTrackParticle );
  
     // baseline case: if no two MS tracks or two different MS tracks, no overlap possible 
     if ( (!promptMsTrack && !lrtMsTrack) || (promptMsTrack != lrtMsTrack)){
       return false;
     }
  
     else {
       ATH_MSG_DEBUG("Found an overlap, solving");
       ATH_MSG_DEBUG("  Prompt muon has author "<< promptMuon->author()<<", type "<<promptMuon->muonType()<<", pT "<<promptMuon->pt()<<", eta "<<promptMuon->eta()<<", phi "<<promptMuon->phi());
       ATH_MSG_DEBUG("  LRT muon has author "<< lrtMuon->author()<<", type "<<lrtMuon->muonType()<<", pT "<<lrtMuon->pt()<<", eta "<<lrtMuon->eta()<<", phi "<<lrtMuon->phi());
       return true;
     }
   }

◆ initialize()

StatusCode CP::MuonLRTOverlapRemovalTool::initialize ( )

virtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 25 of file MuonLRTOverlapRemovalTool.cxx.

   {
     if(m_muonSelectionTool.empty()){
       asg::AsgToolConfig config("CP::MuonSelectionTool/MuonSelectionTool");
       ATH_CHECK(config.setProperty("TurnOffMomCorr",true));
       ATH_CHECK(config.setProperty("IsRun3Geo",m_useRun3WP.value()));
       ATH_CHECK(config.makePrivateTool(m_muonSelectionTool));
     }
  
     ATH_MSG_DEBUG("retrieving Muon selection tool");
     ATH_CHECK( m_muonSelectionTool.retrieve() );
     return StatusCode::SUCCESS;
   }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                   {
  
       return MSG::name( msg().level() );
    }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ print() [1/2]

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                              {
  
       ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
       return;
    }

◆ print() [2/2]

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

Implemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, asg::AsgTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ resolveOverlap()

std::pair< bool, bool > CP::MuonLRTOverlapRemovalTool::resolveOverlap	(	const xAOD::Muon *	promptMuon,
		const xAOD::Muon *	lrtMuon
	)		const

virtual

resolve the overlap between a pair of muons, one from the prompt and one from the LRT pass.

returns a pair of booleans, indicating whether the prompt and LRT muon, respectively, should be retained based on a minimal set of rules.

Implements CP::IMuonLRTOverlapRemovalTool.

Definition at line 135 of file MuonLRTOverlapRemovalTool.cxx.

                                                                                                 {
  
     // apply the loosest available ID to resolve most overlaps using existing MCP recommendations
     bool promptPassQuality = (m_muonSelectionTool->getQuality(*promptMuon) < xAOD::Muon::VeryLoose);
     bool lrtPassQuality = (m_muonSelectionTool->getQuality(*lrtMuon) < xAOD::Muon::VeryLoose);
  
     if (promptPassQuality && !lrtPassQuality) { 
       return {true,false}; 
     }
     else if (!promptPassQuality && lrtPassQuality) {
       return {false,true};
     }
  
     // still here? Next prefer combined muons over others 
     bool promptIsCombined = promptMuon->muonType() == xAOD::Muon::Combined;
     bool lrtIsCombined = lrtMuon->muonType() == xAOD::Muon::Combined;
  
     if (promptIsCombined && !lrtIsCombined) {
       return {true,false};
     }
     else if (!promptIsCombined && lrtIsCombined) {
       return {false,true};
     }
  
     // still here? Next choose the muon with a lower ID-ME delta eta value
     float promptIDMEdEta = getIDMEdEta(promptMuon);
     float lrtIDMEdEta    = getIDMEdEta(lrtMuon);
  
     if (promptIDMEdEta <= lrtIDMEdEta) {
       return {true,false};
     }
     else {
       return {false,true};
     }
  
     // fail-safe case: choose prompt over LRT.
     ATH_MSG_DEBUG("Resolution reached the fail-safe point. Why?");
     return {true,false};
   }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_muonSelectionTool

ToolHandle<CP::IMuonSelectionTool> CP::MuonLRTOverlapRemovalTool::m_muonSelectionTool {this, "MuonSelectionTool", "", "tool to determine the working point of the muons"}

private

This is the muon selection tool. No particular configuration required, the loosest WP is used as a tie breaker in overlaps.

Definition at line 74 of file MuonLRTOverlapRemovalTool.h.

◆ m_strategy

Gaudi::Property<int> CP::MuonLRTOverlapRemovalTool::m_strategy {this, "overlapStrategy", CP::IMuonLRTOverlapRemovalTool::defaultStrategy, "Overlap removal strategy to use (0 = default, 1 = write all muons and decorate with overlap type)"}

private

This allows to configure the OR strategy in the future, if more than one is supported by MCP.

Definition at line 70 of file MuonLRTOverlapRemovalTool.h.

◆ m_useRun3WP

Gaudi::Property<bool> CP::MuonLRTOverlapRemovalTool::m_useRun3WP {this, "UseRun3WP", false, "Switch to toggle the run 2 & run 3 geometry for the muon ID working points used in the prompt-LRT overlap resolution. Set to true for run 3 and false for run 2."}

private

This allows to configure the geometry used for the muon selection tool (run 2 or run 3).

Definition at line 72 of file MuonLRTOverlapRemovalTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ overlapStrategy

Constructor & Destructor Documentation

◆ MuonLRTOverlapRemovalTool()

◆ ~MuonLRTOverlapRemovalTool()

Member Function Documentation

◆ checkOverlap()

◆ checkOverlapForDecor()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getIDMEdEta()

◆ getKey()

◆ getName()

◆ getProperty()

◆ hasOverlap()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ renounce()

◆ renounceArray()

◆ resolveOverlap()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_muonSelectionTool

◆ m_strategy

◆ m_useRun3WP

◆ m_varHandleArraysDeclared

◆ m_vhka