this wraps the MCP LRT collection merger in a CP algorithm More...

#include <MuonLRTMergingAlg.h>

Inheritance diagram for CP::MuonLRTMergingAlg:

Collaboration diagram for CP::MuonLRTMergingAlg:

Public Member Functions
	MuonLRTMergingAlg (const std::string &name, ISvcLocator *pSvcLocator)
	the standard constructor More...

StatusCode	initialize () override

StatusCode	execute (const EventContext &ctx) const override

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...

virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...

virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

virtual bool	filterPassed (const EventContext &ctx) const

virtual void	setFilterPassed (bool state, const EventContext &ctx) const

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	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
virtual ::StatusCode	finalize ()
	finalize this algorithm More...

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
StatusCode	mergeMuon (const xAOD::MuonContainer &muonCol, const std::vector< bool > &muonIsGood, ConstDataVector< xAOD::MuonContainer > *outputCol) const
	Private methods: More...

StatusCode	mergeMuon (const xAOD::MuonContainer &muonCol, const std::vector< bool > &muonIsGood, xAOD::MuonContainer *outputCol) const
	A routine that merges the muon collections. More...

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
SG::ReadHandleKey< xAOD::MuonContainer >	m_promptMuonLocation {this, "PromptMuonLocation","Muons", "Prompt muons to merge"}
	Private data: More...

SG::ReadHandleKey< xAOD::MuonContainer >	m_lrtMuonLocation {this, "LRTMuonLocation","MuonsLRT", "LRT muons to merge"}
	Vector of muon collections to be merged. More...

SG::WriteHandleKey< xAOD::MuonContainer >	m_outMuonLocation {this, "OutputMuonLocation", "StdWithLRTMuons", "name of the muon container to write"}
	Vector of muon collections to be merged. More...

Gaudi::Property< bool >	m_createViewCollection {this, "CreateViewCollection", true}
	Combined muon collection. More...

ToolHandle< CP::IMuonLRTOverlapRemovalTool >	m_overlapRemovalTool {this, "overlapRemovalTool", "", "tool to determine overlaps between regular and LRT muons"}

Gaudi::Property< int >	m_ORstrategy {this, "overlapStrategy", CP::IMuonLRTOverlapRemovalTool::defaultStrategy, "Overlap removal strategy to use (0 = default, 1 = write all muons and decorate with overlap type)"}
	allows to pass an overlap removal strategy to the underlying removal tool, without manually configuring said tool. 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."}

SG::WriteDecorHandleKey< xAOD::MuonContainer >	m_promptIsLRTKey { this, "PromptIsLRTKey", m_promptMuonLocation, "isLRT" }

SG::WriteDecorHandleKey< xAOD::MuonContainer >	m_lrtIsLRTKey { this, "LRTIsLRTKey", m_lrtMuonLocation, "isLRT" }

DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. 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

this wraps the MCP LRT collection merger in a CP algorithm

Definition at line 29 of file MuonLRTMergingAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ MuonLRTMergingAlg()

CP::MuonLRTMergingAlg::MuonLRTMergingAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

the standard constructor

Definition at line 22 of file MuonLRTMergingAlg.cxx.

     : EL::AnaReentrantAlgorithm( name, svcLoc ){
         //nothing to do here
     }

Member Function Documentation

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

 {
   return 0;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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; }

◆ execute()

StatusCode CP::MuonLRTMergingAlg::execute ( const EventContext & ctx ) const

override

retrieve muons from StoreGate

