TauEfficiencyCorrectionsTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TAUANALYSISTOOLS_TAUEFFICIENCYCORRECTIONSTOOL_H
#define TAUANALYSISTOOLS_TAUEFFICIENCYCORRECTIONSTOOL_H
 
/*
  author: Dirk Duschinger
  maintainer: Guillermo Hamity
  mail: guillermo.nicolas.hamity@cern.ch
  documentation in: ../README.rst
                    https://gitlab.cern.ch/atlas/athena/-/blob/main/PhysicsAnalysis/TauID/TauAnalysisTools/README.rst
*/
 
// Framework include(s):
#include "AsgTools/AsgMetadataTool.h"
#include "AsgTools/AnaToolHandle.h"
#include "AsgTools/PropertyWrapper.h"
 
// Local include(s):
#include "TauAnalysisTools/ITauEfficiencyCorrectionsTool.h"
#include "TauAnalysisTools/CommonEfficiencyTool.h"
 
// Tool include(s)
#include "AsgAnalysisInterfaces/IPileupReweightingTool.h"
 
namespace TauAnalysisTools
{
 
class TauEfficiencyCorrectionsTool
  : public virtual ITauEfficiencyCorrectionsTool
  , public asg::AsgMetadataTool
{
  ASG_TOOL_CLASS( TauEfficiencyCorrectionsTool, TauAnalysisTools::ITauEfficiencyCorrectionsTool )
 
public:
  TauEfficiencyCorrectionsTool( const std::string& sName );
 
  ~TauEfficiencyCorrectionsTool();

  virtual StatusCode initialize();
 
  virtual StatusCode beginInputFile();

  virtual void printConfig() const;

  virtual CP::CorrectionCode getEfficiencyScaleFactor( const xAOD::TauJet& xTau,
      double& eff, unsigned int iRunNumber = 0);

  virtual CP::CorrectionCode applyEfficiencyScaleFactor( const xAOD::TauJet& xTau,
      unsigned int iRunNumber = 0);

  virtual bool isAffectedBySystematic( const CP::SystematicVariation& systematic ) const;

  virtual CP::SystematicSet affectingSystematics() const;

  virtual CP::SystematicSet recommendedSystematics() const;
 
  virtual StatusCode applySystematicVariation( const CP::SystematicSet& systConfig );
 
  virtual bool isSupportedRunNumber( int /*iRunNumber*/ ) const
  {
    return true;
  };
 
private:
  StatusCode firstEvent();
  StatusCode beginEvent();
 
  std::string ConvertJetIDToString(const int iLevel) const;
 
  std::string ConvertEleIDToString(const int iLevel) const;
 
  std::string ConvertTriggerIDToString(const int iLevel) const;
 
  std::string GetTriggerSFMeasurementString() const;
 
  StatusCode initializeTools_2022_prerec();
  StatusCode initializeTools_2025_prerec(); 
 
  StatusCode readRandomRunNumber();
 
private:
 
  Gaudi::Property<std::string> m_sInputFilePathRecoHadTau{this, "InputFilePathRecoHadTau", ""};
  Gaudi::Property<std::string> m_sInputFilePathEleIDHadTau{this, "InputFilePathEleIDHadTau", ""};
  Gaudi::Property<std::string> m_sInputFilePathEleIDElectron{this, "InputFilePathEleIDElectron", ""};
  Gaudi::Property<std::string> m_sInputFilePathJetIDHadTau{this, "InputFilePathJetIDHadTau", ""};  
  Gaudi::Property<std::string> m_sInputFilePathTriggerHadTau{this, "InputFilePathTriggerHadTau", ""};   
  Gaudi::Property<std::string> m_sRecommendationTag{this, "RecommendationTag", "2025-prerec"};
  Gaudi::Property<std::string> m_sTriggerName{this, "TriggerName", ""};
  Gaudi::Property<bool> m_bReadRandomRunNumber{this, "AutoTriggerYear", false}; 
  Gaudi::Property<std::string> m_sTriggerSFMeasurement{this, "TriggerSFMeasurement", "combined"}; 
  Gaudi::Property<bool> m_bUseTauSubstructure{this, "UseTauSubstructure", false}; 
  Gaudi::Property<int> m_iJetIDLevel{this, "JetIDLevel", static_cast<int>(JETIDNONE)}; 
  Gaudi::Property<int> m_iEleIDLevel{this, "EleIDLevel", static_cast<int>(ELEIDNONE)};
  Gaudi::Property<std::string> m_sCampaign{this, "Campaign", ""};
  Gaudi::Property<bool> m_useFastSim{this, "useFastSim", false};
  Gaudi::Property<bool> m_bSkipTruthMatchCheck{this, "SkipTruthMatchCheck", false};
  Gaudi::Property<std::vector<int>> m_vecEfficiencyCorrectionTypes{this, "EfficiencyCorrectionTypes", {}};
 
  std::vector<int> m_vEfficiencyCorrectionTypes;
  std::vector< asg::AnaToolHandle<ITauEfficiencyCorrectionsTool>* > m_vCommonEfficiencyTools;
  std::vector< asg::AnaToolHandle<ITauEfficiencyCorrectionsTool>* > m_vTriggerEfficiencyTools;
  std::string m_sInputFilePathDecayModeHadTau;
  std::string m_sVarName;
  bool m_bIsData;
  bool m_bIsConfigured;
  bool m_firstEvent = false;
  unsigned int m_iRunNumber;
 
}; // class TauEfficiencyCorrectionsTool
 
} // namespace TauAnalysisTools
 
#endif // TAUANALYSISTOOLS_TAUEFFICIENCYCORRECTIONSTOOL_H