METTauAssociator.cxx

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
// METTauAssociator.cxx
// Implementation file for class METTauAssociator
//
//  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
//
// Author: P Loch, S Resconi, TJ Khoo, AS Mete
 
// METReconstruction includes
#include "METReconstruction/METTauAssociator.h"
 
// MET EDM
#include "xAODMissingET/MissingETComposition.h"
 
// Tau EDM
#include "xAODTau/TauJetContainer.h"
#include "xAODTau/TauTrack.h"
#include "xAODTau/TauxAODHelpers.h"
 
// Tracking EDM
#include "xAODTracking/Vertex.h"
 
// DeltaR calculation
#include "FourMomUtils/xAODP4Helpers.h"
 
#include "tauRecTools/HelperFunctions.h"
#include "xAODCaloEvent/CaloVertexedTopoCluster.h"
#include "PFlowUtils/IWeightPFOTool.h"
 
 
using TauLink_t = ElementLink<xAOD::TauJetContainer>;
using FELink_t = ElementLink<xAOD::FlowElementContainer>;
 
namespace met {
 
  using namespace xAOD;
 
  // Constructors
  METTauAssociator::METTauAssociator(const std::string& name) :
    AsgTool(name),
    METAssociator(name)
  {
  }
 
  // Athena algtool's Hooks
  StatusCode METTauAssociator::initialize()
  {
    ATH_CHECK( METAssociator::initialize() );
 
    ATH_MSG_VERBOSE ("Initializing " << name() << "...");
    ATH_CHECK( m_tauContKey.initialize() );
    ATH_CHECK( m_neutralFEReadDecorKey.initialize(m_useFELinks) );
    ATH_CHECK( m_chargedFEReadDecorKey.initialize(m_useFELinks) );
 
    return StatusCode::SUCCESS;
  }
 