Definition at line 53 of file MuonLRTMergingAlg.cxx.

                                                                        {
  
         // Setup containers for output, to avoid const conversions setup two different kind of containers
         auto outputViewCol = std::make_unique<ConstDataVector<xAOD::MuonContainer>>(SG::VIEW_ELEMENTS);
         auto outputCol = std::make_unique<xAOD::MuonContainer>();
  
         std::unique_ptr<xAOD::MuonAuxContainer> outputAuxCol;
         if(!m_createViewCollection) {
             outputAuxCol = std::make_unique<xAOD::MuonAuxContainer>();
             outputCol->setStore(outputAuxCol.get());
         }
  
         SG::ReadHandle<xAOD::MuonContainer> promptCol (m_promptMuonLocation, ctx);
         SG::ReadHandle<xAOD::MuonContainer> lrtCol (m_lrtMuonLocation, ctx);
         if (!promptCol.isValid()) {
             ATH_MSG_FATAL("Unable to retrieve xAOD::MuonContainer, \"" << m_promptMuonLocation << "\", cannot run the LRT muon merger!");
             return StatusCode::FAILURE;
         }
         if (!lrtCol.isValid()) {
             ATH_MSG_FATAL("Unable to retrieve xAOD::MuonContainer, \"" << m_lrtMuonLocation << "\", cannot run the LRT muon merger!");
             return StatusCode::FAILURE;
         }
  
         // Check and resolve overlaps
         std::vector<bool> writePromptMuon;
         std::vector<bool> writeLRTMuon;
         m_overlapRemovalTool->checkOverlap(*promptCol, *lrtCol, writePromptMuon, writeLRTMuon);
  
         // Decorate the muons with their locations.
         // 0 if prompt, 1 if LRT
         SG::WriteDecorHandle<xAOD::MuonContainer, char> promptIsLRT(m_promptIsLRTKey, ctx);
         SG::WriteDecorHandle<xAOD::MuonContainer, char> lrtIsLRT(m_lrtIsLRTKey, ctx);
         for (const xAOD::Muon* mu : *promptCol) promptIsLRT(*mu) = 0;
         for (const xAOD::Muon* mu : *lrtCol) lrtIsLRT(*mu) = 1;
  
         // and merge
         if (m_createViewCollection) {
           outputViewCol->reserve(promptCol->size() + lrtCol->size());
           ATH_CHECK(mergeMuon(*promptCol, writePromptMuon, outputViewCol.get()));
           ATH_CHECK(mergeMuon(*lrtCol, writeLRTMuon, outputViewCol.get()));
         } else {
           outputCol->reserve(promptCol->size() + lrtCol->size());
           ATH_CHECK(mergeMuon(*promptCol, writePromptMuon, outputCol.get()));
           ATH_CHECK(mergeMuon(*lrtCol, writeLRTMuon, outputCol.get()));
         }
  
         // write
         SG::WriteHandle<xAOD::MuonContainer> h_write(m_outMuonLocation, ctx);
         if (m_createViewCollection) {
           ATH_CHECK(evtStore()->record(outputViewCol.release(), m_outMuonLocation.key()));
         }
         else {
           ATH_CHECK(h_write.record(std::move(outputCol), std::move(outputAuxCol)));
         }
  
         return StatusCode::SUCCESS;
  
     }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

 {
   // If we didn't find any symlinks to add, just return the collection
   // from the base class.  Otherwise, return the extended collection.
   if (!m_extendedExtraObjects.empty()) {
     return m_extendedExtraObjects;
   }
   return BaseAlg::extraOutputDeps();
 }

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                            {
     return execState( ctx ).filterPassed();
   }

◆ finalize()

StatusCode EL::AnaReentrantAlgorithm::finalize ( )

protectedinherited

finalize this algorithm

This gets called after event processing has finished. The last event may no longer be in memory, and the code should not try to access it.

Definition at line 102 of file AnaReentrantAlgorithm.cxx.

   {
     return StatusCode::SUCCESS;
   }

◆ initialize()

StatusCode CP::MuonLRTMergingAlg::initialize ( )

override

initialize the handles

if the tool is not user-set, configure the automatic instance via our overlap flag

Definition at line 27 of file MuonLRTMergingAlg.cxx.

                                              {
  
         // Greet the user:
         ATH_MSG_INFO( "Initialising" );
  
         ATH_CHECK( m_promptMuonLocation.initialize() );
         ATH_CHECK( m_lrtMuonLocation.initialize() );
         ATH_CHECK( m_outMuonLocation.initialize() );
         ATH_CHECK( m_promptIsLRTKey.initialize() );
         ATH_CHECK( m_lrtIsLRTKey.initialize() );
  
         if (m_overlapRemovalTool.empty()){
             asg::AsgToolConfig config("CP::MuonLRTOverlapRemovalTool/MuonLRTOverlapRemovalTool");
             ATH_CHECK(config.setProperty("overlapStrategy",m_ORstrategy.value()));
             ATH_CHECK(config.setProperty("UseRun3WP",m_useRun3WP.value()));
             ATH_CHECK(config.makePrivateTool(m_overlapRemovalTool));
         }
  
         // Retrieve the tools
         ATH_CHECK( m_overlapRemovalTool.retrieve() );
         // Return gracefully:
         return StatusCode::SUCCESS;
     }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

◆ isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

 {
   // Reentrant algorithms are clonable.
   return true;
 }

◆ mergeMuon() [1/2]

StatusCode CP::MuonLRTMergingAlg::mergeMuon	(	const xAOD::MuonContainer &	muonCol,
		const std::vector< bool > &	muonIsGood,
		ConstDataVector< xAOD::MuonContainer > *	outputCol
	)		const

private

Private methods:

A routine that merges the muon collections into a view container.

Definition at line 117 of file MuonLRTMergingAlg.cxx.

                                                                                                 {
         // loop over muons, accept them and add them into association tool
         if(muonCol.empty()) {return StatusCode::SUCCESS;}
  
         for(const xAOD::Muon* muon : muonCol){
             // add muon into output
             if (writeMuon.at(muon->index())){
               outputCol->push_back(muon);
             }
         }
         return StatusCode::SUCCESS;
     }

◆ mergeMuon() [2/2]

StatusCode CP::MuonLRTMergingAlg::mergeMuon	(	const xAOD::MuonContainer &	muonCol,
		const std::vector< bool > &	muonIsGood,
		xAOD::MuonContainer *	outputCol
	)		const

private

A routine that merges the muon collections.

