ATLAS Offline Software
Public Member Functions | List of all members
CP::IMuonEfficiencyScaleFactors Class Referenceabstract

#include <IMuonEfficiencyScaleFactors.h>

Inheritance diagram for CP::IMuonEfficiencyScaleFactors:
Collaboration diagram for CP::IMuonEfficiencyScaleFactors:

Public Member Functions

virtual CorrectionCode getEfficiencyScaleFactor (const xAOD::Muon &mu, float &sf, const xAOD::EventInfo *info=0) const =0
 Retrieve the Scale factor. More...
 
virtual CorrectionCode applyEfficiencyScaleFactor (const xAOD::Muon &mu, const xAOD::EventInfo *info=0) const =0
 decorate the muon with scale factor information More...
 
virtual CorrectionCode getEfficiencyScaleFactorReplicas (const xAOD::Muon &mu, std::vector< float > &sf_err, const xAOD::EventInfo *info=0) const =0
 BONUS functionality. More...
 
virtual CorrectionCode applyEfficiencyScaleFactorReplicas (const xAOD::Muon &mu, int nreplicas=50, const xAOD::EventInfo *info=0) const =0
 decorate the muon with a set of SF replica weights. More...
 
virtual CorrectionCode getDataEfficiency (const xAOD::Muon &mu, float &eff, const xAOD::EventInfo *info=0) const =0
 Obtain the muon efficiency measured using the data. More...
 
virtual CorrectionCode applyDataEfficiency (const xAOD::Muon &mu, const xAOD::EventInfo *info=0) const =0
 decorate a muon with the efficiency information More...
 
virtual CorrectionCode getMCEfficiency (const xAOD::Muon &mu, float &eff, const xAOD::EventInfo *info=0) const =0
 Obtain the muon efficiency measured using the MonteCarlo. More...
 
virtual CorrectionCode applyMCEfficiency (const xAOD::Muon &mu, const xAOD::EventInfo *info=0) const =0
 
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 ()
 
virtual bool isAffectedBySystematic (const SystematicVariation &systematic) const =0
 Declare the interface that this class provides. More...
 
virtual StatusCode applySystematicVariation (const SystematicSet &systConfig)=0
 effects: configure this tool for the given list of systematic variations. More...
 
virtual SystematicSet affectingSystematics () const =0
 the list of all systematics this tool can be affected by More...
 
virtual SystematicSet recommendedSystematics () const =0
 the list of all systematics this tool recommends to use More...
 
virtual void print () const =0
 Print the state of the tool. More...
 

Detailed Description

Definition at line 103 of file IMuonEfficiencyScaleFactors.h.

Constructor & Destructor Documentation

◆ ~IMuonEfficiencyScaleFactors()

virtual CP::IMuonEfficiencyScaleFactors::~IMuonEfficiencyScaleFactors ( )
inlinevirtual

Definition at line 147 of file IMuonEfficiencyScaleFactors.h.

147 {}

Member Function Documentation

◆ affectingSystematics()

virtual SystematicSet CP::IReentrantSystematicsTool::affectingSystematics ( ) const
pure virtualinherited

the list of all systematics this tool can be affected by

Implemented in InDet::InDetTrackSystematicsTool, CP::ElectronChargeEfficiencyCorrectionTool, AsgElectronEfficiencyCorrectionTool, CP::IsolationCorrectionTool, CP::EgammaCalibrationAndSmearingTool, CP::FFJetSmearingTool, SimpleMuonTriggerScaleFactors, SimplePhotonEfficiencyCorrectionTool, PMGTools::PMGTruthWeightTool, AsgPhotonEfficiencyCorrectionTool, ParticleScaleFactorTool, InDet::InDetTrackTruthFilterTool, CP::JetJvtEfficiency, InDet::InDetTrackBiasingTool, InDet::JetTrackFilterTool, InDet::InDetTrackSmearingTool, CP::BaseFakeBkgTool, InDet::InclusiveTrackFilterTool, TrigGlobalEfficiencyCorrectionTool, SimpleElectronEfficiencyCorrectionTool, TauAnalysisTools::DiTauSmearingTool, CP::JetQGTagger, CP::MuonCalibTool, CP::MuonCalibIntScaleSmearTool, CP::MuonCalibIntHighpTSmearTool, CP::MuonCalibIntSagittaTool, BTaggingEfficiencyJsonTool, InDet::IInDetTrackSmearingTool, InDet::IInDetTrackTruthFilterTool, CP::IIsolationCorrectionTool, InDet::IInDetTrackBiasingTool, InDet::IJetTrackFilterTool, BTaggingEfficiencyTool, JetUncertaintiesTool, BTaggingTruthTaggingTool, CP::PileupReweightingTool, met::METSystematicsTool, BTaggingEigenVectorRecompositionTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, CP::JetTileCorrectionTool, TauAnalysisTools::CommonSmearingTool, CP::SystematicsTool, TauAnalysisTools::CommonEfficiencyTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSmearingTool, CP::MuonTriggerScaleFactors, and CP::MuonEfficiencyScaleFactors.

◆ applyDataEfficiency()

