IMuonEfficiencyScaleFactors.h

Go to the documentation of this file.

/*
 Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
 */
 
#ifndef IMUONEFFICIENCYSCALEFACTORS_H_
#define IMUONEFFICIENCYSCALEFACTORS_H_
 
// Framework include(s):
#include "AsgTools/IAsgTool.h"
 
// EDM include(s):
#include <xAODEventInfo/EventInfo.h>
 
#include "xAODMuon/Muon.h"
 
// Local include(s):
#include "PATInterfaces/CorrectionCode.h"
#include "PATInterfaces/ISystematicsTool.h"
 
// STL include(s):
#include <map>
#include <string>
#include <vector>

 
namespace CP {
    class SystematicSet;
 
    class IMuonEfficiencyScaleFactors : public virtual CP::ISystematicsTool {
 
        ASG_TOOL_INTERFACE(CP::IMuonEfficiencyScaleFactors)
 
    public:
        virtual CorrectionCode getEfficiencyScaleFactor(const xAOD::Muon& mu, float& sf, const xAOD::EventInfo* info = 0) const = 0;
        virtual CorrectionCode applyEfficiencyScaleFactor(const xAOD::Muon& mu, const xAOD::EventInfo* info = 0) const = 0;


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

        //  Can for example be used to scale truth-level MC
        virtual CorrectionCode getDataEfficiency(const xAOD::Muon& mu, float& eff, const xAOD::EventInfo* info = 0) const = 0;
        virtual CorrectionCode applyDataEfficiency(const xAOD::Muon& mu, const xAOD::EventInfo* info = 0) const = 0;

        virtual CorrectionCode getMCEfficiency(const xAOD::Muon& mu, float& eff, const xAOD::EventInfo* info = 0) const = 0;
        // decorate a muon with the efficiency information
        virtual CorrectionCode applyMCEfficiency(const xAOD::Muon& mu, const xAOD::EventInfo* info = 0) const = 0;
 
        // Functions to get the names of the unfolded systematic bins
        virtual int getUnCorrelatedSystBin(const xAOD::Muon& mu) const = 0;
        virtual std::string getUncorrelatedSysBinName(unsigned int Bin) const = 0;
        virtual std::string getUncorrelatedSysBinName(const SystematicSet& systConfig) const = 0;
 
        virtual ~IMuonEfficiencyScaleFactors() {}
    };
    // class IMuonEfficiencyTool
 
}  // namespace CP
 
#endif /* IMUONEFFICIENCYSCALEFACTORS_H_ */