METSignificance.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
// METSignificance.h
// Header file for class METSignificance
// Author: P. Francavilla<francav@cern.ch>
// Author: D. Schaefer <schae@cern.ch>
#ifndef METUTILITIES_MET_METSIGNIFICANCE_H
#define METUTILITIES_MET_METSIGNIFICANCE_H 1
 
// STL includes
#include <string>
#include <tuple>
 
// ROOT includes
#include "TH2F.h"
#include "TFile.h"
 
// FrameWork includes
#include "AsgTools/ToolHandle.h"
#include "AsgTools/AsgTool.h"
#include "AsgTools/PropertyWrapper.h"
 
// METInterface includes
#include "METInterface/IMETSignificance.h"
 
// EDM includes
#include "xAODJet/JetContainer.h"
 
// Tool interfaces
#include "InDetTrackSelectionTool/IInDetTrackSelectionTool.h"
#include "EgammaAnalysisInterfaces/IEgammaCalibrationAndSmearingTool.h"
#include "MuonAnalysisInterfaces/IMuonCalibrationAndSmearingTool.h"
#include "JetCalibTools/IJetCalibrationTool.h"
#include "tauRecTools/ITauToolBase.h"
 
namespace met {
 
  // typedefs
  typedef ElementLink<xAOD::IParticleContainer> obj_link_t;
 
  class METSignificance
  : public asg::AsgTool,
  virtual public IMETSignificance
 
