 |
ATLAS Offline Software
|
Loading...
Searching...
No Matches
|
ATLAS Offline Software
|
Top-level interface for the tools providing an estimate of the fake lepton background All the tools, each of them implementing a different method for the estimation, inherit from this interface. More...
#include <IFakeBkgTool.h>
Public Member Functions | |
| virtual StatusCode | addEvent (const xAOD::IParticleContainer &particles, float extraWeight=1.f)=0 |
| supply list of leptons / global variables, internal counters incremented Does not return anything; event weight(s) must be retrieved by subsequent call(s) to getEventWeight() (for tools inheriting from ILinearFakeBkgTool) | |
| virtual StatusCode | addEvent (const ConstDataVector< xAOD::IParticleContainer > &particles, float extraWeight=1.f)=0 |
| supply list of leptons / global variables, internal counters incremented Does not return anything; event weight(s) must be retrieved by subsequent call(s) to getEventWeight() (for tools inheriting from ILinearFakeBkgTool) | |
| virtual StatusCode | getTotalYield (float &yield, float &statErrorUp, float &statErrorDown)=0 |
| returns the accumulated fake lepton background yield (or compute it, in the case of the likelihood matrix method), and fills the registered histograms (if any) The 'selection' and 'process' settings used for these operations can be chosen with the 'Selection' and 'Process' properties. | |
| virtual StatusCode | register1DHistogram (TH1 *h1, const float *val)=0 |
| associates a 1D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'val' argument points to a variable corresponding to the X axis of the histogram and that needs to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime | |
| virtual StatusCode | register2DHistogram (TH2 *h2, const float *xval, const float *yval)=0 |
| associates a 2D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'xval' / 'yval' arguments point to variables corresponding to the X/Y axis of the histogram and that need to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime | |
| virtual StatusCode | register3DHistogram (TH3 *h3, const float *xval, const float *yval, const float *zval)=0 |
| associates a 3D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'xval' / 'yval' / 'zval' arguments point to variables corresponding to the X/Y/Z axis of the histogram and that need to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime | |
| virtual StatusCode | saveProgress (TDirectory *dir)=0 |
| virtual const IFakeBkgSystDescriptor & | getSystDescriptor () const =0 |
| retrieves an interface to various helper methods to identify what the different SystematicVariations correspond to | |
| virtual bool | isAffectedBySystematic (const SystematicVariation &systematic) const =0 |
| Declare the interface that this class provides. | |
| virtual StatusCode | applySystematicVariation (const SystematicSet &systConfig)=0 |
| effects: configure this tool for the given list of systematic variations. | |
| virtual SystematicSet | affectingSystematics () const =0 |
| the list of all systematics this tool can be affected by | |
| virtual SystematicSet | recommendedSystematics () const =0 |
| the list of all systematics this tool recommends to use | |
| virtual void | print () const =0 |
| Print the state of the tool. | |
Static Public Member Functions | |
| static constexpr const char * | defaultSelection () |
| default value taken by the 'selection' argument of several methods or properties It indicates how the analysis selects leptons in the signal region The syntax supported for this arguments is described in the package documentation. | |
| static constexpr const char * | defaultProcess () |
| default value taken by the 'process' argument of several methods or properties It indicates what should be treated as fake lepton background. | |
Top-level interface for the tools providing an estimate of the fake lepton background All the tools, each of them implementing a different method for the estimation, inherit from this interface.
Definition at line 26 of file IFakeBkgTool.h.
|
pure virtual |
supply list of leptons / global variables, internal counters incremented Does not return anything; event weight(s) must be retrieved by subsequent call(s) to getEventWeight() (for tools inheriting from ILinearFakeBkgTool)
Implemented in BaseFakeBkgTool, and CP::BaseFakeBkgTool.
|
pure virtual |
supply list of leptons / global variables, internal counters incremented Does not return anything; event weight(s) must be retrieved by subsequent call(s) to getEventWeight() (for tools inheriting from ILinearFakeBkgTool)
Implemented in BaseFakeBkgTool, and CP::BaseFakeBkgTool.
|
pure virtualinherited |
the list of all systematics this tool can be affected by
Implemented in AsgElectronEfficiencyCorrectionTool, AsgPhotonEfficiencyCorrectionTool, BaseFakeBkgTool, BTaggingEfficiencyJsonTool, BTaggingEfficiencyTool, BTaggingEigenVectorRecompositionTool, BTaggingTruthTaggingTool, CP::BaseFakeBkgTool, CP::EgammaCalibrationAndSmearingTool, CP::ElectronChargeEfficiencyCorrectionTool, CP::FFJetSmearingTool, CP::IIsolationCorrectionTool, CP::IsolationCorrectionTool, CP::JetQGTagger, CP::JetTileCorrectionTool, CP::MuonCalibIntHighpTSmearTool, CP::MuonCalibIntSagittaTool, CP::MuonCalibIntScaleSmearTool, CP::MuonCalibTool, CP::MuonEfficiencyScaleFactors, CP::MuonTriggerScaleFactors, CP::PileupReweightingTool, CP::SystematicsTool, InDet::IInDetTrackBiasingTool, InDet::IInDetTrackSmearingTool, InDet::IInDetTrackTruthFilterTool, InDet::IJetTrackFilterTool, InDet::InclusiveTrackFilterTool, InDet::InDetTrackBiasingTool, InDet::InDetTrackSmearingTool, InDet::InDetTrackSystematicsTool, InDet::InDetTrackTruthFilterTool, InDet::JetTrackFilterTool, JetUncertaintiesTool, met::METSystematicsTool, ParticleScaleFactorTool, PMGTools::PMGHFProductionFractionTool, PMGTools::PMGTruthWeightTool, SimpleElectronEfficiencyCorrectionTool, SimpleMuonTriggerScaleFactors, SimplePhotonEfficiencyCorrectionTool, TauAnalysisTools::CommonEfficiencyTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, TauAnalysisTools::DiTauSmearingTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSmearingTool, and TrigGlobalEfficiencyCorrectionTool.
|
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 AsgElectronEfficiencyCorrectionTool, AsgPhotonEfficiencyCorrectionTool, BaseFakeBkgTool, BTaggingEfficiencyTool, BTaggingEigenVectorRecompositionTool, BTaggingTruthTaggingTool, CP::BaseFakeBkgTool, CP::EgammaCalibrationAndSmearingTool, CP::ElectronChargeEfficiencyCorrectionTool, CP::FFJetSmearingTool, CP::IIsolationCorrectionTool, CP::IsolationCorrectionTool, CP::JetQGTagger, CP::JetTileCorrectionTool, CP::MuonCalibIntHighpTSmearTool, CP::MuonCalibIntSagittaTool, CP::MuonCalibIntScaleSmearTool, CP::MuonCalibTool, CP::MuonEfficiencyScaleFactors, CP::MuonTriggerScaleFactors, CP::PileupReweightingTool, CP::SystematicsTool, InDet::IInDetTrackBiasingTool, InDet::IInDetTrackSmearingTool, InDet::IInDetTrackTruthFilterTool, InDet::IJetTrackFilterTool, InDet::InclusiveTrackFilterTool, InDet::InDetTrackBiasingTool, InDet::InDetTrackSmearingTool, InDet::InDetTrackSystematicsTool, InDet::InDetTrackTruthFilterTool, InDet::JetTrackFilterTool, JetUncertaintiesTool, met::METSystematicsTool, ParticleScaleFactorTool, SimpleElectronEfficiencyCorrectionTool, SimpleMuonTriggerScaleFactors, SimplePhotonEfficiencyCorrectionTool, TauAnalysisTools::CommonEfficiencyTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, TauAnalysisTools::DiTauSmearingTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSmearingTool, and TrigGlobalEfficiencyCorrectionTool.
|
inlinestaticconstexpr |
default value taken by the 'process' argument of several methods or properties It indicates what should be treated as fake lepton background.
The syntax supported for this arguments is described in the package documentation.
Definition at line 38 of file IFakeBkgTool.h.
|
inlinestaticconstexpr |
default value taken by the 'selection' argument of several methods or properties It indicates how the analysis selects leptons in the signal region The syntax supported for this arguments is described in the package documentation.
Definition at line 33 of file IFakeBkgTool.h.
|
pure virtual |
retrieves an interface to various helper methods to identify what the different SystematicVariations correspond to
Implemented in BaseFakeBkgTool, and CP::BaseFakeBkgTool.
|
pure virtual |
returns the accumulated fake lepton background yield (or compute it, in the case of the likelihood matrix method), and fills the registered histograms (if any) The 'selection' and 'process' settings used for these operations can be chosen with the 'Selection' and 'Process' properties.
Only statistical uncertainties can be retrieved; use applySystematicVariation() to obtain uncertainties
Implemented in CP::BaseLinearFakeBkgTool, and CP::LhoodMM_tools.
|
pure virtualinherited |
Declare the interface that this class provides.
returns: whether this tool is affected by the given systematics
Implemented in AsgElectronEfficiencyCorrectionTool, AsgPhotonEfficiencyCorrectionTool, BaseFakeBkgTool, BTaggingEfficiencyTool, BTaggingEigenVectorRecompositionTool, BTaggingTruthTaggingTool, CP::BaseFakeBkgTool, CP::EgammaCalibrationAndSmearingTool, CP::ElectronChargeEfficiencyCorrectionTool, CP::FFJetSmearingTool, CP::IIsolationCorrectionTool, CP::IsolationCorrectionTool, CP::JetQGTagger, CP::JetTileCorrectionTool, CP::MuonCalibIntHighpTSmearTool, CP::MuonCalibIntSagittaTool, CP::MuonCalibIntScaleSmearTool, CP::MuonCalibTool, CP::MuonEfficiencyScaleFactors, CP::MuonTriggerScaleFactors, CP::PileupReweightingTool, CP::SystematicsTool, InDet::IInDetTrackBiasingTool, InDet::IInDetTrackSmearingTool, InDet::IInDetTrackTruthFilterTool, InDet::IJetTrackFilterTool, InDet::InclusiveTrackFilterTool, InDet::InDetTrackBiasingTool, InDet::InDetTrackSmearingTool, InDet::InDetTrackSystematicsTool, InDet::InDetTrackTruthFilterTool, InDet::JetTrackFilterTool, JetUncertaintiesTool, met::METSystematicsTool, ParticleScaleFactorTool, SimpleElectronEfficiencyCorrectionTool, SimpleMuonTriggerScaleFactors, SimplePhotonEfficiencyCorrectionTool, TauAnalysisTools::CommonEfficiencyTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, TauAnalysisTools::DiTauSmearingTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSmearingTool, and TrigGlobalEfficiencyCorrectionTool.
|
pure virtualinherited |
Print the state of the tool.
Implemented in asg::AsgTool, AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.
|
pure virtualinherited |
the list of all systematics this tool recommends to use
Implemented in AsgElectronEfficiencyCorrectionTool, AsgPhotonEfficiencyCorrectionTool, BaseFakeBkgTool, BTaggingEfficiencyJsonTool, BTaggingEfficiencyTool, BTaggingEigenVectorRecompositionTool, BTaggingTruthTaggingTool, CP::BaseFakeBkgTool, CP::EgammaCalibrationAndSmearingTool, CP::ElectronChargeEfficiencyCorrectionTool, CP::FFJetSmearingTool, CP::IIsolationCorrectionTool, CP::IsolationCorrectionTool, CP::JetQGTagger, CP::JetTileCorrectionTool, CP::MuonCalibIntHighpTSmearTool, CP::MuonCalibIntSagittaTool, CP::MuonCalibIntScaleSmearTool, CP::MuonCalibTool, CP::MuonEfficiencyScaleFactors, CP::MuonTriggerScaleFactors, CP::PileupReweightingTool, CP::SystematicsTool, InDet::IInDetTrackBiasingTool, InDet::IInDetTrackSmearingTool, InDet::IInDetTrackTruthFilterTool, InDet::IJetTrackFilterTool, InDet::InclusiveTrackFilterTool, InDet::InDetTrackBiasingTool, InDet::InDetTrackSmearingTool, InDet::InDetTrackSystematicsTool, InDet::InDetTrackTruthFilterTool, InDet::JetTrackFilterTool, JetUncertaintiesTool, met::METSystematicsTool, ParticleScaleFactorTool, PMGTools::PMGHFProductionFractionTool, PMGTools::PMGTruthWeightTool, SimpleElectronEfficiencyCorrectionTool, SimpleMuonTriggerScaleFactors, SimplePhotonEfficiencyCorrectionTool, TauAnalysisTools::CommonEfficiencyTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, TauAnalysisTools::DiTauSmearingTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSmearingTool, and TrigGlobalEfficiencyCorrectionTool.
|
pure virtual |
associates a 1D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'val' argument points to a variable corresponding to the X axis of the histogram and that needs to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime
Implemented in BaseFakeBkgTool, CP::BaseFakeBkgTool, CP::BaseLinearFakeBkgTool, and CP::LhoodMM_tools.
|
pure virtual |
associates a 2D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'xval' / 'yval' arguments point to variables corresponding to the X/Y axis of the histogram and that need to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime
Implemented in BaseFakeBkgTool, CP::BaseFakeBkgTool, CP::BaseLinearFakeBkgTool, and CP::LhoodMM_tools.
|
pure virtual |
associates a 3D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'xval' / 'yval' / 'zval' arguments point to variables corresponding to the X/Y/Z axis of the histogram and that need to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime
Implemented in BaseFakeBkgTool, CP::BaseFakeBkgTool, CP::BaseLinearFakeBkgTool, and CP::LhoodMM_tools.
|
pure virtual |
Implemented in CP::BaseLinearFakeBkgTool, and CP::LhoodMM_tools.
1.14.0