TrigMuonMatching.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#include "TrigMuonMatching/TrigMuonMatching.h"
 
#ifdef ROOTCORE
#include "xAODRootAccess/Init.h"
#include "xAODRootAccess/TEvent.h"
#include "xAODRootAccess/tools/ReturnCheck.h"
#endif // ROOTCORE
 
#include "xAODMuon/MuonContainer.h"
#include "xAODTrigger/MuonRoIContainer.h"
#include "xAODTrigMuon/L2StandAloneMuonContainer.h"
#include "xAODTrigMuon/L2CombinedMuonContainer.h"
#include "TruthUtils/ParticleConstants.h"
#include "CxxUtils/StringUtils.h"
 
#define MUONMASS ParticleConstants::muonMassInMeV
 
using CxxUtils::tokenize;
 
namespace Trig {
 
   TrigMuonMatching::TrigMuonMatching( const std::string& name )
     : asg::AsgMetadataTool( name ),
       m_trigDecTool("Trig::TrigDecisionTool/TrigDecisionTool")
   {
     declareProperty( "TriggerTool", m_trigDecTool);
   }
 
  TrigMuonMatching::~TrigMuonMatching(){
  }
 
  StatusCode TrigMuonMatching::initialize() {
    // Greet the user:
    ATH_MSG_INFO( "Initialising... " );
    
    ATH_CHECK(m_trigDecTool.retrieve());
 
    return StatusCode::SUCCESS;
  }
 
  Bool_t TrigMuonMatching::match(const xAOD::Muon* mu,
                 std::string_view chain,
                 const double mindelR) const
  {
    return match(mu->eta(),mu->phi(),chain,mindelR);
  }
  
  Bool_t TrigMuonMatching::matchL1(const xAOD::Muon* mu,
                   std::string_view l1item,
                   const double DelR) const
  {
    return matchL1(mu->eta(),mu->phi(),l1item,DelR);
  }
 
  Double_t TrigMuonMatching::minDelR(const xAOD::Muon* mu,
                     std::string_view chain,
                     const double mindelR) const
  {
    Double_t delmin = mindelR;
    EFmuon efmuon,dummy;
    return matchedTrackDetail(efmuon, dummy, mu->eta(), mu->phi(), delmin, chain);
  }
 
  Double_t TrigMuonMatching::minDelRL1(const xAOD::Muon* mu,
                       std::string_view l1item,
                       const double DelR) const
  {
    Double_t l1dr = DelR;
    const xAOD::MuonRoIContainer* muonrois = 0;
    StatusCode sc = evtStore()->retrieve(muonrois,"LVL1MuonRoIs");
    if(!sc){
      ATH_MSG_ERROR("TrigMuonMatching::matchL1 : could not retrieve LVL1MuonRoIs");
      return false;
    }
    Int_t threshold = getL1pt(l1item);
    xAOD::MuonRoIContainer::const_iterator muroi_itr = muonrois->begin();
    xAOD::MuonRoIContainer::const_iterator muroi_end = muonrois->end();
    for( ; muroi_itr != muroi_end; ++muroi_itr ) {
      if((*muroi_itr)->thrValue() >= threshold*1000){
    Double_t dR = TrigMuonMatching::dR(mu->eta(), mu->phi(), (*muroi_itr)->eta(), (*muroi_itr)->phi());
    if(dR < l1dr){
      l1dr = dR;
    }
      }
    }
    return l1dr;
  }
 
  Bool_t TrigMuonMatching::matchDimuon(const xAOD::Muon* mu1,
                       const xAOD::Muon* mu2,
                       const std::string& chain,
                       std::pair<Bool_t, Bool_t>& result1,
                       std::pair<Bool_t, Bool_t>& result2,
                       const Double_t& mindelR)
  {
    TLorentzVector mu_1, mu_2;
    mu_1.SetPtEtaPhiM(mu1->pt(),mu1->eta(),mu1->phi(),MUONMASS);
    mu_2.SetPtEtaPhiM(mu2->pt(),mu2->eta(),mu2->phi(),MUONMASS);
    Bool_t valid = matchDimuon(mu_1,mu_2,chain,result1,result2,mindelR);
    return valid;
  }
  
