JMSCorrection.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef JETCALIBTOOLS_JMSCORRECTION_H
#define JETCALIBTOOLS_JMSCORRECTION_H 1
 
 /*
 *  Class definition of JMSCorrection - see Root/JMSCorrection.cxx for more details
 *  Jonathan Bossio (jbossios@cern.ch) , July 2015
 */
 
#include <TH2.h>
#include <TH3.h>
 
#include "JetCalibTools/JetCalibrationStep.h"
#include <vector>
#include <memory>
#include <string>
class TEnv;
 
class JMSCorrection 
  : virtual public ::JetCalibrationStep
{
 
 public:
  //Some convenient typedefs
  typedef std::vector<std::unique_ptr<const TH2>> VecTH2;
  typedef std::vector<double> VecD;
  typedef unsigned int uint;
 
  JMSCorrection();
  JMSCorrection(const std::string& name, TEnv * config, TString jetAlgo, TString calibAreaTag, bool dev);
 
  virtual StatusCode initialize() override;
  virtual StatusCode calibrate(xAOD::Jet& jet, JetEventInfo&) const override;
 
 private:
  float getMassCorr3D(double pT_uncorr, double mass_uncorr, double eta) const;
  float getMassCorr(double pT_uncorr, double mass_uncorr, int etabin) const;
  float getTrackAssistedMassCorr3D(double pT_uncorr, double mass_uncorr, double eta) const;
  float getTrackAssistedMassCorr(double pT_uncorr, double mass_uncorr, int etabin) const;
  float getRelCalo3D(double pT_uncorr, double mass_over_pt_uncorr, double eta) const;
  float getRelCalo(double pT_uncorr, double mass_over_pt_uncorr, int etabin) const;
  float getRelTA3D(double pT_uncorr, double mass_over_pt_uncorr, double eta) const;
  float getRelTA(double pT_uncorr, double mass_over_pt_uncorr, int etabin) const;
  float getRho3D(double pT_uncorr, double mass_over_pt_uncorr, double eta) const;
  float getRho(double pT_uncorr, double mass_over_pt_uncorr, int etabin) const;
 
  void setMassEtaBins(const VecD& etabins) { 
    if (etabins.size()==0) ATH_MSG_ERROR("Please check that the mass eta binning is properly set in your config file");
    m_massEtaBins=etabins;
  }
 
  void setMassCombinationEtaBins(const VecD& etabins) { 
    if (etabins.size()==0) ATH_MSG_ERROR("Please check that the mass combination eta binning is properly set in your config file");
    m_massCombinationEtaBins=etabins;
  }
 
 private:
 
  //Private members set in the constructor
  TEnv * m_config{};
  TString m_jetAlgo, m_calibAreaTag, m_jetOutScale;
  bool m_dev{};
 
  double m_pTMinCorr{};
 
  bool m_trackAssistedJetMassCorr{};
 
  bool m_pTfixed{}; // false: pT will be corrected (large-R), if true: the energy will be corrected and pT will be fixed (small-R)
 
  bool m_combination{}; // Mass Combination of calo mass with track-assisted mass
  bool m_useCorrelatedWeights{}; 
  bool m_onlyCombination{}; //mass combination using insitu calibrated inputs
 
  // Control the binning using a private class enum
  enum class BinningParam { pt_mass_eta, e_LOGmOe_eta, e_LOGmOet_eta, e_LOGmOpt_eta, et_LOGmOet_eta };
  BinningParam m_binParam = BinningParam::pt_mass_eta;
 
  // Check if we are reading 2D or 3D histograms
  // Defaults to false for backwards compatibility
  bool m_use3Dhisto{};
 
 
  //Private members set during initialization (if 2D histos)
  VecTH2 m_respFactorsMass;
  VecD m_massEtaBins;
  VecTH2 m_respFactorsTrackAssistedMass;
  VecD m_massCombinationEtaBins;
  VecTH2 m_caloResolutionMassCombination; // Calo Mass Resolution
  VecTH2 m_taResolutionMassCombination;   // Track-Assisted Mass Resolution
  VecTH2 m_correlationMapMassCombination;   // Correlation Map for mass combination (rho)
  
  //Private members set during initialization (if 3D histos)
  std::unique_ptr<const TH3> m_respFactorMass3D;
  std::unique_ptr<const TH3> m_respFactorTrackAssistedMass3D;
  std::unique_ptr<const TH3> m_caloResolutionMassCombination3D;
  std::unique_ptr<const TH3> m_taResolutionMassCombination3D;
  std::unique_ptr<const TH3> m_correlationMapMassCombination3D;
};
 
#endif