MuonLRTMergingAlg.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/

//   MuonLRTMergingAlg
//   author Sagar Addepalli: sagara17@SPAMNOT_CERN.CH

// Muon merger algorirthm is a wrapper algorithm around MuonMerger
// to be used downstream for combining LRTmuons and standard muons
#include "MuonAnalysisAlgorithms/MuonLRTMergingAlg.h"
#include "xAODMuon/MuonAuxContainer.h"
#include <AthContainers/ConstDataVector.h>
#include <AsgTools/AsgToolConfig.h>
#include <AsgDataHandles/ReadHandle.h>
#include <AsgDataHandles/WriteHandle.h>
#include <AsgDataHandles/WriteDecorHandle.h>
#include "xAODBase/IParticleHelpers.h"
 
namespace CP{
    MuonLRTMergingAlg::MuonLRTMergingAlg( const std::string& name, ISvcLocator* svcLoc )
    : EL::AnaReentrantAlgorithm( name, svcLoc ){
        //nothing to do here
    }
 
    StatusCode MuonLRTMergingAlg::initialize() {
 
        // Greet the user:
        ATH_MSG_DEBUG( "Initialising" );

        ATH_CHECK( m_promptMuonLocation.initialize() );
        ATH_CHECK( m_lrtMuonLocation.initialize() );
        ATH_CHECK( m_outMuonLocation.initialize() );
        m_outMuonViewLocation = m_outMuonLocation.key();
        ATH_CHECK( m_outMuonViewLocation.initialize(m_createViewCollection.value()) );
        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;
    }
 
    StatusCode MuonLRTMergingAlg::execute(const EventContext &ctx) const {
 
        // Setup containers for output, to avoid const conversions setup two different kind of containers
        std::unique_ptr<ConstDataVector<xAOD::MuonContainer>> outputViewCol;
        std::unique_ptr<xAOD::MuonContainer> outputCol;
        std::unique_ptr<xAOD::MuonAuxContainer> outputAuxCol;
        if(m_createViewCollection) {
            outputViewCol = std::make_unique<ConstDataVector<xAOD::MuonContainer>>(SG::VIEW_ELEMENTS);
        } else {
            outputCol = std::make_unique<xAOD::MuonContainer>();
            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
        if (m_createViewCollection) {
          SG::WriteHandle<ConstDataVector<xAOD::MuonContainer>> h_write(m_outMuonViewLocation, ctx);
          ATH_CHECK(h_write.record(std::move(outputViewCol)));
        }
        else {
          SG::WriteHandle<xAOD::MuonContainer> h_write(m_outMuonLocation, ctx);
          ATH_CHECK(h_write.record(std::move(outputCol), std::move(outputAuxCol)));
        }
 
        return StatusCode::SUCCESS;
 
    }

  // Merge muon collections and remove duplicates
 
    StatusCode MuonLRTMergingAlg::mergeMuon(const xAOD::MuonContainer & muonCol,
                                            const std::vector<bool> & writeMuon,
                                            ConstDataVector<xAOD::MuonContainer>* outputCol) const{
        // loop over muons, accept them and add them into association tool
        for(const xAOD::Muon* muon : muonCol){
            // add muon into output
            if (writeMuon.at(muon->index())){
              outputCol->push_back(muon);
            }
        }
        return StatusCode::SUCCESS;
    }
 
    StatusCode MuonLRTMergingAlg::mergeMuon(const xAOD::MuonContainer & muonCol,
                                            const std::vector<bool> & writeMuon,
                                            xAOD::MuonContainer* outputCol) const{
        // loop over muons, accept them and add them into association tool
        static const SG::Decorator<ElementLink<xAOD::MuonContainer>> originalMuonLink("originalMuonLink");
        for(const xAOD::Muon* muon : muonCol){
            // add muon into output
            if (writeMuon.at(muon->index())){
              auto newMuon = std::make_unique<xAOD::Muon>(*muon);
              ElementLink<xAOD::MuonContainer> myLink;
              myLink.toIndexedElement(muonCol, muon->index());
              originalMuonLink(*newMuon) = myLink;
              setOriginalObjectLink(*muon, *newMuon);
              static const SG::Accessor <char> isLRT("isLRT");
              isLRT(*newMuon) = isLRT(*muon);
              outputCol->push_back(std::move(newMuon));
            }
        }
        return StatusCode::SUCCESS;
    }
}