  Bool_t TrigMuonMatching::match(const double eta,
                 const double phi,
                 std::string_view chain,
                 const double mindelR) const
  {    
    if(!m_trigDecTool->isPassed(chain)){
      return false;
    }
    Double_t delmin = mindelR;
    EFmuon efmuon,dummy;
 
    matchedTrackDetail(efmuon, dummy, eta, phi, delmin, chain);
    return efmuon.valid;
  }
 
  Bool_t TrigMuonMatching::matchL1(const double eta,
                   const double phi,
                   std::string_view l1item,
                   const double DelR) const
  {
    if(!m_trigDecTool->isPassed("L1_MU.*")){
      return false;
    }
    Double_t l1dr = DelR;
    const xAOD::MuonRoIContainer* muonrois = 0;
    StatusCode sc = evtStore()->retrieve(muonrois,"LVL1MuonRoIs");
    if(!sc){
      ATH_MSG_ERROR("TrigMuonMatching::matchL1 : could not retrieve LVL1MuonRoIs");
      return false;
    }
    Int_t threshold = getL1pt(l1item);
    xAOD::MuonRoIContainer::const_iterator muroi_itr = muonrois->begin();
    xAOD::MuonRoIContainer::const_iterator muroi_end = muonrois->end();
    for( ; muroi_itr != muroi_end; ++muroi_itr ) {
      if((*muroi_itr)->thrValue() >= threshold*1000){
    Double_t dR = TrigMuonMatching::dR(eta, phi, (*muroi_itr)->eta(), (*muroi_itr)->phi());
    if(dR < l1dr){
      return true;
    }
      }
    }
    return false;
  }
 
  Bool_t TrigMuonMatching::matchL2SA(const xAOD::Muon* mu,
                     std::string_view l1item,
                     std::string_view chain,
                     const double DelR) const
  {
    if(!m_trigDecTool->isPassed("L1_MU.*")){
      return false;
    }
    const xAOD::MuonRoIContainer* muonrois = 0;
    StatusCode sc = evtStore()->retrieve(muonrois,"LVL1MuonRoIs");
    if(!sc){
      ATH_MSG_ERROR("TrigMuonMatching::matchL1 : could not retrieve LVL1MuonRoIs");
      return false;
    }
    xAOD::MuonRoIContainer::const_iterator muroi_itr = muonrois->begin();
    xAOD::MuonRoIContainer::const_iterator muroi_end = muonrois->end();
    Int_t threshold = getL1pt(l1item);
    unsigned int ROI = 0;
    const std::string emptyStr;
    for( ; muroi_itr != muroi_end; ++muroi_itr ) {
      if(!((*muroi_itr)->thrValue() >= threshold*1000)) continue;
      ROI = (*muroi_itr)->getRoI();
      auto cg = m_trigDecTool->getChainGroup(chain);
      auto fc = cg->features(TrigDefs::alsoDeactivateTEs);
#if defined(XAOD_STANDALONE) || defined(XAOD_ANALYSIS)
      auto MuFeatureContainers = fc.containerFeature<xAOD::L2StandAloneMuonContainer>(emptyStr,TrigDefs::alsoDeactivateTEs);
#else
      const std::vector< Trig::Feature<xAOD::L2StandAloneMuonContainer> > MuFeatureContainers = fc.get<xAOD::L2StandAloneMuonContainer>(emptyStr, TrigDefs::alsoDeactivateTEs);
#endif 
      for(const auto & mucont : MuFeatureContainers){
    for(auto muon : *mucont.cptr()){
      if(muon->roiNumber() == ROI){
        Double_t dR = TrigMuonMatching::dR(mu->eta(), mu->phi(), muon->eta(), muon->phi());
        if(dR < DelR) return true;
      }
    }
      }
    }
    
    return false;
  }
 
  Bool_t TrigMuonMatching::matchL2CB(const xAOD::Muon* mu,
                     std::string_view chain,
                     const double DelR) const
  {
    auto cg = m_trigDecTool->getChainGroup(chain);
    auto fc = cg->features(TrigDefs::alsoDeactivateTEs);
#if defined(XAOD_STANDALONE) || defined(XAOD_ANALYSIS)
    auto MuFeatureContainers = fc.containerFeature<xAOD::L2CombinedMuonContainer>("",TrigDefs::alsoDeactivateTEs);
#else
    const std::vector< Trig::Feature<xAOD::L2CombinedMuonContainer> > MuFeatureContainers = fc.get<xAOD::L2CombinedMuonContainer>("", TrigDefs::alsoDeactivateTEs);
#endif 
    
    for(const auto & mucont : MuFeatureContainers){
      for(auto muon : *mucont.cptr()){
    Double_t dR = TrigMuonMatching::dR(mu->eta(), mu->phi(), muon->eta(), muon->phi());
    if(dR < DelR) return true;
      }
    }
    return false;
  }
 
