MuonEfficiencyScaleFactors.h

Go to the documentation of this file.

/*
 Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
 */
 
#ifndef MUONEFFICIENCYSCALEFACTORS_H_
#define MUONEFFICIENCYSCALEFACTORS_H_
 
#include "MuonAnalysisInterfaces/IMuonEfficiencyScaleFactors.h"
#include "MuonEfficiencyCorrections/MuonEfficiencyType.h"
#include "MuonEfficiencyCorrections/EfficiencyScaleFactor.h"
#include "MuonEfficiencyCorrections/EffiCollection.h"
 
#include "AsgTools/ToolHandle.h"
#include "AsgTools/AsgTool.h"
#include "AsgDataHandles/ReadHandleKey.h"
#include "xAODEventInfo/EventInfo.h"
 
#include "ColumnarCore/ColumnarTool.h"
#include "ColumnarCore/ColumnAccessor.h"
#include "ColumnarCore/ObjectColumn.h"
#include "ColumnarEventInfo/EventInfoHelpers.h"
#include "ColumnarMuon/MuonDef.h"
 
#include <string>
#include <memory>
#include <map>
#include <unordered_map>
namespace CP {
    class MuonEfficiencyScaleFactors: virtual public CP::IMuonEfficiencyScaleFactors, public asg::AsgTool, public columnar::ColumnarTool<>{
 
        public:
            MuonEfficiencyScaleFactors(const std::string& name);
 
            virtual ~MuonEfficiencyScaleFactors();
            //Proper constructor for Athena
            ASG_TOOL_CLASS3( MuonEfficiencyScaleFactors, CP::IMuonEfficiencyScaleFactors, CP::ISystematicsTool, CP::IReentrantSystematicsTool )
 
            
            virtual StatusCode initialize() override;

            virtual CorrectionCode getEfficiencyScaleFactor(const xAOD::Muon& mu, float& sf, const xAOD::EventInfo* info = 0) const override;
            CorrectionCode getEfficiencyScaleFactor(columnar::MuonId mu, float& sf, columnar::EventInfoId info) const;
            virtual CorrectionCode applyEfficiencyScaleFactor(const xAOD::Muon& mu, const xAOD::EventInfo* info = 0) const override;
            virtual CorrectionCode getEfficiencyScaleFactorReplicas(const xAOD::Muon& mu, std::vector<float> & sf_err, const xAOD::EventInfo* info = 0) const override;
            virtual CorrectionCode applyEfficiencyScaleFactorReplicas(const xAOD::Muon& mu, int nreplicas = 50, const xAOD::EventInfo* info = 0) const override;

            virtual bool isAffectedBySystematic(const SystematicVariation& systematic) const override;

            virtual SystematicSet affectingSystematics() const override;

            virtual SystematicSet recommendedSystematics() const override;
 
            virtual StatusCode applySystematicVariation(const SystematicSet& systConfig) override;

            virtual CorrectionCode getDataEfficiency(const xAOD::Muon& mu, float& eff, const xAOD::EventInfo* info = 0) const override;
            virtual CorrectionCode applyDataEfficiency(const xAOD::Muon& mu, const xAOD::EventInfo* info = 0) const override;
 
            virtual CorrectionCode getDataEfficiencyReplicas(const xAOD::Muon& mu, std::vector<float> & sf_err, const xAOD::EventInfo* info = 0) const;
            virtual CorrectionCode applyDataEfficiencyReplicas(const xAOD::Muon& mu, int nreplicas = 50, const xAOD::EventInfo* info = 0) const;

            virtual CorrectionCode getMCEfficiency(const xAOD::Muon& mu, float& eff, const xAOD::EventInfo* info = 0) const override;
            virtual CorrectionCode applyMCEfficiency(const xAOD::Muon& mu, const xAOD::EventInfo* info = 0) const override;
 
            virtual CorrectionCode getMCEfficiencyReplicas(const xAOD::Muon& mu, std::vector<float> & sf_err, const xAOD::EventInfo* info = 0) const;
            virtual CorrectionCode applyMCEfficiencyReplicas(const xAOD::Muon& mu, int nreplicas = 50, const xAOD::EventInfo* info = 0) const;
 
            virtual int getUnCorrelatedSystBin(const xAOD::Muon& mu) const override;
            virtual std::string getUncorrelatedSysBinName(unsigned int Bin) const override;
            virtual std::string getUncorrelatedSysBinName(const SystematicSet& systConfig) const override;
 
 
        private:
            unsigned int getRandomRunNumber(const xAOD::EventInfo* info) const;
            unsigned int getRandomRunNumber(columnar::EventInfoId info) const;
            StatusCode LoadInputs();
 
            SG::ReadHandleKey<xAOD::EventInfo> m_eventInfo{this, "EventInfoContName", "EventInfo", "event info key"};
           
            std::map<std::string, unsigned int> lookUpSystematics();
        public:
            
            
            std::string filename_Central()const;
            std::string filename_Calo()const;
            std::string filename_HighEta()const;
 
            std::string filename_LowPt()const;
            std::string filename_LowPtCalo()const;
            std::string filename_LRTCentral() const;
            std::string filename_LRTLowPt() const;
            
            float lowPtTransition() const;
            
            CP::MuonEfficiencyType measurement() const; 
            
            
            std::string sf_decoration() const;
            std::string data_effi_decoration() const;
            std::string mc_effi_decoration() const;
            
            std::string sf_replica_decoration() const;
            std::string data_effi_replica_decoration() const;
            std::string mc_effi_replica_deocration() const;
            
            size_t getPosition(const EffiCollection* coll) const;
            
            size_t getNCollections() const;
            bool uncorrelate_sys() const;
            
            const std::string& close_by_jet_decoration() const;
            bool use_2D_iso_corrections() const;
            bool use_lrt() const;
            
       
    private:
            std::string resolve_file_location(const std::string &filename)const;
           
           
            std::string m_wp;
           
            std::vector<std::unique_ptr<EffiCollection>> m_sf_sets;
            
            EffiCollection* m_current_sf;
 
            std::string m_custom_dir;
            std::string m_custom_file_Combined;
            std::string m_custom_file_Calo;
            std::string m_custom_file_HighEta;
            std::string m_custom_file_LowPt;
            std::string m_custom_file_LowPtCalo;
            std::string m_custom_file_LRTCombined;
            std::string m_custom_file_LRTLowPt;
   
            // Decorate the data-monteCarlo & scale-factors
            // to the muon. Decoration names can be set flexile
            std::string m_efficiency_decoration_name_data;
            std::string m_efficiency_decoration_name_mc;
            std::string m_sf_decoration_name;
      
            std::string m_calibration_version;
            

            float m_lowpt_threshold;
            std::string m_iso_jet_dR;
            bool m_use2DIsoCorr;
            CP::SystematicSet m_affectingSys;
            std::unordered_map<CP::SystematicSet, EffiCollection*> m_filtered_sys_sets;
   
            bool m_init;
            bool m_seperateSystBins;
            bool m_breakDownSyst;
            bool m_applyKineDepSys;
            bool m_useLRT;
 
            CP::MuonEfficiencyType m_Type;
 
            // a struct holding all columnar accessors, as those interfere
            // with the root dictionaries.
            struct Accessors;
            std::unique_ptr<Accessors> m_accessors;
 
    public:
 
            void callSingleEvent (columnar::MuonRange muons, columnar::EventInfoId event) const;
            virtual void callEvents (columnar::EventContextRange events) const override;
    };
 
} /* namespace CP */
 
#endif /* MUONEFFICIENCYSCALEFACTORS_H_ */