virtual CorrectionCode CP::IMuonEfficiencyScaleFactors::applyDataEfficiency ( const xAOD::Muon mu,
const xAOD::EventInfo info = 0 
) const
pure virtual

decorate a muon with the efficiency information

Implemented in CP::MuonEfficiencyScaleFactors.

◆ applyEfficiencyScaleFactor()

virtual CorrectionCode CP::IMuonEfficiencyScaleFactors::applyEfficiencyScaleFactor ( const xAOD::Muon mu,
const xAOD::EventInfo info = 0 
) const
pure virtual

decorate the muon with scale factor information

Implemented in CP::MuonEfficiencyScaleFactors.

◆ applyEfficiencyScaleFactorReplicas()

virtual CorrectionCode CP::IMuonEfficiencyScaleFactors::applyEfficiencyScaleFactorReplicas ( const xAOD::Muon mu,
int  nreplicas = 50,
const xAOD::EventInfo info = 0 
) const
pure virtual

decorate the muon with a set of SF replica weights.

Implemented in CP::MuonEfficiencyScaleFactors.

◆ applyMCEfficiency()

virtual CorrectionCode CP::IMuonEfficiencyScaleFactors::applyMCEfficiency ( const xAOD::Muon mu,
const xAOD::EventInfo info = 0 
) const
pure virtual

◆ applySystematicVariation()

virtual StatusCode CP::ISystematicsTool::applySystematicVariation ( const SystematicSet systConfig)
pure virtualinherited

effects: configure this tool for the given list of systematic variations.

any requested systematics that are not affecting this tool will be silently ignored (unless they cause other errors). failures: systematic unknown failures: requesting multiple variations on the same systematic (e.g. up & down) failures: requesting an unsupported variation on an otherwise supported systematic (e.g. a 2 sigma variation and the tool only supports 1 sigma variations) failures: unsupported combination of supported systematic failures: other tool specific errors

Implemented in CP::ElectronChargeEfficiencyCorrectionTool, CP::MuonCalibTool, CP::MuonCalibIntScaleSmearTool, CP::MuonCalibIntHighpTSmearTool, CP::MuonCalibIntSagittaTool, CP::SystematicsTool, CP::JetTileCorrectionTool, CP::MuonEfficiencyScaleFactors, CP::JetQGTagger, CP::FFJetSmearingTool, CP::IIsolationCorrectionTool, AsgElectronEfficiencyCorrectionTool, CP::IsolationCorrectionTool, CP::EgammaCalibrationAndSmearingTool, AsgPhotonEfficiencyCorrectionTool, ParticleScaleFactorTool, CP::BaseFakeBkgTool, TauAnalysisTools::DiTauSmearingTool, TrigGlobalEfficiencyCorrectionTool, JetUncertaintiesTool, BTaggingTruthTaggingTool, CP::PileupReweightingTool, BTaggingEigenVectorRecompositionTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSmearingTool, CP::MuonTriggerScaleFactors, BTaggingEfficiencyJsonTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::CommonEfficiencyTool, TauAnalysisTools::TauEfficiencyTriggerTool, CP::JetJvtEfficiency, BTaggingEfficiencyTool, met::METSystematicsTool, InDet::IInDetTrackSmearingTool, InDet::IInDetTrackTruthFilterTool, InDet::IInDetTrackBiasingTool, InDet::IJetTrackFilterTool, SimpleMuonTriggerScaleFactors, SimplePhotonEfficiencyCorrectionTool, InDet::InDetTrackTruthFilterTool, InDet::InDetTrackBiasingTool, InDet::JetTrackFilterTool, InDet::InDetTrackSmearingTool, InDet::InclusiveTrackFilterTool, SimpleElectronEfficiencyCorrectionTool, and InDet::InDetTrackSystematicsTool.

◆ getDataEfficiency()

virtual CorrectionCode CP::IMuonEfficiencyScaleFactors::getDataEfficiency ( const xAOD::Muon mu,
float &  eff,
const xAOD::EventInfo info = 0 
) const
pure virtual

Obtain the muon efficiency measured using the data.

Implemented in CP::MuonEfficiencyScaleFactors.

◆ getEfficiencyScaleFactor()

virtual CorrectionCode CP::IMuonEfficiencyScaleFactors::getEfficiencyScaleFactor ( const xAOD::Muon mu,
float &  sf,
const xAOD::EventInfo info = 0 
) const
pure virtual

Retrieve the Scale factor.

Implemented in CP::MuonEfficiencyScaleFactors.

◆ getEfficiencyScaleFactorReplicas()

virtual CorrectionCode CP::IMuonEfficiencyScaleFactors::getEfficiencyScaleFactorReplicas ( const xAOD::Muon mu,
std::vector< float > &  sf_err,
const xAOD::EventInfo info = 0 
) const
pure virtual

BONUS functionality.

An optional, less conservative way of treating the SF stat error. Here, we generate a set of SF replicas, each by smearing the SF bin by bin with a gaussian with the width of the SF error in that bin the SF stat systematic is then the variation of the final observable within the replicas

Implemented in CP::MuonEfficiencyScaleFactors.

◆ getMCEfficiency()