  {
    // This macro defines the constructor with the interface declaration
    ASG_TOOL_CLASS(METSignificance, IMETSignificance)
 
  public:
 
    // Copy constructor:

    METSignificance(const std::string& name);

    virtual ~METSignificance();
 
    // Athena algtool's Hooks
    StatusCode  initialize();
    StatusCode  finalize();
 
    StatusCode varianceMET(xAOD::MissingETContainer* metCont, float avgmu, const std::string& jetTermName, const std::string& softTermName, const std::string& totalMETName);
 
    // Rotates the phi direction of the object resolutions & recomputes the MET significance
    StatusCode RotateToPhi(float phi);
    
    // Subtracts the vector lambda from the MET & recomputes the MET signficance in new MET - lambda direction
    StatusCode SetLambda(const float px, const float py, const bool GeV=true);
 
    double GetMETOverSqrtSumET() const { if(m_sumet>0.0)        return (m_met/std::sqrt(m_sumet)); return -1.0; }
    double GetMETOverSqrtHT   () const { if(m_ht>0.0)           return (m_met/std::sqrt(m_ht));    return -1.0; }
    double GetSignificance()     const { if(m_significance>0.0) return std::sqrt(m_significance);  return -1.0; }
    double GetSigDirectional()   const { if(m_VarL>0.0)         return m_met/std::sqrt(m_VarL);    return -1.0; }
    double GetRho()              const { return m_rho;  }
    double GetVarL()             const { return m_VarL; }
    double GetVarT()             const { return m_VarT; }
    double GetTermVarL(const int term) const { if(m_term_VarL.find(term)!=m_term_VarL.end()) return m_term_VarL.find(term)->second; return -1.0e3; }
    double GetTermVarT(const int term) const { if(m_term_VarT.find(term)!=m_term_VarT.end()) return m_term_VarT.find(term)->second; return -1.0e3; }
 
  private:

    METSignificance();
 
    ToolHandle<IJetCalibrationTool>                   m_jetCalibTool {this, "jetCalibTool", "", "the IJetCalibrationTool we use"};
    ToolHandle<CP::IMuonCalibrationAndSmearingTool>   m_muonCalibrationAndSmearingTool {this, "MuonCalibTool", "", "the IMuonCalibrationAndSmearingTool we use"};
    ToolHandle<CP::IEgammaCalibrationAndSmearingTool> m_egammaCalibTool {this, "egammaCalibTool", "", "the IEgammaCalibrationAndSmearingTool we use"};
    ToolHandle<ITauToolBase>                          m_tauCombinedTES {this, "tauCombinedTES", "", "the TauCombinedTES tool we use"};
 
    Gaudi::Property<std::string> m_jetCalibConfig{this, "JetCalibConfig", "", "Config file for jet calibration/resolution"};
    Gaudi::Property<std::string> m_jetCalibSeq{this, "JetCalibSequence", "", "Calibration sequence used for input jets"};
    Gaudi::Property<std::string> m_jetCalibArea{this, "JetCalibArea", "", "CalibArea for input jet calibration"};
    Gaudi::Property<int> m_muonCalibMode{this, "MuonCalibMode", -1, "CalibMode for muon momentum calibration"};
    Gaudi::Property<std::string> m_egESModel{this, "EgammaESModel", "", "ESModel for egamma calibration"};
    Gaudi::Property<std::string> m_egDecorrModel{this, "EgammaDecorrelationModel", "", "Decorrelation model for egamma calibration"};
    Gaudi::Property<bool> m_egUseFastsim{this, "EgammaUseFastsim", false, "Use fastsim resolutions for egamma?"};
    Gaudi::Property<std::string> m_tauTESConfig{this, "TauTESConfig", "CombinedTES_R22_Round2.5_v2.root", "Config file for tau energy scale calibration"};
    Gaudi::Property<bool> m_tauUseMVARes{this, "TauUseMVAResolution", true, "Use MVA resolution for taus?"};
 
 
    StatusCode AddMuon    (const xAOD::IParticle* obj, float &pt_reso, float &phi_reso, float avgmu);
    StatusCode AddElectron(const xAOD::IParticle* obj, float &pt_reso, float &phi_reso, float avgmu);
    StatusCode AddPhoton  (const xAOD::IParticle* obj, float &pt_reso, float &phi_reso);
    StatusCode AddJet     (const xAOD::IParticle* obj, float &pt_reso, float &phi_reso, float &avgmu);
    StatusCode AddTau     (const xAOD::IParticle* obj, float &pt_reso, float &phi_reso);
    void       AddSoftTerm(const xAOD::MissingET* soft,  const TVector3 &met_vect, double (&particle_sum)[2][2]);
 
    double GetPUProb(double jet_eta, double jet_phi,double jet_pt,  double jet_jvt, double jet_fjvt, float avgmu);
    double GetPhiUnc(double jet_eta, double jet_phi,double jet_pt);
    static unsigned int getEtaBin(double jet_eta);
 
    std::tuple<double,double,double> CovMatrixRotation(double var_x, double var_y, double cv_xy, double Phi);
 
    double Significance_LT(double Numerator, double var_parall, double var_perpen, double cov);
 
    void InvertMatrix(double (&mat)[2][2], double (&m)[2][2]);
    void AddMatrix(double (&X)[2][2],double (&Y)[2][2], double (&mat_new)[2][2]);
    void RotateXY(const double (&mat)[2][2], double (&mat_new)[2][2], double phi);
 
    // soft term bias
    double BiasPtSoftdir(const double PtSoft);
    double VarparPtSoftdir(const double PtSoft, const double SoftSumet);
 
    // pthard - parameterization
    double Bias_PtSoftParall(const double PtSoft_Parall);
    double Var_Ptsoft(const double PtSoft);
 
    // Fill Reso map
    void AddResoMap(const double varL, const double varT, const double CvTV, const int term);
 
    double m_GeV;
 
    bool m_jetOK;
    bool m_muonOK;
    bool m_egammaOK;
    bool m_tauOK;
 
    TVector3 m_met_vect;
    TVector3 m_soft_vect;
    TVector3 m_pthard_vect;
    TVector3 m_lamda_vect;
 
    int    m_softTermParam;
    double m_softTermReso;
    bool   m_treatPUJets;
    bool   m_doPhiReso;
    bool   m_applyBias;
    bool   m_jerForEMu;
 
    bool m_isDataJet;
    bool m_isDataMuon;
 
    // set limits
    float m_jetPtThr;
    float m_jetEtaThr;
 
    double m_scalarBias;
    double m_significance;
    double m_rho;
    double m_VarL;
    double m_VarT;
    double m_CvLT;
 
    double m_met_VarL;
    double m_met_VarT;
    double m_met_CvLT;
 
    std::map<int, double> m_term_VarL;
    std::map<int, double> m_term_VarT;
    std::map<int, double> m_term_CvLT;
 
    double m_met;
    double m_metx;
    double m_mety;
    double m_metphi;
    double m_metsoft;
    double m_metsoftphi;
    double m_ht;
    double m_sumet;
 
    // Jet Uncertainties
    TFile *m_file;
    TH2F *m_phi_reso_pt20;
    TH2F *m_phi_reso_pt50;
    TH2F *m_phi_reso_pt100;
 
    std::string m_configPrefix;
    std::string m_configJetPhiResoFile;
    std::string m_JetResoAux;
    std::string m_EMuResoAux;
    std::string m_JetCollection;
 
  };
 
} //> end namespace met
#endif //> !METUTILITIES_MET_METSIGNIFICANCE_H