CommonSmearingTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TAUANALYSISTOOLS_COMMONSMEARINGTOOL_H
#define TAUANALYSISTOOLS_COMMONSMEARINGTOOL_H
 
/*
  author: Dirk Duschinger
  mail: dirk.duschinger@cern.ch
  documentation in: ../README.rst
*/
 
// Framework include(s):
#include "AsgTools/AsgMetadataTool.h"
#include "AsgTools/AnaToolHandle.h"
#include "AsgTools/PropertyWrapper.h"
 
// EDM include(s):
#include "xAODTau/TauJet.h"
#include "xAODTruth/TruthParticle.h"
#include "PATInterfaces/CorrectionCode.h"
 
#include "tauRecTools/TauCombinedTES.h"
 
// Local include(s):
#include "TauAnalysisTools/Enums.h"
#include "TauAnalysisTools/ITauSmearingTool.h"
#include "TauAnalysisTools/HelperFunctions.h"
 
// tauRecTools include(s)
#include "tauRecTools/ITauToolBase.h"
#include <map>
 
class TFile;
 
namespace TauAnalysisTools
{
 
class CommonSmearingTool
  : public virtual ITauSmearingTool
  , public asg::AsgMetadataTool
{
  ASG_TOOL_CLASS( CommonSmearingTool, TauAnalysisTools::ITauSmearingTool )
 
public:
 
  CommonSmearingTool(const std::string& sName);
 
  ~CommonSmearingTool();
 
  virtual StatusCode initialize();
 
  // CommonSmearingTool pure virtual public functionality
  //__________________________________________________________________________

  virtual CP::CorrectionCode applyCorrection( xAOD::TauJet& xTau ) const;

  virtual CP::CorrectionCode correctedCopy( const xAOD::TauJet& xTau,
      xAOD::TauJet*& xTauCopy) const;

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

  virtual CP::SystematicSet affectingSystematics() const;

  virtual CP::SystematicSet recommendedSystematics() const;

  virtual StatusCode applySystematicVariation ( const CP::SystematicSet& sSystematicSet);
 
protected:
 
  std::string ConvertProngToString(const int iProngness) const;
 
  std::map<std::string, TH1*> m_mSF;
  std::unordered_map < CP::SystematicSet, std::string > m_mSystematicSets;
  const CP::SystematicSet* m_sSystematicSet;
  std::map<std::string, int> m_mSystematics;
  std::map<std::string, std::string> m_mSystematicsHistNames;
 
  // std::function<double> m_fX;
  double (*m_fX)(const xAOD::TauJet& xTau);
  double (*m_fY)(const xAOD::TauJet& xTau);
 
  template<class T>
  void ReadInputs(TFile* fFile, std::map<std::string, T>& mMap);
 
  virtual CP::CorrectionCode getValue(const std::string& sHistName,
                                      const xAOD::TauJet& xTau,
                                      double& dEfficiencyScaleFactor) const;
 
  void generateSystematicSets();
 
  Gaudi::Property<std::string> m_sInputFilePath{this, "InputFilePath", ""};
  Gaudi::Property<bool> m_bSkipTruthMatchCheck{this, "SkipTruthMatchCheck", false};
  Gaudi::Property<bool> m_bApplyFading{this, "ApplyFading", true};
  Gaudi::Property<bool> m_bMVATESQualityCheck{this, "MVATESQualityCheck", true};
  Gaudi::Property<bool> m_bApplyInsituCorrection{this, "ApplyInsituCorrection", true};  
 
  bool m_bIsData;
  bool m_bIsConfigured;
 
  asg::AnaToolHandle<ITauToolBase> m_tTauCombinedTES;
 
  TruthMatchedParticleType m_eCheckTruth;
  CP::SystematicSet m_sAffectingSystematics;
  CP::SystematicSet m_sRecommendedSystematics;
  
private:
 
  CxxUtils::CachedValue<bool> m_bIsTESCompatibilityCheckAvailable; 
 
  // Execute at each event
  virtual StatusCode beginEvent();
 
};
} // namespace TauAnalysisTools
 
#endif // TAUANALYSISTOOLS_COMMONSMEARINGTOOL_H