virtual CorrectionCode CP::IMuonEfficiencyScaleFactors::getMCEfficiency ( const xAOD::Muon mu,
float &  eff,
const xAOD::EventInfo info = 0 
) const
pure virtual

Obtain the muon efficiency measured using the MonteCarlo.

Implemented in CP::MuonEfficiencyScaleFactors.

◆ getUncorrelatedSysBinName() [1/2]

virtual std::string CP::IMuonEfficiencyScaleFactors::getUncorrelatedSysBinName ( const SystematicSet systConfig) const
pure virtual

◆ getUncorrelatedSysBinName() [2/2]

virtual std::string CP::IMuonEfficiencyScaleFactors::getUncorrelatedSysBinName ( unsigned int  Bin) const
pure virtual

◆ getUnCorrelatedSystBin()

virtual int CP::IMuonEfficiencyScaleFactors::getUnCorrelatedSystBin ( const xAOD::Muon mu) const
pure virtual

◆ isAffectedBySystematic()

virtual bool CP::ISystematicsTool::isAffectedBySystematic ( const SystematicVariation systematic) const
pure virtualinherited

Declare the interface that this class provides.

returns: whether this tool is affected by the given systematics

Implemented in CP::JetQGTagger, CP::ElectronChargeEfficiencyCorrectionTool, CP::MuonCalibTool, CP::MuonCalibIntScaleSmearTool, CP::MuonCalibIntHighpTSmearTool, CP::MuonCalibIntSagittaTool, CP::JetTileCorrectionTool, CP::SystematicsTool, CP::MuonEfficiencyScaleFactors, CP::JetJvtEfficiency, met::METSystematicsTool, AsgElectronEfficiencyCorrectionTool, CP::IsolationCorrectionTool, CP::EgammaCalibrationAndSmearingTool, CP::FFJetSmearingTool, ParticleScaleFactorTool, AsgPhotonEfficiencyCorrectionTool, CP::BaseFakeBkgTool, TrigGlobalEfficiencyCorrectionTool, TauAnalysisTools::DiTauSmearingTool, BTaggingEfficiencyJsonTool, CP::IIsolationCorrectionTool, BTaggingEfficiencyTool, JetUncertaintiesTool, BTaggingTruthTaggingTool, CP::PileupReweightingTool, BTaggingEigenVectorRecompositionTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::CommonEfficiencyTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSmearingTool, CP::MuonTriggerScaleFactors, SimpleMuonTriggerScaleFactors, SimplePhotonEfficiencyCorrectionTool, InDet::InDetTrackTruthFilterTool, InDet::InDetTrackBiasingTool, InDet::JetTrackFilterTool, InDet::InDetTrackSmearingTool, InDet::InclusiveTrackFilterTool, SimpleElectronEfficiencyCorrectionTool, InDet::InDetTrackSystematicsTool, InDet::IInDetTrackSmearingTool, InDet::IInDetTrackTruthFilterTool, InDet::IInDetTrackBiasingTool, and InDet::IJetTrackFilterTool.

◆ print()

virtual void asg::IAsgTool::print ( ) const
pure virtualinherited

◆ recommendedSystematics()

virtual SystematicSet CP::IReentrantSystematicsTool::recommendedSystematics ( ) const
pure virtualinherited

the list of all systematics this tool recommends to use

Implemented in CP::ElectronChargeEfficiencyCorrectionTool, AsgElectronEfficiencyCorrectionTool, CP::IsolationCorrectionTool, CP::EgammaCalibrationAndSmearingTool, CP::FFJetSmearingTool, SimpleMuonTriggerScaleFactors, SimplePhotonEfficiencyCorrectionTool, PMGTools::PMGTruthWeightTool, AsgPhotonEfficiencyCorrectionTool, InDet::InDetTrackTruthFilterTool, ParticleScaleFactorTool, CP::JetJvtEfficiency, InDet::InDetTrackBiasingTool, InDet::JetTrackFilterTool, InDet::InDetTrackSmearingTool, CP::BaseFakeBkgTool, InDet::InclusiveTrackFilterTool, TauAnalysisTools::DiTauSmearingTool, TrigGlobalEfficiencyCorrectionTool, SimpleElectronEfficiencyCorrectionTool, CP::JetQGTagger, CP::MuonCalibTool, CP::MuonCalibIntScaleSmearTool, CP::MuonCalibIntHighpTSmearTool, CP::MuonCalibIntSagittaTool, InDet::InDetTrackSystematicsTool, BTaggingEfficiencyJsonTool, InDet::IInDetTrackSmearingTool, InDet::IInDetTrackTruthFilterTool, CP::IIsolationCorrectionTool, InDet::IInDetTrackBiasingTool, InDet::IJetTrackFilterTool, BTaggingEfficiencyTool, JetUncertaintiesTool, BTaggingTruthTaggingTool, CP::PileupReweightingTool, met::METSystematicsTool, BTaggingEigenVectorRecompositionTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, CP::JetTileCorrectionTool, CP::SystematicsTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::CommonEfficiencyTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSmearingTool, CP::MuonTriggerScaleFactors, and CP::MuonEfficiencyScaleFactors.


The documentation for this class was generated from the following file: