MuonTriggerScaleFactors.h

Go to the documentation of this file.

/*
 Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
 */
 
#ifndef MUONTRIGGERSCALEFACTORS_H_
#define MUONTRIGGERSCALEFACTORS_H_
 
#include "MuonAnalysisInterfaces/IMuonTriggerScaleFactors.h"
#include "AsgTools/AsgTool.h"
#include "AsgTools/PropertyWrapper.h"
#include "AsgDataHandles/ReadHandleKey.h"
#include "xAODEventInfo/EventInfo.h"
 
#include "TDirectory.h"
 
#include <map>
#include <memory>
#include <string>
#include <unordered_map>
#include <ColumnarMode/ColumnarMode.h>
 
class TH1;
 
namespace ADD_CMODE(CP) {
    typedef std::shared_ptr<TH1> TH1_Ptr;
 
    class MuonTriggerScaleFactors: virtual public CP::IMuonTriggerScaleFactors, public asg::AsgTool {
            ASG_TOOL_CLASS( MuonTriggerScaleFactors, CP::IMuonTriggerScaleFactors )
 
            public:
 
            MuonTriggerScaleFactors(const std::string& name);
 
            virtual ~MuonTriggerScaleFactors();
 
            virtual StatusCode initialize(void);
 
            // for single lepton triggers
            virtual CP::CorrectionCode getTriggerScaleFactor(const xAOD::MuonContainer& mucont, Double_t& triggersf, const std::string& trigger) const;
 
            virtual CP::CorrectionCode getTriggerScaleFactor(const xAOD::Muon& muon, Double_t& triggersf, const std::string& trigger) const;
 
            virtual CP::CorrectionCode getTriggerEfficiency(const xAOD::Muon& mu, Double_t& efficiency, const std::string& trigger, Bool_t dataType) 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& systConfig);
 
            virtual int getBinNumber(const xAOD::Muon& muon, const std::string& trigger) const;
 
            virtual int getReplica_index(const std::string& sysBaseName, const std::string& trigStr) const;

            virtual bool isTriggerSupported(const std::string& trigger) const;
        private:
 
            virtual CP::CorrectionCode getMuonEfficiency(Double_t& eff, const TrigMuonEff::Configuration& configuration, const xAOD::Muon& muon, const std::string& trigger, const std::string& systematic) const;
 
            virtual CP::CorrectionCode GetTriggerSF_dimu(Double_t& TriggerSF, TrigMuonEff::Configuration& configuration, const xAOD::MuonContainer& mucont, const std::string& trigger) const;
 
            virtual CP::CorrectionCode GetTriggerSF(Double_t& TriggerSF, TrigMuonEff::Configuration& configuration, const xAOD::MuonContainer& mucont, const std::string& trigger) const;
 
            virtual CP::CorrectionCode GetTriggerSF(Double_t& TriggerSF, TrigMuonEff::Configuration& configuration, const xAOD::Muon& muon, const std::string& trigger) const;
 
            virtual CP::CorrectionCode getDimuonEfficiency(Double_t& eff, const TrigMuonEff::Configuration& configuration, const xAOD::MuonContainer& mucont, const std::string& chain, const std::string& systematic) const;
 
            const CP::SystematicSet& appliedSystematics() const {
                return *m_appliedSystematics;
            }
 
            StatusCode registerSystematics();
 
            StatusCode LoadTriggerMap(unsigned int year);
 
            //This function is needed during initialization to parse the histograms to the cache
            unsigned int encodeHistoName(const std::string_view period, const std::string& Trigger, bool isData, const std::string& Systematic, bool isBarrel = true) const;
            //This function is the equivalent during run time to retrieve the histograms from the cache
            unsigned int encodeHistoName(const std::string& Trigger, const TrigMuonEff::Configuration& configuration, const std::string& Systematic, bool isBarrel = true) const;
        protected:
            virtual std::shared_ptr<TH1> getEfficiencyHistogram(unsigned int year, const std::string_view period, const std::string& trigger, bool isData, const std::string& Systematic, bool isBarrel = true) const;
            virtual std::shared_ptr<TH1> getEfficiencyHistogram(const std::string& trigger, bool isData, const std::string& Systematic, bool isBarrel = true) const;
        private:
            typedef std::pair<unsigned int, std::string> YearPeriod;
            typedef std::pair<YearPeriod, unsigned int> EffiHistoIdent;
            typedef std::map<EffiHistoIdent, TH1_Ptr> EfficiencyMap;
 