  // executeTool
  StatusCode METTauAssociator::executeTool(xAOD::MissingETContainer* /*metCont*/, xAOD::MissingETAssociationMap* metMap, const EventContext& ctx) const
  {
    ATH_MSG_VERBOSE ("In execute: " << name() << "...");
    
    SG::ReadHandle<xAOD::TauJetContainer> tauCont(m_tauContKey, ctx);
    if (!tauCont.isValid()) {
      ATH_MSG_WARNING("Unable to retrieve input tau container " << m_tauContKey.key());
      return StatusCode::FAILURE;
    }
 
    ATH_MSG_DEBUG("Successfully retrieved tau collection");
    if (fillAssocMap(metMap,tauCont.cptr(), ctx).isFailure()) {
      ATH_MSG_WARNING("Unable to fill map with tau container " << m_tauContKey.key());
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }
 
 
  //*********************************************************************************************************
  // Get tau constituents
  StatusCode METTauAssociator::extractTopoClusters(const xAOD::IParticle *obj,
                                                   std::vector<const xAOD::IParticle*>& tclist,
                                                   const met::METAssociator::ConstitHolder& /*tcCont*/, const EventContext&) const
  {
    const TauJet* tau = static_cast<const TauJet*>(obj);
    TLorentzVector tauAxis = tauRecTools::getTauAxis(*tau);
    const xAOD::Vertex* tauVertex = tau->vertex();
 
    auto clusterList = tau->clusters();
    for (const xAOD::IParticle* particle : clusterList) {
      const xAOD::CaloCluster* cluster = static_cast<const xAOD::CaloCluster*>(particle);
      
      TLorentzVector clusterP4 = cluster->p4();
      
      // Correct the four momentum to point at the tau vertex
      if (tauVertex) {
        xAOD::CaloVertexedTopoCluster vertexedCluster(*cluster, tauVertex->position()); 
        clusterP4 = vertexedCluster.p4();
      }
        
      if (clusterP4.DeltaR(tauAxis) > 0.2) continue;
    
      tclist.push_back(particle);
    }
  
    return StatusCode::SUCCESS;
  }
 
 
  StatusCode METTauAssociator::extractTracks(const xAOD::IParticle *obj,
                                             std::vector<const xAOD::IParticle*>& constlist,
                                             const met::METAssociator::ConstitHolder& constits) const
  {
    const TauJet* tau = static_cast<const TauJet*>(obj);
    for( const xAOD::TauTrack* tauTrk : tau->tracks(xAOD::TauJetParameters::coreTrack) ){//all tracks dR<0.2 regardless of quality
      if(tauTrk->trackLinks().empty() || !tauTrk->trackLinks().at(0).isValid()){
        ATH_MSG_DEBUG("Skipping absent tau track, probably thinned");
        continue;
      }
      const TrackParticle* trk = tauTrk->track();
      if(acceptTrack(trk,constits.pv) && isGoodEoverP(trk) ){
        ATH_MSG_VERBOSE("Accept tau track " << trk << " px, py = " << trk->p4().Px() << ", " << trk->p4().Py());
        constlist.push_back(trk);
      }
    }
 
    return StatusCode::SUCCESS;
  }
  //*********************************************************************************************************
  // Get tau constituents
  StatusCode METTauAssociator::extractPFO(const xAOD::IParticle* obj,
                                          std::vector<const xAOD::IParticle*>& pfolist,
                                          const met::METAssociator::ConstitHolder& constits,
                                          std::map<const IParticle*,MissingETBase::Types::constvec_t> &/*momenta*/, const EventContext&) const
  {
    const TauJet* tau = static_cast<const TauJet*>(obj);
    const Jet* seedjet = *tau->jetLink();
    TLorentzVector momentum;
    for(const auto *const pfo : *constits.pfoCont) {
      bool match = false;
      if (!pfo->isCharged()) {
        if(xAOD::P4Helpers::isInDeltaR(*seedjet,*pfo,0.2,m_useRapidity) && pfo->eEM()>0) {
          ATH_MSG_VERBOSE("Found nPFO with dR " << seedjet->p4().DeltaR(pfo->p4EM()));
          match = true;
        }
      }
      else {
        const TrackParticle* pfotrk = pfo->track(0);
        for( const xAOD::TauTrack* ttrk : tau->tracks(xAOD::TauJetParameters::coreTrack) ){//all tracks <0.2, no quality
          if(ttrk->trackLinks().empty() || !ttrk->trackLinks().at(0).isValid()){
            ATH_MSG_DEBUG("Skipping absent tau track, probably thinned");
            continue;
          }
          const TrackParticle* tautrk = ttrk->track();
          if(tautrk==pfotrk) {
            ATH_MSG_VERBOSE("Found cPFO with dR " << seedjet->p4().DeltaR(ttrk->p4()));
            // We set a small -ve pt for cPFOs that were rejected
            // by the ChargedHadronSubtractionTool
            const static SG::ConstAccessor<char> PVMatchedAcc("matchedToPV");        
            if(PVMatchedAcc(*pfo) && ( !m_cleanChargedPFO || isGoodEoverP(pfotrk) )) match = true;
          }
        }
      }
      if(match) {
        pfolist.push_back(pfo);
      }
    }
    return StatusCode::SUCCESS;
  }
 
  StatusCode METTauAssociator::extractFE(const xAOD::IParticle* obj, 
                                            std::vector<const xAOD::IParticle*>& felist,
                                            const met::METAssociator::ConstitHolder& constits,
                                            std::map<const IParticle*,MissingETBase::Types::constvec_t> &/*momenta*/, const EventContext& ctx) const
  {
    const TauJet* tau = static_cast<const TauJet*>(obj);
    if (m_useFELinks)
      ATH_CHECK( extractFEsFromLinks(tau, felist,constits, ctx) );
    else
      ATH_CHECK( extractFEs(tau, felist, constits) );
 
    return StatusCode::SUCCESS;
  }
 
 
  StatusCode METTauAssociator::extractFEsFromLinks(const xAOD::TauJet* tau, //TODO to be tested
                        std::vector<const xAOD::IParticle*>& felist,
                    const met::METAssociator::ConstitHolder& constits, const EventContext& ctx) const 
  {
 
    ATH_MSG_DEBUG("Extract FEs From Links for " << tau->type()  << " with pT " << tau->pt());
 
    std::vector<FELink_t> nFELinks;
    std::vector<FELink_t> cFELinks;
 
    SG::ReadDecorHandle<xAOD::TauJetContainer, std::vector<FELink_t> > neutralFEReadDecorHandle (m_neutralFEReadDecorKey, ctx);
    SG::ReadDecorHandle<xAOD::TauJetContainer, std::vector<FELink_t> > chargedFEReadDecorHandle (m_chargedFEReadDecorKey, ctx);
    nFELinks=neutralFEReadDecorHandle(*tau);
    cFELinks=chargedFEReadDecorHandle(*tau);
 
    // Charged FEs
    for (const FELink_t& feLink : cFELinks) {
      if (!feLink.isValid()) continue;
      const xAOD::FlowElement* fe_init = *feLink;
      for (const auto *const fe : *constits.feCont){
        if (fe->index() == fe_init->index() && fe->isCharged()){ //index-based match between JetETmiss and CHSFlowElements collections
          const static SG::ConstAccessor<char> PVMatchedAcc("matchedToPV");
          if(  fe->isCharged() && PVMatchedAcc(*fe)&& ( !m_cleanChargedPFO || isGoodEoverP(static_cast<const xAOD::TrackParticle*>(fe->chargedObject(0))) ) ) {
            ATH_MSG_DEBUG("Accept cFE with pt " << fe->pt() << ", e " << fe->e() << ", eta " << fe->eta() << ", phi " << fe->phi() );
            felist.push_back(fe); 
          } 
        }
      }
    } // end cFE loop
 
    // Neutral FEs
    for (const FELink_t& feLink : nFELinks) {
      if (!feLink.isValid()) continue;
      const xAOD::FlowElement* fe_init = *feLink;
      for (const auto *const fe : *constits.feCont){
        if (fe->index() == fe_init->index() && !fe->isCharged()){ //index-based match between JetETmiss and CHSFlowElements collections
          if( ( !fe->isCharged()&& fe->e() > FLT_MIN ) ){ 
            ATH_MSG_DEBUG("Accept nFE with pt " << fe->pt() << ", e " << fe->e() << ", eta " << fe->eta() << ", phi " << fe->phi() << " in sum.");
            felist.push_back(fe);
          }   
        }
      }
    } // end nFE links loop
 
 
    return StatusCode::SUCCESS;
 
  }
 
 
  StatusCode METTauAssociator::extractFEs(const xAOD::TauJet* tau,
                                         std::vector<const xAOD::IParticle*>& felist,
                                         const met::METAssociator::ConstitHolder& constits) const
  {
    //const TauJet* tau = static_cast<const TauJet*>(obj);
    if(!tau->jetLink().isValid()){
      ATH_MSG_ERROR("Tau seed jet link is invalid. Cannot extract FlowElements.");
      return StatusCode::FAILURE;
    }
    const Jet* seedjet = *tau->jetLink();
    TLorentzVector momentum;
    for(const xAOD::FlowElement* pfo : *constits.feCont) {
      bool match = false;
      if (!pfo->isCharged()) {
        if(xAOD::P4Helpers::isInDeltaR(*seedjet,*pfo,0.2,m_useRapidity) && pfo->e()>0) {
          ATH_MSG_VERBOSE("Found nPFO with dR " << seedjet->p4().DeltaR(pfo->p4())); 
          match = true;
        }
      }
      else {
        const TrackParticle* pfotrk = static_cast<const xAOD::TrackParticle*>(pfo->chargedObject(0));
        for( const xAOD::TauTrack* ttrk : tau->tracks(xAOD::TauJetParameters::coreTrack) ){//all tracks <0.2, no quality
          if(ttrk->trackLinks().empty() || !ttrk->trackLinks().at(0).isValid()){
            ATH_MSG_DEBUG("Skipping absent tau track, probably thinned");
            continue;
          }
          const TrackParticle* tautrk = ttrk->track();
          if(tautrk==pfotrk) {
            ATH_MSG_VERBOSE("Found cPFO with dR " << seedjet->p4().DeltaR(ttrk->p4())); 
            // We set a small -ve pt for cPFOs that were rejected
            // by the ChargedHadronSubtractionTool
            const static SG::ConstAccessor<char> PVMatchedAcc("matchedToPV");        
            if(PVMatchedAcc(*pfo) && ( !m_cleanChargedPFO || isGoodEoverP(pfotrk) )) match = true;
          }
        }
      }
      if(match) {
        felist.push_back(pfo);
      }
    }
    return StatusCode::SUCCESS;
  }
 
 
}