GSCCalibStep.cxx

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
// GSCCalibStep.cxx 
// Implementation file for class GSCCalibStep
 
#include "JetCalibTools/GSCCalibStep.h"
 
GSCCalibStep::GSCCalibStep(const std::string& name)
  : asg::AsgTool( name ){ }

// Public methods: 
 
StatusCode GSCCalibStep::initialize() {
  ATH_MSG_DEBUG ("Initializing " << name() );
 
  ATH_MSG_DEBUG("Reading from " << m_jetInScale << " and writing to " << m_jetOutScale);
 
  if(m_applyChargedFraction){
    ATH_CHECK( m_histTool_ChargedFraction.retrieve());
  }
  if(m_applyEM3){
    ATH_CHECK( m_histTool_EM3.retrieve());
  }
  if(m_applyTile0){
    ATH_CHECK( m_histTool_Tile0.retrieve());
  }
  if(m_applyNtrk){
     ATH_CHECK( m_histTool_nTrk.retrieve());
  }
  if(m_applyTrackWidth){
    ATH_CHECK( m_histTool_trackWIDTH.retrieve());
  }
  if(m_applyPunchThrough){
    ATH_CHECK( m_histTool_PunchThrough.retrieve());
  }
 
  ATH_CHECK(m_vertexContainer_key.initialize());
  ATH_CHECK(m_eventInfo_key.initialize());
 
  return StatusCode::SUCCESS;
}
 
 
StatusCode GSCCalibStep::calibrate(xAOD::JetContainer& jets) const {
 
  ATH_MSG_DEBUG("Calibrating jet collection with GSC.");
 
  // Retrieve the primary vertex location:
  int PVindex = 0;
 
  // Check if an analysis choose their own PV vertex ("PVIndex")
  static const SG::AuxElement::ConstAccessor<int> pvIndexAccessor("PVIndex");
  SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfo_key);
  if(eventInfo.isValid()) {
    if(pvIndexAccessor.isAvailable(*eventInfo)){
      PVindex = pvIndexAccessor(*eventInfo);
    }
  }
  else{
    // Get the PV index directly from the vertices
    SG::ReadHandle<xAOD::VertexContainer> vertexHandle = SG::makeHandle (m_vertexContainer_key);
    const xAOD::VertexContainer& vertices = *vertexHandle;
    const xAOD::Vertex *HSvertex = findHSVertex(vertices);
    if(!HSvertex) {
      ATH_MSG_WARNING("Invalid primary vertex found, will not continue applying the GSC.");
      return StatusCode::FAILURE;
    }
    PVindex = HSvertex->index();
  }
 
  ATH_MSG_DEBUG("PV index:" << PVindex);
 
  // Needed for per-vertex reconstructed jets
  static const SG::ConstAccessor<xAOD::Vertex> originVertexAcc("OriginVertex");
 
  // Calibrate the jets
  for (xAOD::Jet* jet : jets){ 
 
    JetHelper::JetContext jc;
 
    // For the per-vertex reconstructed jets, use the vertex the jet was reconstructed with respect to
    if(originVertexAcc.isAvailable(*jet)){
      PVindex = jet->getAssociatedObject<xAOD::Vertex>("OriginVertex")->index();
    }
 
    // get trackWIDTHPVX
    float trackWIDTHPVX = 0;
    static const SG::ConstAccessor<std::vector<float> > TrackWidthPt1000Acc ("TrackWidthPt1000");
    if(TrackWidthPt1000Acc.isAvailable(*jet))
    {
        trackWIDTHPVX = TrackWidthPt1000Acc(*jet).at(PVindex);
        ATH_MSG_DEBUG("trackWIDTHPVX found set to: " << trackWIDTHPVX);
    }
    jc.setValue("trackWIDTH", trackWIDTHPVX);
 
    // get nTrkPVX
    int nTrkPVX = 0;
    static const SG::ConstAccessor<std::vector<int>> NumTrkPt1000Acc ("NumTrkPt1000");
    if(NumTrkPt1000Acc.isAvailable(*jet))
    {
        nTrkPVX = NumTrkPt1000Acc(*jet).at(PVindex);
        ATH_MSG_DEBUG("nTrkPVX found set to: " << nTrkPVX);
    }
    jc.setValue("nTrk", nTrkPVX);
 
    // get Charged Fraction
    xAOD::JetFourMom_t jetconstitP4 = jet->getAttribute<xAOD::JetFourMom_t>("JetConstitScaleMomentum");
    float ChargedFraction = 0;
    static const SG::ConstAccessor<std::vector<float>> SumPtChargedPFOPt500Acc ("SumPtChargedPFOPt500");
    if(SumPtChargedPFOPt500Acc.isAvailable(*jet))
    {
        ChargedFraction = SumPtChargedPFOPt500Acc(*jet).at(PVindex)/jetconstitP4.Pt();
        ATH_MSG_DEBUG("ChargedFraction found set to: " << ChargedFraction);
    }
    jc.setValue("ChargedFraction", ChargedFraction);
 
    std::vector<float> samplingFrac = jet->getAttribute<std::vector<float> >("EnergyPerSampling");
    // get EM3
    float EM3 = (samplingFrac[3]+samplingFrac[7])/jetconstitP4.e();
    ATH_MSG_DEBUG("EM3 found set to: " << EM3);
    jc.setValue("EM3", EM3);
    // get Tile0
    float Tile0 = (samplingFrac[12]+samplingFrac[18])/jetconstitP4.e();
    ATH_MSG_DEBUG("Tile0 found set to: " << Tile0);
    jc.setValue("Tile0", Tile0);
 
    // get Muon segments
    int Nsegments = 0;
    static const SG::ConstAccessor<int> GhostMuonSegmentCountAcc ("GhostMuonSegmentCount");
    if(GhostMuonSegmentCountAcc.isAvailable(*jet))
    {
        Nsegments = GhostMuonSegmentCountAcc(*jet);
        ATH_MSG_DEBUG("Nsegments found set to: " << Nsegments);
    }
    jc.setValue("Nsegments", Nsegments);
 
    float getGSCCorrection = 1.0;
 
    // get detector eta to determine bin
    float detectorEta = jet->getAttribute<float>("DetectorEta");
    int etabin = std::abs(detectorEta)/0.1;// m_binSize in old version
 
    const xAOD::JetFourMom_t startingP4 = jet->getAttribute<xAOD::JetFourMom_t>(m_jetInScale);
    jet->setJetP4(startingP4);
 
    ATH_MSG_DEBUG("Jet pt original ("<<m_jetInScale<<"): " << jet->pt()*1e-3);
 
    ATH_MSG_DEBUG("ChargedFraction Response: " << getChargedFractionResponse(*jet, jc, etabin));
    ATH_MSG_DEBUG("Tile0 Response: " <<getTile0Response(*jet, jc, etabin));
    ATH_MSG_DEBUG("EM3 Response: " << getEM3Response(*jet, jc, etabin));
    ATH_MSG_DEBUG("NTrk Response: " <<getNTrkResponse(*jet, jc, etabin));
    ATH_MSG_DEBUG("TrkWidth Response: " <<getTrackWIDTHResponse(*jet, jc, etabin));
 
    if(m_applyChargedFraction){
      getGSCCorrection*=1./getChargedFractionResponse(*jet, jc, etabin);
      jet->setJetP4( startingP4*getGSCCorrection );
    }
    if(m_applyTile0){
      getGSCCorrection*=1./getTile0Response(*jet, jc, etabin);
      jet->setJetP4( startingP4*getGSCCorrection );
    }
    if(m_applyEM3){
      getGSCCorrection*=1./getEM3Response(*jet, jc, etabin);
      jet->setJetP4( startingP4*getGSCCorrection );
    }
    if(m_applyNtrk){
      getGSCCorrection*=1./getNTrkResponse(*jet, jc, etabin);
      jet->setJetP4( startingP4*getGSCCorrection );
    }
    if(m_applyTrackWidth){
      getGSCCorrection*=1./getTrackWIDTHResponse(*jet, jc, etabin);
      jet->setJetP4( startingP4*getGSCCorrection );
    }
    if(m_applyPunchThrough && startingP4.Pt() >= m_punchThroughMinPt){
      jet->setJetP4( startingP4*getGSCCorrection );
      getGSCCorrection*=1./getPunchThroughResponse(*jet, jc, std::abs(detectorEta));
    }
 
    ATH_MSG_DEBUG("GSC full correction: " << getGSCCorrection);
 
    jet->setAttribute<xAOD::JetFourMom_t>(m_jetOutScale,startingP4*getGSCCorrection);
    jet->setJetP4( startingP4*getGSCCorrection );
 
    ATH_MSG_DEBUG("Jet pt calibrated:" << jet->pt()*1e-3);
 
  }// loop jets
 
  return StatusCode::SUCCESS;
}
 
