JSSTaggerBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef BOOSTEDJETSTAGGERS_JSSTAGGERBASE_H
#define BOOSTEDJETSTAGGERS_JSSTAGGERBASE_H
 
#include "AsgTools/AsgTool.h"
#include "AsgTools/AnaToolHandle.h"
 
#include "JetInterface/IJetDecorator.h"
 
#include "xAODJet/Jet.h"
#include "xAODJet/JetContainer.h"
#include "xAODJet/JetAuxContainer.h"
#include "xAODTruth/TruthParticleContainer.h"
#include "xAODTracking/VertexContainer.h"
#include "xAODEventInfo/EventInfo.h"
 
#include "BoostedJetTaggers/TagResultEnum.h"
 
#include "PATCore/AcceptData.h"
 
#include "PathResolver/PathResolver.h"
 
#include "AsgDataHandles/WriteDecorHandle.h"
#include "AsgDataHandles/ReadDecorHandle.h"
#include "AsgDataHandles/ReadDecorHandleKey.h"
 
#include <TFile.h>
#include <TEnv.h>
#include <TH2.h>
#include <TF1.h>
 
#include <atomic>
 
class JSSTaggerBase :   public asg::AsgTool ,
  virtual public IJetDecorator
{
  ASG_TOOL_CLASS1(JSSTaggerBase, IJetDecorator )
 
  public:
 
    virtual StatusCode initialize() override;
 
    virtual StatusCode decorate( const xAOD::JetContainer& jets ) const override;
 
  protected:
 
    JSSTaggerBase(const std::string &name);
 
    ~JSSTaggerBase() {};
 
    virtual StatusCode tag( const xAOD::Jet& jet ) const = 0;
 
    TEnv m_configReader;
 
    asg::AcceptInfo m_acceptInfo;
 
    // Wro
    SG::ReadHandleKey<xAOD::JetContainer> m_jetContainer_key{this, "JetContainer", "AntiKt10UFOCSSKSoftDropBeta100Zcut10Jets", "SG key for input jet container"};
 
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decTaggedKey{this, "TaggedName", "Tagged", "SG key for Tagged"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decValidPtRangeHighKey{this, "ValidPtRangeHighName", "ValidPtRangeHigh", "SG key for ValidPtRangeHigh"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decValidPtRangeLowKey{this, "ValidPtRangeLowName", "ValidPtRangeLow", "SG key for ValidPtRangeLow"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decValidEtaRangeKey{this, "ValidEtaRangeName", "ValidEtaRange", "SG key for ValidEtaRange"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decValidKinRangeKey{this, "ValidKinRangeName", "ValidKinRange", "SG key for ValidKinRange"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decValidJetContentKey{this, "ValidJetContentName", "ValidJetContent", "SG key for ValidJetContent"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decValidEventContentKey{this, "ValidEventContentName", "ValidEventContent", "SG key for ValidEventContent"};
 
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decPassMassKey{this, "PassMassName", "PassMass", "SG key for PassMass"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decPassScoreKey{this, "PassScoreName", "PassScore", "SG key for PassScore"};
 
    const int m_nWarnMax = 10;
 
    mutable std::atomic<int> m_nWarnVar;
 
    bool m_ptGeV = false;
 
    bool m_useMassCut = false;
 
    bool m_useScoreCut = false;
 
    enum TAGCLASS{Unknown, WBoson, ZBoson, TopQuark};
    TAGCLASS m_tagClass;
 
 
    std::string m_containerName;
 
    std::string m_weightConfigPath;
 
    std::string m_configFile;
 
    std::string m_calibArea;
 
    std::string m_kerasConfigFileName;
    std::string m_kerasConfigFilePath;
    std::string m_kerasConfigOutputName;
    std::string m_kerasCalibArea;
 
    std::string m_tmvaConfigFileName;
    std::string m_tmvaConfigFilePath;
    std::string m_tmvaCalibArea;
 
    std::string m_wkpt;
    std::string m_tagType;
 
    float m_jetPtMin;
    float m_jetPtMax;
    float m_jetEtaMax;
 
    bool m_useECFG = false;
    bool m_useLSeries = false;
 
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decTau21WTAKey{this, "Tau21WTANameOut", "Tau21_wta", "SG key for Tau21_wta"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decTau32WTAKey{this, "Tau32WTANameOut", "Tau32_wta", "SG key for Tau32_wta"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decTau42WTAKey{this, "Tau42WTANameOut", "Tau42_wta", "SG key for Tau42_wta"};
 
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decC2Key{this, "C2NameOut", "C2", "SG key for C2"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decD2Key{this, "D2NameOut", "D2", "SG key for D2"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decE3Key{this, "e3NameOut", "e3", "SG key for e3"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decL2Key{this, "L2NameOut", "L2", "SG key for L2"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decL3Key{this, "L3NameOut", "L3", "SG key for L3"};
 
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readTau1WTAKey{this, "Tau1WTAName", "Tau1_wta", "SG key for Tau1_wta"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readTau2WTAKey{this, "Tau2WTAName", "Tau2_wta", "SG key for Tau2_wta"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readTau3WTAKey{this, "Tau3WTAName", "Tau3_wta", "SG key for Tau3_wta"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readTau4WTAKey{this, "Tau4WTAName", "Tau4_wta", "SG key for Tau4_wta"};
 
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readTau21WTAKey{this, "Tau21WTAName", "Tau21_wta", "SG key for Tau21_wta"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readTau32WTAKey{this, "Tau32WTAName", "Tau32_wta", "SG key for Tau32_wta"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readTau42WTAKey{this, "Tau42WTAName", "Tau42_wta", "SG key for Tau42_wta"};
 
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readECF1Key{this, "ECF1Name", "ECF1", "SG key for ECF1"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readECF2Key{this, "ECF2Name", "ECF2", "SG key for ECF2"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readECF3Key{this, "ECF3Name", "ECF3", "SG key for ECF3"};
 
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readC2Key{this, "C2Name", "C2", "SG key for C2"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readD2Key{this, "D2Name", "D2", "SG key for D2"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readE3Key{this, "e3Name", "e3", "SG key for e3"};
 
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readSplit12Key{this, "Split12Name", "Split12", "SG key for Split12"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readSplit23Key{this, "Split23Name", "Split23", "SG key for Split23"};
 
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readQwKey{this, "QwName", "Qw", "SG key for Qw"};
 
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readThrustMajKey{this, "ThrustMajName", "ThrustMaj", "SG key for ThrustMaj"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readSphericityKey{this, "SphericityName", "Sphericity", "SG key for Sphericity"};
 
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readL2Key{this, "L2Name", "L2", "SG key for L2"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readL3Key{this, "L3Name", "L3", "SG key for L3"};
 
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readECFG331Key{this, "ECFG331Name", "ECFG_3_3_1", "SG key for ECFG_3_3_1"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readECFG311Key{this, "ECFG311Name", "ECFG_3_1_1", "SG key for ECFG_3_1_1"};
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readECFG212Key{this, "ECFG212Name", "ECFG_2_1_2", "SG key for ECFG_2_1_2"};
 
    SG::ReadDecorHandleKey<xAOD::JetContainer>  m_readParentKey{this, "ParentName", "Parent", "SG key for Parent"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decNtrk500Key{this, "Ntrk500NameOut", "ParentJetNTrkPt500", "SG key for Ntrk500 from ungroomed jet"};
    SG::ReadDecorHandleKey<xAOD::JetContainer>  m_readNtrk500Key{this, "Ntrk500Name", "ParentJetNTrkPt500", "SG key for Ntrk500 from ungroomed jet"};
 
    bool m_suppressOutputDependence;
 
    std::string m_strMassCutLow;
    std::string m_strMassCutHigh;
    std::string m_strScoreCut;
 
    std::unique_ptr<TF1> m_funcMassCutLow;
    std::unique_ptr<TF1> m_funcMassCutHigh;
    std::unique_ptr<TF1> m_funcScoreCut;
 
    std::string m_decorationName;
 
    bool m_calcSF;
    bool m_isMC;
 
    std::string m_weightDecorationName;
    std::string m_weightFileName;
    std::string m_weightHistogramName;
    std::string m_efficiencyHistogramName;
    std::string m_weightFlavors;
 
    std::unique_ptr<TFile> m_weightConfig;
    std::map<std::string, std::unique_ptr<TH2D>> m_weightHistograms;
    std::map<std::string, std::unique_ptr<TH2D>> m_efficiencyHistograms;
 
    bool m_truthLabelUseTRUTH3;
    std::string m_truthParticleContainerName;
    std::string m_truthBosonContainerName;
    std::string m_truthTopQuarkContainerName;
    std::string m_truthLabelName;
 
    SG::ReadDecorHandleKey<xAOD::JetContainer> m_readTruthLabelKey{this, "truthLabelName", "truthLabel", "SG key for truthLabel"};
 
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decCutMLowKey{this, "CutMLowName", "Cut_mlow", "SG key for Cut_mlow"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decCutMHighKey{this, "CutMHighName", "Cut_mhigh", "SG key for Cut_mhigh"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decScoreCutKey{this, "CutScoreName", "Cut_score", "SG key for Cut_score"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decScoreValueKey{this, "ScoreName", "Score", "SG key for Score"};
 
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decWeightKey{this, "weightName", "weight", "SG key for weight"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decEfficiencyKey{this, "efficiencyName", "efficiency", "SG key for efficiency"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decEffSFKey{this, "effSFName", "effSF", "SG key for effSF"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_decSigeffSFKey{this, "sigeffSFName", "sigeffSF", "SG key for effSF"};
 
 
    StatusCode getConfigReader();
 
    StatusCode resetCuts( asg::AcceptData &acceptData ) const;
 
    bool passKinRange( const xAOD::Jet &jet ) const;
 
    StatusCode checkKinRange( const xAOD::Jet &jet, asg::AcceptData &acceptData ) const;
 
    int calculateJSSRatios( const xAOD::Jet &jet ) const;
 
    int findPV() const;
 
    StatusCode GetUnGroomTracks( const xAOD::Jet &jet , int indexPV) const;
 
    StatusCode getWeight( const xAOD::Jet& jet, bool passSel, asg::AcceptData &acceptData ) const;
 
    std::pair<double,double> getSF( const xAOD::Jet& jet, const std::string& truthLabelStr ) const;
    std::string getTruthLabelStr( const xAOD::Jet& jet, asg::AcceptData &acceptData ) const;
 
    void printCuts() const;
 
};
 
#endif