Definition at line 132 of file MuonLRTMergingAlg.cxx.

                                                                                {
         // loop over muons, accept them and add them into association tool
         if(muonCol.empty()) {return StatusCode::SUCCESS;}
         static const SG::AuxElement::Decorator<ElementLink<xAOD::MuonContainer>> originalMuonLink("originalMuonLink");
         for(const xAOD::Muon* muon : muonCol){
             // add muon into output
             if (writeMuon.at(muon->index())){
               xAOD::Muon* newMuon = new xAOD::Muon(*muon);
               ElementLink<xAOD::MuonContainer> myLink;
               myLink.toIndexedElement(muonCol, muon->index());
               originalMuonLink(*newMuon) = myLink;
               setOriginalObjectLink(*muon, *newMuon);
               static const SG::AuxElement::Accessor <char> isLRT("isLRT");
               isLRT(*newMuon) = isLRT(*muon);
               outputCol->push_back(newMuon);
             }
         }
         return StatusCode::SUCCESS;
     }

◆ msg() [1/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::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< Gaudi::Algorithm > >::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.

◆ 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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx
	)		const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

                                                                             {
     execState( ctx ).setFilterPassed( state );
   }

◆ sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

 {
   return BaseAlg::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                                {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
  
   if (sc.isFailure()) {
     return sc;
   }
   
   ServiceHandle<ICondSvc> cs("CondSvc",name());
   for (auto h : outputHandles()) {
     if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
       // do this inside the loop so we don't create the CondSvc until needed
       if ( cs.retrieve().isFailure() ) {
         ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
         return StatusCode::SUCCESS;
       }      
       if (cs->regHandle(this,*h).isFailure()) {
         sc = StatusCode::FAILURE;
         ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                       << " with CondSvc");
       }
     }
   }
   return sc;  
 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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_createViewCollection

Gaudi::Property<bool> CP::MuonLRTMergingAlg::m_createViewCollection {this, "CreateViewCollection", true}

private

Combined muon collection.

flag to create a view collection rather than building deep-copies (true by default) option to create a view collection and not deep-copy muons

Definition at line 51 of file MuonLRTMergingAlg.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

◆ m_lrtIsLRTKey

SG::WriteDecorHandleKey<xAOD::MuonContainer> CP::MuonLRTMergingAlg::m_lrtIsLRTKey { this, "LRTIsLRTKey", m_lrtMuonLocation, "isLRT" }

private

Definition at line 76 of file MuonLRTMergingAlg.h.

◆ m_lrtMuonLocation

SG::ReadHandleKey<xAOD::MuonContainer> CP::MuonLRTMergingAlg::m_lrtMuonLocation {this, "LRTMuonLocation","MuonsLRT", "LRT muons to merge"}

private

Vector of muon collections to be merged.

Definition at line 47 of file MuonLRTMergingAlg.h.

◆ m_ORstrategy

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

private

allows to pass an overlap removal strategy to the underlying removal tool, without manually configuring said tool.

Advantageous in certain analysis frameworks.

Definition at line 56 of file MuonLRTMergingAlg.h.

◆ m_outMuonLocation

SG::WriteHandleKey<xAOD::MuonContainer> CP::MuonLRTMergingAlg::m_outMuonLocation {this, "OutputMuonLocation", "StdWithLRTMuons", "name of the muon container to write"}

private

Vector of muon collections to be merged.

Definition at line 48 of file MuonLRTMergingAlg.h.

◆ m_overlapRemovalTool

ToolHandle<CP::IMuonLRTOverlapRemovalTool> CP::MuonLRTMergingAlg::m_overlapRemovalTool {this, "overlapRemovalTool", "", "tool to determine overlaps between regular and LRT muons"}

private

Definition at line 52 of file MuonLRTMergingAlg.h.

◆ m_promptIsLRTKey

SG::WriteDecorHandleKey<xAOD::MuonContainer> CP::MuonLRTMergingAlg::m_promptIsLRTKey { this, "PromptIsLRTKey", m_promptMuonLocation, "isLRT" }

private

Definition at line 74 of file MuonLRTMergingAlg.h.

◆ m_promptMuonLocation

SG::ReadHandleKey<xAOD::MuonContainer> CP::MuonLRTMergingAlg::m_promptMuonLocation {this, "PromptMuonLocation","Muons", "Prompt muons to merge"}

private

Private data:

handles for interacting with the event storage

Definition at line 46 of file MuonLRTMergingAlg.h.

◆ m_useRun3WP

Gaudi::Property<bool> CP::MuonLRTMergingAlg::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

Definition at line 57 of file MuonLRTMergingAlg.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ MuonLRTMergingAlg()

Member Function Documentation

◆ cardinality()

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

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ mergeMuon() [1/2]

◆ mergeMuon() [2/2]

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_createViewCollection

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_lrtIsLRTKey

◆ m_lrtMuonLocation

◆ m_ORstrategy

◆ m_outMuonLocation

◆ m_overlapRemovalTool

◆ m_promptIsLRTKey

◆ m_promptMuonLocation

◆ m_useRun3WP

◆ m_varHandleArraysDeclared

◆ m_vhka