CaloClusterMatchingTool.cxx

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
// CaloClusterMatchingTool.cxx
// Implementation file for class CaloClusterMatchingTool
// Author: S.Binet<binet@cern.ch>
 
// CaloClusterMatching includes
#include "CaloClusterMatchingTool.h"
 
// STL includes
 
// FrameWork includes
#include "StoreGate/WriteDecorHandle.h"
#include <algorithm>
#include <utility>
 
namespace ClusterMatching {
 
  using namespace xAOD;
 
  // Destructor
  CaloClusterMatchingTool::~CaloClusterMatchingTool() = default;
 
  // Athena algtool's Hooks
  StatusCode CaloClusterMatchingTool::initialize()
  {
    ATH_MSG_INFO ("Initializing " << name() << "...");
 
    if (m_clustersIn.empty()) {
      ATH_MSG_ERROR("Empty name provided for TopoCluster collection nothing to "
                    "work with -- aborting");
      return StatusCode::FAILURE;
    }
 
    ATH_CHECK(m_clustersIn.initialize());
 
    return StatusCode::SUCCESS;
  }
 
  StatusCode CaloClusterMatchingTool::finalize()
  {
    ATH_MSG_INFO ("Finalizing " << name() << "...");
 
    return StatusCode::SUCCESS;
  }

  // Const methods:
 
  StatusCode CaloClusterMatchingTool::fillClusterMap(const EventContext& ctx, TopoClusterMap& tcmap) const
  {
 
    SG::ReadHandle<xAOD::CaloClusterContainer> topoclusters (m_clustersIn, ctx);
    ATH_CHECK( tcmap.SetTopoClusters(topoclusters.cptr()) );
 
    return StatusCode::SUCCESS;
  }
 
  // return shared fraction of clustered cell energy
  float CaloClusterMatchingTool::getClusterSharedEfrac(const xAOD::CaloCluster& refCluster,
                               const xAOD::CaloCluster& testCluster) const
  {
    int nSharedCells(0);
    float sharedE(0.);
    float totalE(0.);
    for (auto tcItr = testCluster.cell_begin(); tcItr != testCluster.cell_end();++tcItr) {
      if (tcItr->e() > 1e-9 || !m_reqPosE) {
        for (auto rcItr = refCluster.cell_begin(); rcItr != refCluster.cell_end(); ++rcItr) {
          if (*tcItr && *rcItr && (*tcItr == *rcItr)) {
            ++nSharedCells;
            sharedE += tcItr->e();
          }
        }
        totalE += tcItr->e();
      }
    }
    if(nSharedCells>0) {
      ATH_MSG_VERBOSE("Reference cluster and target cluster share " << nSharedCells << " cells, " << sharedE << " / " << totalE << " MeV");
      ATH_MSG_VERBOSE("DeltaR = " << refCluster.p4().DeltaR(testCluster.p4()));
    }
    return totalE<1e-9 ? 0. : sharedE/totalE;
  }
 
  // return true if clusters share a given fraction of their cell energy
  bool CaloClusterMatchingTool::clustersAreMatched(const xAOD::CaloCluster& refCluster,
                           const xAOD::CaloCluster& testCluster) const
  {
    return getClusterSharedEfrac(refCluster,testCluster)>m_minSharedEfrac;
  }
 
  // fill a list of clusters from the testClusters container that match the reference cluster
  // match criteria determined by calling clustersAreMatched
  // return true if matchedClusters list is non-empty
  bool CaloClusterMatchingTool::getMatchedClusters(const xAOD::CaloCluster& refCluster,
                           const std::vector<const xAOD::CaloCluster*>& testClusters,
                           std::vector<const xAOD::CaloCluster*>& matchedClusters) const
  {
    // check that it's empty?
    matchedClusters.clear();
 
    for(const auto& testCluster : testClusters) {
      if(clustersAreMatched(refCluster, *testCluster)) matchedClusters.push_back(testCluster);
    }
    return !matchedClusters.empty();
  }
 
  // fill a list of clusters from the configured cluster container that match the reference cluster
  // match criteria determined by calling clustersAreMatched
  // return true if matchedClusters list is non-empty
  bool CaloClusterMatchingTool::getMatchedClusters(const xAOD::CaloCluster& refCluster,
                           std::vector<const xAOD::CaloCluster*>& matchedClusters,
                           const TopoClusterMap& tcmap,
                           bool useLeadingCellEtaPhi) const
  {
    float refEta(0.), refPhi(0.);
    if(useLeadingCellEtaPhi) { // needed for muons because muon clusters have no eta/phi
      const CaloCell* leadcell(nullptr);
      float leadcellE(0.);
      for(auto refItr = refCluster.cell_begin(); refItr!=refCluster.cell_end(); ++refItr) {
    if(refItr->e() > leadcellE) leadcell = *refItr;
      }
      if(leadcell) {
        refEta = leadcell->eta();
        refPhi = leadcell->phi();
      }
    } else {
      refEta = refCluster.eta();
      refPhi = refCluster.phi();
    }
 
    // for now use the standard matching sizes determined by egamma, but may need to change for muons??
    // egamma shower is probably wider than muon cell track
    const std::vector<const xAOD::CaloCluster*> testClusters =
      tcmap.RetrieveTopoClusters(refEta, refPhi, refCluster.e()*cosh(refEta));
 
    return getMatchedClusters(refCluster, testClusters, matchedClusters);
  }
 