            CP::CorrectionCode getThreshold(Int_t& threshold, const std::string& trigger) const;
 
            std::string getTriggerCorrespondingToDimuonTrigger(const std::string& trigger) const;
        protected:
 
            const std::string_view getDataPeriod() const;
            unsigned int getRunNumber() const;
            unsigned int getYear(unsigned int run) const;
            const std::string_view getDataPeriod(unsigned int run) const;
            const std::string_view getDataPeriod(unsigned int runNumber, unsigned int year) const;
       private:
            SG::ReadHandleKey<xAOD::EventInfo> m_eventInfo{this, "EventInfoContName", "EventInfo", "event info key"};
 
            TDirectory* getTemporaryDirectory(void) const;
 
            //Generate replicas of h for Toys with each bin of h varied with Gaussian distribution
            //with mean from bin content and sigma from bin error
            std::vector<TH1_Ptr> generateReplicas(TH1_Ptr h, int nrep, int seed) const;
 
            std::unordered_map<CP::SystematicSet, CP::SystematicSet> m_systFilter;
 
            CP::SystematicSet *m_appliedSystematics{};
            EfficiencyMap m_efficiencyMap;
            std::map<EffiHistoIdent, std::vector<TH1_Ptr> > m_efficiencyMapReplicaArray;
 
            Gaudi::Property<std::string> m_muonQuality {this, "MuonQuality", "Medium", "the muon quality to get the scale factors for"};
            Gaudi::Property<std::string> m_campaign {this, "Campaign", "", "the MC campaign to get the scale factors for"};
 
            // subfolder to load from the calibration db
            Gaudi::Property<std::string> m_calibrationVersion {this, "CalibrationVersion", "261003_FallUpdate", "the calibration version to use"};
            Gaudi::Property<std::string> m_customInputFolder {this, "CustomInputFolder", "", "the custom input folder to use (debugging only)"};
            Gaudi::Property<std::map<unsigned int, std::string>> m_customInputFilePerYear {this, "CustomInputFilePerYear", {}, "the custom input file to use per year (debugging only)"};
            Gaudi::Property<std::string> m_binning {this, "Binning", "fine", "the binning to use"};
 
            Gaudi::Property<bool> m_allowZeroSF {this, "AllowZeroSF", false, "if a trigger is not available will return 0 instead of throwing an error. More difficult to spot configuration issues. Use at own risk"};
            Gaudi::Property<bool> m_experimental {this, "UseExperimental", false, "enable experimental features like single muon SF"};
            Gaudi::Property<int> m_forceYear {this, "ForceYear", -1, "Only for developers. Never use this in any analysis!!!!!!"};
            Gaudi::Property<std::string> m_forcePeriod {this, "ForcePeriod", "", "Only for developers. Never use this in any analysis!!!!!!"};
 
            // Variables for toy replicas setup
            Gaudi::Property<std::vector<std::string>> m_replicaTriggerList {this, "ReplicaTriggerList", {}, "List of triggers on which we want to generate stat. uncertainty toy replicas."};
            std::set<std::string> m_replicaSet; // set of triggers for replicas, for fast searching
            Gaudi::Property<int> m_nReplicas {this, "NReplicas", 100, "Number of generated toy replicas, if replicas are required."};
            Gaudi::Property<int> m_ReplicaRandomSeed {this, "ReplicaRandomSeed", 12345, "Random seed for toy replica generation."};
 
            // Map connecting run and year:
            static const std::map<unsigned short int, std::vector< std::tuple<unsigned int,unsigned int,std::string_view> > > m_year_periods;
    };
 
}
 
#endif