TauSelectionTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TAUANALYSISTOOLS_TAUSELECTIONTOOL_H
#define TAUANALYSISTOOLS_TAUSELECTIONTOOL_H
 
/*
  author: Dirk Duschinger
  mail: dirk.duschinger@cern.ch
*/
 
// Framework include(s):
#include "AsgTools/AsgMetadataTool.h"
#include "AsgTools/AnaToolHandle.h"
#include "AsgTools/PropertyWrapper.h"
#include "PATCore/IAsgSelectionTool.h"
#include "AsgDataHandles/ReadHandleKey.h"
#include "AsgDataHandles/ReadDecorHandleKey.h"
 
// Local include(s):
#include "TauAnalysisTools/ITauSelectionTool.h"
#include "TauAnalysisTools/Enums.h"
#include "TauAnalysisTools/HelperFunctions.h"
#include "TauAnalysisTools/SharedFilesVersion.h"
 
// EDM include(s):
#include "xAODMuon/MuonContainer.h"
#include "xAODTau/TauJetContainer.h"
 
// ROOT include(s):
#include "TH1F.h"
#include "TFile.h"
 
namespace TauAnalysisTools
{

class TauSelectionCut;
class TauSelectionCutPt;
class TauSelectionCutAbsEta;
class TauSelectionCutAbsCharge;
class TauSelectionCutNTracks;
class TauSelectionCutJetIDWP;
class TauSelectionCutRNNJetScoreSigTrans;
class TauSelectionCutGNTauScoreSigTrans;
class TauSelectionCutRNNEleScoreSigTrans;
class TauSelectionCutEleIDWP;
class TauSelectionCutMuonOLR;
 
 
class TauSelectionTool : public virtual IAsgSelectionTool,
  public virtual ITauSelectionTool,
  public asg::AsgMetadataTool
{
  friend class TauSelectionCut;
  friend class TauSelectionCutPt;
  friend class TauSelectionCutAbsEta;
  friend class TauSelectionCutAbsCharge;
  friend class TauSelectionCutNTracks;
  friend class TauSelectionCutJetIDWP;
  friend class TauSelectionCutRNNJetScoreSigTrans;
  friend class TauSelectionCutGNTauScoreSigTrans;
  friend class TauSelectionCutRNNEleScoreSigTrans;
  friend class TauSelectionCutEleIDWP;
  friend class TauSelectionCutMuonOLR;

  ASG_TOOL_CLASS2( TauSelectionTool,
                   IAsgSelectionTool,
                   TauAnalysisTools::ITauSelectionTool )
 
  // declaration of classes as friends to access private member variables
  friend class TauEfficiencyCorrectionsTool;
 
public:
  TauSelectionTool( const std::string& name );
 
  virtual ~TauSelectionTool();

  virtual StatusCode initialize() override;

  virtual const asg::AcceptInfo& getAcceptInfo() const override;

  virtual asg::AcceptData accept( const xAOD::IParticle* p ) const override;

  virtual asg::AcceptData accept( const xAOD::TauJet& tau ) const override;

  virtual void setOutFile( TFile* fOutFile ) override;

  virtual void writeControlHistograms() override;
 
private:
 
  // Execute at each event
  virtual StatusCode beginEvent() override;
 
  template<typename T, typename U>
  void FillRegionVector(std::vector<T>& vRegion, U tMin, U tMax) const;
  template<typename T, typename U>
  void FillValueVector(std::vector<T>& vRegion, U tVal) const;
  template<typename T>
  void PrintConfigRegion(const std::string& sCutName, std::vector<T>& vRegion) const;
  template<typename T>
  void PrintConfigValue(const std::string& sCutName, std::vector<T>& vRegion) const;
  template<typename T>
  void PrintConfigValue(const std::string& sCutName, T& sVal) const;
 
  // vector of transverse momentum cut regions
  std::vector<float> m_vPtRegion;
  // vector of absolute eta cut regions
  std::vector<float> m_vAbsEtaRegion;
  // vector of absolute charge requirements
  std::vector<int> m_vAbsCharges;
  // vector of number of track requirements
  std::vector<unsigned> m_vNTracks;
  // vector of JetRNNSigTrans cut regions
  std::vector<float> m_vJetRNNSigTransRegion;
  // vector of GNTauSigTrans cut regions
  std::vector<float> m_vGNTauSigTransRegion;
  // JetID working point
  std::string m_sJetIDWP;
  bool m_useGNTau=false;
  // vector of EleRNN cut regions
  std::vector<float> m_vEleRNNSigTransRegion;
  // EleID working point
  std::string m_sEleIDWP;
 
  // properties
  Gaudi::Property<int> m_iSelectionCuts{this, "SelectionCuts", NoCut}; 
  Gaudi::Property<float> m_dPtMin{this, "PtMin", NAN};
  Gaudi::Property<float> m_dAbsEtaMin{this, "AbsEtaMin", NAN};
  Gaudi::Property<float> m_dAbsEtaMax{this, "AbsEtaMax", NAN};
  Gaudi::Property<float> m_iAbsCharge{this, "AbsCharge", NAN}; 
  Gaudi::Property<float> m_dJetRNNSigTransMin{this, "JetRNNSigTransMin", NAN};
  Gaudi::Property<float> m_dGNTauSigTransMin{this, "GNTauSigTransMin", NAN};
  Gaudi::Property<float> m_iNTrack{this, "NTrack", NAN};
  Gaudi::Property<float> m_dEleRNNSigTransMin{this, "EleRNNSigTransMin", NAN};
  Gaudi::Property<int> m_iJetIDWP{this, "JetIDWP", 1}; // this corresponds to JETIDNONE
  Gaudi::Property<int> m_iEleIDWP{this, "EleIDWP", 0};
  Gaudi::Property<int> m_iEleIDVersion{this, "EleIDVersion", 1};
  Gaudi::Property<bool> m_bMuonOLR{this, "MuonOLR", false};
 
  Gaudi::Property<std::vector<float>> m_vecAbsEtaRegion{this, "AbsEtaRegion",{}};
  Gaudi::Property<std::vector<int>> m_vecAbsCharges{this, "AbsCharges", {}};
  Gaudi::Property<std::vector<unsigned>> m_vecNTracks{this, "NTracks", {}};
 
protected:
  TFile* m_fOutFile;
  std::shared_ptr<TH1F> m_hCutFlow;
 
private:
 
  Gaudi::Property<std::string> m_sConfigPath{this, "ConfigPath", "TauAnalysisTools/"+std::string(sSharedFilesVersion)+"/Selection/recommended_selection_r22.conf"};  
  SG::ReadHandleKey<xAOD::MuonContainer> m_muonContainerKey {this, "MuonContainerName", "Muons", "Muon container name"};
  SG::ReadHandleKey<xAOD::TauJetContainer> m_tauContainerKey {this, "TauContainerName", "TauJets", "Tau container name"};
  SG::ReadDecorHandleKey<xAOD::TauJetContainer> m_eVetoDecorKey {this, "eVetoDecorName", "", "Name of eVeto decoration"};
  SG::ReadDecorHandleKey<xAOD::TauJetContainer> m_GNTauDecorKey {this, "GNTauDecorName", "", "Name of GnTauID decoration"};
 
  std::map<SelectionCuts, std::unique_ptr<TauAnalysisTools::TauSelectionCut>> m_cMap;
 
  void setupCutFlowHistogram();
  int convertStrToJetIDWP(const std::string& sJetIDWP) const;
  int convertStrToEleIDWP(const std::string& sEleIDWP) const;
 
protected:
 
  Gaudi::Property<bool> m_bCreateControlPlots{this, "CreateControlPlots", false};

  asg::AcceptInfo m_aAccept;
 
 
}; // class TauSelectionTool
 
} // namespace TauAnalysisTools
 
#endif // TAUANALYSISTOOLS_TAUSELECTIONTOOL_H