float GSCCalibStep::getChargedFractionResponse(const xAOD::Jet& jet, const JetHelper::JetContext& jc, uint etabin) const {
  if (jc.getValue<float>("ChargedFraction")<=0) return 1; //ChargedFraction < 0 is unphysical, ChargedFraction = 0 is a special case, so we return 1 for ChargedFraction <= 0
  if ( etabin >= m_histTool_ChargedFraction.size() ) return 1.;
  double ChargedFractionResponse = m_histTool_ChargedFraction[etabin]->getValue(jet, jc);
  return ChargedFractionResponse;
}
 
float GSCCalibStep::getTile0Response(const xAOD::Jet& jet, const JetHelper::JetContext& jc, uint etabin) const {
  if (jc.getValue<float>("Tile0")<0) return 1; //Tile0 < 0 is unphysical, so we return 1
  if ( etabin >= m_histTool_Tile0.size() ) return 1.;
  double Tile0Response = m_histTool_Tile0[etabin]->getValue(jet, jc);
  return Tile0Response;
}
 
float GSCCalibStep::getEM3Response(const xAOD::Jet& jet, const JetHelper::JetContext& jc, uint etabin) const {
  if (jc.getValue<float>("EM3")<=0) return 1; //EM3 < 0 is unphysical, EM3 = 0 is a special case, so we return 1 for EM3 <= 0
  if ( etabin >= m_histTool_EM3.size() ) return 1.;
  float EM3Response = m_histTool_EM3[etabin]->getValue(jet, jc);
  return EM3Response;
}
 