  // fill a list of clusters from the testClusters container that match the reference cluster
  // match criteria determined by calling clustersAreMatched
  // return true if matchedClusters list is non-empty
  bool CaloClusterMatchingTool::getMatchedClusters(const xAOD::CaloCluster& refCluster,
                           const std::vector<const xAOD::CaloCluster*>& testClusters,
                           std::vector<std::pair<const xAOD::CaloCluster*, float> >& matchedClustersAndE) const
  {
    // check that it's empty?
    matchedClustersAndE.clear();
 
    for(const auto& testCluster : testClusters) {
      float sharedEfrac = getClusterSharedEfrac(refCluster, *testCluster);
      if(sharedEfrac>m_minSharedEfrac) {
    matchedClustersAndE.emplace_back(testCluster,sharedEfrac);
      }
    }
    return !matchedClustersAndE.empty();
  }
 
  // fill a list of clusters from the configured cluster container that match the reference cluster
  // match criteria determined by calling clustersAreMatched
  // return true if matchedClusters list is non-empty
  bool CaloClusterMatchingTool::getMatchedClusters(const xAOD::CaloCluster& refCluster,
                           std::vector<std::pair<const xAOD::CaloCluster*, float> >& matchedClustersAndE,
                           const TopoClusterMap& tcmap,
                           bool useLeadingCellEtaPhi) const
  {
    float refEta(0.), refPhi(0.);
    if(useLeadingCellEtaPhi) { // needed for muons because muon clusters have no eta/phi
      const CaloCell* leadcell(nullptr);
      float leadcellE(0.);
      for(auto refItr = refCluster.cell_begin(); refItr!=refCluster.cell_end(); ++refItr) {
    if(refItr->e() > leadcellE) leadcell = *refItr;
      }
      if(leadcell) {
    refEta = leadcell->eta();
    refPhi = leadcell->phi();
      }
    } else {
      refEta = refCluster.eta();
      refPhi = refCluster.phi();
    }
 
    // for now use the standard matching sizes determined by egamma, but may need to change for muons??
    // egamma shower is probably wider than muon cell track
    const std::vector<const xAOD::CaloCluster*> testClusters =
      tcmap.RetrieveTopoClusters(refEta, refPhi, refCluster.e()*cosh(refEta));
 
    return getMatchedClusters(refCluster, testClusters, matchedClustersAndE);
  }
 
  // set ElementLinks to clusters from the configured cluster container that match the reference cluster
  // works via getMatchedClusters
  // return true if matchedClusters list is non-empty
  StatusCode CaloClusterMatchingTool::linkMatchedClusters(elementLinkDecorHandle_t& elementLinkDec,
                                                          const xAOD::CaloCluster& refCluster,
                              const std::vector<const xAOD::CaloCluster*>& testClusters,
                              bool (*gtrthan)(const std::pair<const xAOD::CaloCluster*,float>& pair1,
                                      const std::pair<const xAOD::CaloCluster*,float>& pair2)) const
  {
    std::vector<std::pair<const CaloCluster*,float> > matchedClustersAndE;
    std::vector<ElementLink<CaloClusterContainer> > tcLinks;
    std::vector<float> tcSharedE;
    if(!testClusters.empty()) {
      const CaloClusterContainer* pClCont = static_cast<const CaloClusterContainer*>(testClusters.front()->container());
      if(getMatchedClusters(refCluster, testClusters, matchedClustersAndE)) {
        std::sort(matchedClustersAndE.begin(),matchedClustersAndE.end(),gtrthan);
        for(const auto& tcAndE : matchedClustersAndE) {
          tcLinks.emplace_back(*pClCont,tcAndE.first->index());
          tcSharedE.push_back(tcAndE.second);
        }
      }
    }
    // apply the decoration to the reference cluster -- no exceptions
    elementLinkDec(refCluster) = std::move(tcLinks);
    ATH_MSG_VERBOSE("Decorate cluster " << refCluster.index() << " with " << elementLinkDec(refCluster).size() << " tc links");
 
    return StatusCode::SUCCESS;
  }
 
  // set ElementLinks to clusters from the configured cluster container that match the reference cluster
  // works via getMatchedClusters
  // return true if matchedClusters list is non-empty
  StatusCode CaloClusterMatchingTool::linkMatchedClusters(
    elementLinkDecorHandle_t& elementLinkDec,
    const xAOD::CaloCluster& refCluster,
    const TopoClusterMap& tcmap,
    bool useLeadingCellEtaPhi,
    bool (*gtrthan)(const std::pair<const xAOD::CaloCluster*,float>& pair1,
                    const std::pair<const xAOD::CaloCluster*,float>& pair2)) const
  {
    std::vector<std::pair<const CaloCluster*,float> > matchedClustersAndE;
    std::vector<ElementLink<CaloClusterContainer> > tcLinks;
    std::vector<float> tcSharedE;
    // no need to worry about return value.
    if(getMatchedClusters(refCluster, matchedClustersAndE, tcmap, useLeadingCellEtaPhi)) {
      const CaloClusterContainer* pClCont = static_cast<const CaloClusterContainer*>(matchedClustersAndE.front().first->container());
      std::sort(matchedClustersAndE.begin(),matchedClustersAndE.end(),gtrthan);
      for(const auto& tcAndE : matchedClustersAndE) {
        tcLinks.emplace_back(*pClCont,tcAndE.first->index());
        tcSharedE.push_back(tcAndE.second);
      }
    }
    // apply the decoration to the reference cluster -- no exceptions
    elementLinkDec(refCluster) = std::move(tcLinks);
    ATH_MSG_VERBOSE("Decorate cluster " << refCluster.index() << " with " << elementLinkDec(refCluster).size() << " tc links");
 
    return StatusCode::SUCCESS;
  }
}