  Bool_t TrigMuonMatching::matchDimuon(const TLorentzVector& muon1,
                       const TLorentzVector& muon2,
                       const std::string& chain,
                       std::pair<Bool_t, Bool_t>& result1,
                       std::pair<Bool_t, Bool_t>& result2,
                       const Double_t& mindelR)
  {
    Double_t delmin = mindelR;
    DimuonChainInfo chainInfo(chain);
    if (not decodeDimuonChain(chainInfo)) {
      ATH_MSG_ERROR("TrigMuonMatching : Failed to decode chain " << chain << " matchDimuon can accept only chains named HLT_2muXX and HLT_muXX_mu8noL1.");
      return false; 
    }
    
    std::pair<Bool_t, Bool_t> rc12, rc21;
    rc12 = matchDimuon(muon1, muon2, chainInfo, delmin);
    if(chainInfo.isSymmetric){
      rc21.first = rc12.second; rc21.second = rc12.first;
    }
    
    else{
      rc21 = matchDimuon(muon2, muon1, chainInfo, delmin);
    }
 
    result1.first = rc12.first; result1.second = rc21.second;
    result2.first = rc21.first; result2.second = rc12.second;
    return true;
  }
 
  Bool_t TrigMuonMatching::isPassedRerun(const std::string& trigger) const
  {
    const unsigned int bits = m_trigDecTool->isPassedBits(trigger);
    if( (bits & TrigDefs::EF_passedRaw) && ! ( bits & TrigDefs::EF_passThrough) && ( bits & TrigDefs::EF_resurrected)){
      return true;
    }
    return false;
  }
 
  std::pair<Bool_t, Bool_t> TrigMuonMatching::matchDimuon(const TLorentzVector& muon1,
                              const TLorentzVector& muon2,
                              const DimuonChainInfo& chainInfo,
                              const double mindelR)
  {
    
    EFmuon trkId1, trkId2, dummy;
    const Double_t dr1 = matchedTrackDetail(trkId1, dummy, muon1.Eta(), muon1.Phi(), mindelR, chainInfo.thresholds.first);
 
    // for full scan trigger.
    
    const Double_t dr2 = matchedTrackDetail(trkId2, dummy, muon2.Eta(), muon2.Phi(), mindelR, chainInfo.thresholds.second);
    
    if(trkId1.valid && trkId2.valid &&
       isEqual(trkId1.pt, trkId2.pt) &&
       isEqual(trkId1.eta, trkId2.eta) &&
       isEqual(trkId1.phi, trkId2.phi)){
      if(dr1 > dr2){
    matchedTrackDetail(trkId1, trkId2, muon1.Eta(), muon1.Phi(), mindelR, chainInfo.thresholds.first);
      }
      else{
    matchedTrackDetail(trkId2, trkId1, muon2.Eta(), muon2.Phi(), mindelR, chainInfo.thresholds.second);
      }
    }
    
    return std::pair<Bool_t, Bool_t> (trkId1.valid, trkId2.valid);
  }
 
 
  
  double TrigMuonMatching::dR(const double eta1,
                  const double phi1,
                  const double eta2,
                  const double phi2) const
  {
    double deta = fabs(eta1 - eta2);
    double dphi = fabs(phi1 - phi2) < TMath::Pi() ? fabs(phi1 - phi2) : 2*TMath:: \
      Pi() - fabs(phi1 - phi2);
    return sqrt(deta*deta + dphi*dphi);
  }
  
  
  int TrigMuonMatching::getL1pt(std::string_view l1item) const
  {
    int rc = -1;
    
    std::vector<std::string> tokens = tokenize(l1item, '_');
    std::string pt;
    if (tokens.size() == 1) {
      pt = tokens.front();
      
    } else if ((tokens.size() == 2 ) and (tokens.front() == "L1")) {
      pt = tokens[1];
      
    } else {
      ATH_MSG_ERROR("TrigMuonMatching::getL1pt : cannot parse " << l1item);
      return rc;
    }
    
    const size_t index = pt.find("MU");
    if (index != std::string::npos) {
      std::istringstream iss(pt.substr(index + 2));
      iss >> rc;
    } else {
      ATH_MSG_ERROR("TrigMuonMatching::getL1pt : cannot parse " << l1item);
    }
    
    return rc;
  }
  
  
 
 
 