float GSCCalibStep::getPunchThroughResponse(const xAOD::Jet& jet, const JetHelper::JetContext& jc, double eta_det) const {
  int etabin=-99;
  if (m_punchThroughEtaBins.empty() || m_histTool_PunchThrough.size() != m_punchThroughEtaBins.size()-1)
    ATH_MSG_WARNING("Please check that the punch through eta binning is properly set in your config file");
  if ( eta_det >= m_punchThroughEtaBins[m_punchThroughEtaBins.size()-1] || jc.getValue<int>("Nsegments") < 20 ) return 1;
  for (uint i=0; i<m_punchThroughEtaBins.size()-1; ++i) {
    if(eta_det >= m_punchThroughEtaBins[i] && eta_det < m_punchThroughEtaBins[i+1]) etabin = i;
  }
  if(etabin<0) {
    ATH_MSG_WARNING("There was a problem determining the eta bin to use for the punch through correction.");
    //this could probably be improved, but to avoid a seg fault...
    return 1;
  }
  double PunchThroughResponse = m_histTool_PunchThrough[etabin]->getValue(jet, jc);
  if(PunchThroughResponse>1) return 1;
  return PunchThroughResponse;
}
 
float GSCCalibStep::getNTrkResponse(const xAOD::Jet& jet, const JetHelper::JetContext& jc, uint etabin) const {
  if (jc.getValue<int>("nTrk")<=0) return 1; //nTrk < 0 is unphysical, nTrk = 0 is a special case, so return 1 for nTrk <= 0
  if ( etabin >= m_histTool_nTrk.size() ) return 1.;
  double nTrkResponse = m_histTool_nTrk[etabin]->getValue(jet, jc);
  return nTrkResponse;
}
 
float GSCCalibStep::getTrackWIDTHResponse(const xAOD::Jet& jet, const JetHelper::JetContext& jc, uint etabin) const {
  if (jc.getValue<float>("trackWIDTH")<=0) return 1;
  if ( etabin >= m_histTool_trackWIDTH.size() ) return 1.;
  //jets with no tracks are assigned a trackWIDTH of -1, we use the trackWIDTH=0 correction in those cases
  double trackWIDTHResponse = m_histTool_trackWIDTH[etabin]->getValue(jet, jc);
  return trackWIDTHResponse;
}
 
const xAOD::Vertex *GSCCalibStep::findHSVertex(const xAOD::VertexContainer& vertices) const {
  for ( const xAOD::Vertex* vertex : vertices ) {
    if(vertex->vertexType() == xAOD::VxType::PriVtx) {
      ATH_MSG_VERBOSE("GSCCalibStep " << name() << " Found HS vertex at index: "<< vertex->index());
      return vertex;
    }
  }
  if (vertices.size()==1) {
    ATH_MSG_VERBOSE("GSCCalibStep " << name() << " Found no HS vertex, return dummy");
    if (vertices.back()->vertexType() == xAOD::VxType::NoVtx)
      return vertices.back();
  }
  ATH_MSG_VERBOSE("No vertex found in container.");
  return nullptr;
}