MvaTESVariableDecorator.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
// local include(s)
#include "tauRecTools/MvaTESVariableDecorator.h"
#include "tauRecTools/HelperFunctions.h"
 
#include "AsgDataHandles/ReadHandle.h"
#include "AsgDataHandles/ReadDecorHandle.h"
#include "CxxUtils/trapping_fp.h"
 
MvaTESVariableDecorator::MvaTESVariableDecorator(const std::string& name) 
  : TauRecToolBase(name) {
}
 
 
StatusCode MvaTESVariableDecorator::initialize() {
 
  ATH_CHECK(m_aveIntPerXKey.initialize());
  ATH_CHECK(m_vertexContainerKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_eventShapeKey.initialize(SG::AllowEmpty));
 
  if (std::string(m_seedJet).find("EM") != std::string::npos) {
    ATH_MSG_INFO("Set the cluster state to UNCALIBRATED");
    m_clusterState = xAOD::CaloCluster::State::UNCALIBRATED;
  } else {
    m_clusterState = xAOD::CaloCluster::State::CALIBRATED;
  }    
 
  return StatusCode::SUCCESS;
}
 
 
StatusCode MvaTESVariableDecorator::executeTool(xAOD::TauJet& xTau,
                        const EventContext& ctx) const {
 
  // Tell clang to optimize assuming that FP operations may trap.
  CXXUTILS_TRAPPING_FP;
 
  int mu = 0;
  SG::ReadDecorHandle<xAOD::EventInfo, float> eventInfoDecorHandle(m_aveIntPerXKey, ctx);
  if (!eventInfoDecorHandle.isPresent()) {
    ATH_MSG_WARNING ( "EventInfo decoration not available! Will set mu=0." );
  }
  else {
    // convert from float to int to ignore peculiar values used in MC
    mu = static_cast<int>(eventInfoDecorHandle(0));
  }
  static const SG::Accessor<float> acc_mu("mu");  
  acc_mu(xTau) = mu;
 
  if (!m_vertexContainerKey.empty()) {
    int nVtxPU = 0;
    SG::ReadHandle<xAOD::VertexContainer> vertexInHandle(m_vertexContainerKey, ctx);
    if (!vertexInHandle.isValid()) {
      ATH_MSG_WARNING ("Could not retrieve HiveDataObj with key " << vertexInHandle.key() << ", will set nVtxPU=0.");
    }
    else {
      const xAOD::VertexContainer* vertexContainer = vertexInHandle.cptr();
      for (const auto *xVertex : *vertexContainer){
        if (xVertex->vertexType() == xAOD::VxType::PileUp)
        ++nVtxPU;
      }
    }
    static const SG::Accessor<int> acc_nVtxPU("nVtxPU");
    acc_nVtxPU(xTau) = nVtxPU;
  }
 
  if (!m_eventShapeKey.empty()) {
    double rho = 0.;
    SG::ReadHandle<xAOD::EventShape> eventShape(m_eventShapeKey, ctx);
    if (!eventShape.isValid()) {    
      ATH_MSG_WARNING ("Could not retrieve EventShape with key " << m_eventShapeKey );
    }
    else if (!eventShape->getDensity(xAOD::EventShape::Density, rho)) {
      ATH_MSG_WARNING ("Could not retrieve rho.");
    }
    static const SG::Accessor<float> acc_rho("rho");
    acc_rho(xTau) = static_cast<float>(rho);
  }
 
  double center_lambda=0.       , first_eng_dens=0.      , em_probability=0.      , second_lambda=0.      ;
  double mean_center_lambda=0.  , mean_first_eng_dens=0. , mean_em_probability=0. , mean_second_lambda=0. ;
  double mean_presampler_frac=0., lead_cluster_frac=0.   , second_cluster_frac=0. , third_cluster_frac=0. ;
  double clE=0., Etot=0.;
 
  // approximate Upsilon based on clusters, not PFOs (for online TES)
  TLorentzVector clusters_EM_P4;
  clusters_EM_P4.SetPtEtaPhiM(0,0,0,0);
  TLorentzVector clusters_had_P4;
  clusters_had_P4.SetPtEtaPhiM(0,0,0,0);
  TLorentzVector tauIntermediateAxisEM;
  tauIntermediateAxisEM.SetPtEtaPhiM(0,0,0,0);
 
  TLorentzVector tauAxis = tauRecTools::getTauAxis(xTau, m_doVertexCorrection);
 
  // in the trigger, we must ignore the tau vertex, otherwise ptFinalCalib computed at calo-only step and precision step will differ
  const xAOD::Vertex* vertex = nullptr;
  if (m_doVertexCorrection) vertex = xTau.vertex();
 
  // loop over tau clusters
  std::vector<xAOD::CaloVertexedTopoCluster> vertexedClusters = xTau.vertexedClusters();
  
  for (const xAOD::CaloVertexedTopoCluster& vertexedCluster : vertexedClusters) {
    const xAOD::CaloCluster& cluster = vertexedCluster.clust();
    
    TLorentzVector clusterP4 = m_doVertexCorrection? vertexedCluster.p4() : cluster.p4();
    if (clusterP4.DeltaR(tauAxis) > 0.2) continue;
 
    // FIXME: should we use calE for EMTopo clusters ?
    // what's the energy scale when calculating the cluster momentum
    clE = cluster.calE();
    Etot += clE;
 
    if (clE > lead_cluster_frac) {
      third_cluster_frac = second_cluster_frac;
      second_cluster_frac = lead_cluster_frac;
      lead_cluster_frac = clE;
    }
    else if (clE > second_cluster_frac) {
      third_cluster_frac = second_cluster_frac;
      second_cluster_frac = clE;
    }
    else if (clE > third_cluster_frac) {
      third_cluster_frac = clE;
    }
 
    if (cluster.retrieveMoment(xAOD::CaloCluster::MomentType::CENTER_LAMBDA,center_lambda))
      mean_center_lambda += clE*center_lambda;
    else ATH_MSG_WARNING("Failed to retrieve moment: CENTER_LAMBDA");
 
    if (cluster.retrieveMoment(xAOD::CaloCluster::MomentType::FIRST_ENG_DENS,first_eng_dens))
      mean_first_eng_dens += clE*first_eng_dens;
    else ATH_MSG_WARNING("Failed to retrieve moment: FIRST_ENG_DENS");
 
    if (cluster.retrieveMoment(xAOD::CaloCluster::MomentType::EM_PROBABILITY,em_probability)) {
      mean_em_probability += clE*em_probability;
 
      // FIXME: should we use calE for EMTopo clusters ?
      // what's the energy scale when calculating the cluster momentum
      if (em_probability>0.5) clusters_EM_P4 += cluster.p4(m_clusterState);      
      else clusters_had_P4 += cluster.p4(m_clusterState);
    }
    else ATH_MSG_WARNING("Failed to retrieve moment: EM_PROBABILITY");
 
    if (cluster.retrieveMoment(xAOD::CaloCluster::MomentType::SECOND_LAMBDA,second_lambda))
      mean_second_lambda += clE*second_lambda;
    else ATH_MSG_WARNING("Failed to retrieve moment: SECOND_LAMBDA");
 
    mean_presampler_frac += (cluster.eSample(CaloSampling::PreSamplerB) + cluster.eSample(CaloSampling::PreSamplerE));
    
    // EM-scale equivalent of IntermediateAxis p4
    if (vertex) {
      xAOD::CaloVertexedTopoCluster vertexedClusterEM(cluster, xAOD::CaloCluster::State::UNCALIBRATED, vertex->position());
      tauIntermediateAxisEM += vertexedClusterEM.p4(); 
    }
    else {
      tauIntermediateAxisEM += cluster.p4(xAOD::CaloCluster::State::UNCALIBRATED);
    }
  }
  
  // calculate mean values
  if (Etot>0.) {
    mean_center_lambda /= Etot;
    mean_first_eng_dens /= Etot; 
    mean_em_probability /= Etot; 
    mean_second_lambda /= Etot;
    mean_presampler_frac /= Etot;
    lead_cluster_frac /= Etot;
    second_cluster_frac /= Etot;
    third_cluster_frac /= Etot;
 
    if (mean_first_eng_dens>0.) mean_first_eng_dens = TMath::Log10(mean_first_eng_dens/Etot);
  }
  
  // cluster-based upsilon, ranges from -1 to 1
  double upsilon_cluster = -2.;
  if (clusters_had_P4.E()+clusters_EM_P4.E()!=0.)
    upsilon_cluster = (clusters_had_P4.E()-clusters_EM_P4.E())/(clusters_had_P4.E()+clusters_EM_P4.E());
  
  xTau.setDetail(xAOD::TauJetParameters::ClustersMeanCenterLambda, static_cast<float>(mean_center_lambda));
  xTau.setDetail(xAOD::TauJetParameters::ClustersMeanFirstEngDens, static_cast<float>(mean_first_eng_dens));
  xTau.setDetail(xAOD::TauJetParameters::ClustersMeanEMProbability, static_cast<float>(mean_em_probability));
  xTau.setDetail(xAOD::TauJetParameters::ClustersMeanSecondLambda, static_cast<float>(mean_second_lambda));
  xTau.setDetail(xAOD::TauJetParameters::ClustersMeanPresamplerFrac, static_cast<float>(mean_presampler_frac));
 
  static const SG::Accessor<float> acc_ClusterTotalEnergy("ClusterTotalEnergy");
  acc_ClusterTotalEnergy(xTau) = static_cast<float>(Etot);
 
  static const SG::Accessor<float> acc_ptIntermediateAxisEM("ptIntermediateAxisEM");
  acc_ptIntermediateAxisEM(xTau) = static_cast<float>(tauIntermediateAxisEM.Pt());
 
  // online-specific, not defined in TauDefs enum
  static const SG::Accessor<float> acc_LeadClusterFrac("LeadClusterFrac");
  static const SG::Accessor<float> acc_UpsilonCluster("UpsilonCluster");
  acc_LeadClusterFrac(xTau) = static_cast<float>(lead_cluster_frac);
  acc_UpsilonCluster(xTau) = static_cast<float>(upsilon_cluster);
 
  if (inTrigger()) {
    // for now only used by trigger, but could be used by offline 0p in the 2022 reprocessing
    static const SG::Accessor<float> acc_SecondClusterFrac("SecondClusterFrac");
    static const SG::Accessor<float> acc_ThirdClusterFrac("ThirdClusterFrac");
    acc_SecondClusterFrac(xTau) = static_cast<float>(second_cluster_frac);
    acc_ThirdClusterFrac(xTau) = static_cast<float>(third_cluster_frac);
 
    return StatusCode::SUCCESS;
  }
 
  // summing corrected Pi0 PFO energies
  TLorentzVector Pi0_totalP4;
  Pi0_totalP4.SetPtEtaPhiM(0,0,0,0);
  
  for (size_t i=0; i<xTau.nPi0PFOs(); i++){
    Pi0_totalP4 += xTau.pi0PFO(i)->p4();
  }
  
  double Pi0_totalE = Pi0_totalP4.E();
  
  // summing tau track momenta
  TLorentzVector charged_totalP4;
  charged_totalP4.SetPtEtaPhiM(0,0,0,0);
 
  for (const xAOD::TauTrack* track : xTau.tracks()) {
    charged_totalP4 += track->p4();
  }
  
  double charged_totalE = charged_totalP4.E();
  
  // calculate relative difference and decorate onto tau
  double relDiff=0.;
  if (Pi0_totalE+charged_totalE != 0.){
    relDiff = (charged_totalE - Pi0_totalE) / (charged_totalE + Pi0_totalE) ;
  }
  xTau.setDetail(xAOD::TauJetParameters::PFOEngRelDiff, static_cast<float>(relDiff));
  
  return StatusCode::SUCCESS;
}