  Double_t TrigMuonMatching::matchedTrackDetail(EFmuon& efMuonId,
                        const EFmuon& usedEFMuonId,
                        const double eta,
                        const double phi,
                        const double mindelR,
                        std::string_view chainForEventTrigger) const
  {
    efMuonId.valid = false;
    Double_t drmin = mindelR;
    
    auto cg = m_trigDecTool->getChainGroup(chainForEventTrigger);
    auto fc = cg->features();
 
#if defined(XAOD_STANDALONE) || defined(XAOD_ANALYSIS)
    auto MuFeatureContainers = fc.containerFeature<xAOD::MuonContainer>();
#else
    const std::vector< Trig::Feature<xAOD::MuonContainer> > MuFeatureContainers = fc.get<xAOD::MuonContainer>();
#endif 
    
    for(const auto & mucont : MuFeatureContainers){
      for(auto mu : *mucont.cptr()){
 
    // l1 matching
    
    if(isEqual(usedEFMuonId.pt,  mu->pt()) &&
       isEqual(usedEFMuonId.eta, mu->eta()) &&
       isEqual(usedEFMuonId.phi, mu->phi())) continue;
    
    Double_t dr = dR(eta,phi,mu->eta(),mu->phi());
    if(drmin > dr){
      drmin = dr;
      efMuonId.pt = mu->pt();
      efMuonId.eta = mu->eta();
      efMuonId.phi = mu->phi();
      efMuonId.valid = true;
    }
      }
    }
    return drmin;
  }
  
  /*
  double TrigMuonMatching::matchedTrackDetail(const double eta,
                         const double phi,
                         const std::string chain,
                         const std::string l1item)
  {
    auto cg = m_trigDecTool->getChainGroup(chain);
    auto fc = cg->features();
    auto MuFeatureContainers = fc.containerFeature<xAOD::MuonContainer>();
    double dR_min = m_matchingDr;
    for(auto mucont : MuFeatureContainers){
    
        // l1 item matching 
    
      for(auto mu : *mucont.cptr()){
        
        // l1 item matching 
        double dr = dR(eta,phi,mu->eta(),mu->phi());
    if(dr < dR_min ) dR_min = dr;
      }
    }
    return dR_min;
  }
  */
 
  bool TrigMuonMatching::decodeDimuonChain(DimuonChainInfo& chainInfo)
  {
    chainInfo.isValid = false;
    std::map<std::string, DimuonChainInfo >::const_iterator p = m_DimuonChainMap.find(chainInfo.chain);
    if (p != m_DimuonChainMap.end()) {
      chainInfo = p->second;
      return chainInfo.isValid;
    }
    std::vector<std::string> tokens = tokenize(chainInfo.chain, '_');
    if (tokens.size() < 2) return false;
    if (tokens[0] != "HLT") return false;
    chainInfo.isSymmetric = (tokens[1].substr(0, 3) == "2mu");
    
    if(chainInfo.isSymmetric) {
      std::string threshold = std::string("HLT_" + tokens[1].substr(1));
      chainInfo.thresholds.first = threshold;
      chainInfo.thresholds.second = std::move(threshold);
      chainInfo.isValid = true;
    }
    else {
      if(tokens.size() != 3) return false;
 
      std::string high = std::string("HLT_" + tokens[1]);
      chainInfo.thresholds.first = std::move(high);
      chainInfo.thresholds.second = chainInfo.chain;
      chainInfo.isValid = true;
      return chainInfo.isValid;
 
    }
    m_DimuonChainMap[chainInfo.chain] = chainInfo;
  return chainInfo.isValid;
  }
  
  bool TrigMuonMatching::isEqual(const double x, const double y) const
  {
    if (std::fabs(x - y) < std::numeric_limits<float>::epsilon()) return true;
    return false;
  }
  
} // namespace CP