Interface for the tools providing an estimate of the fake lepton background, which are able to provide an event-by-event weight. More...

#include <ILinearFakeBkgTool.h>

Inheritance diagram for CP::ILinearFakeBkgTool:

Collaboration diagram for CP::ILinearFakeBkgTool:

Public Member Functions
virtual StatusCode	getEventWeight (float &weight, const std::string &selection=defaultSelection(), const std::string &process=defaultProcess())=0
	returns an event weight addEvent() must have been called before hand. More...

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) More...

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) More...

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. More...

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 More...

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 More...

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 More...

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 More...

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...

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. More...

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. More...

Detailed Description

Interface for the tools providing an estimate of the fake lepton background, which are able to provide an event-by-event weight.

Definition at line 16 of file ILinearFakeBkgTool.h.

Member Function Documentation

◆ addEvent() [1/2]

virtual StatusCode CP::IFakeBkgTool::addEvent	(	const ConstDataVector< xAOD::IParticleContainer > &	particles,
		float	extraWeight = `1.f`
	)

pure virtualinherited

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 CP::BaseFakeBkgTool.

◆ addEvent() [2/2]

virtual StatusCode CP::IFakeBkgTool::addEvent	(	const xAOD::IParticleContainer &	particles,
		float	extraWeight = `1.f`
	)

pure virtualinherited

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 CP::BaseFakeBkgTool.

◆ 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.

◆ 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

◆ defaultProcess()

static constexpr const char* CP::IFakeBkgTool::defaultProcess ( )

inlinestaticconstexprinherited

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.

38 { return ">=1F[T]"; }

◆ defaultSelection()

static constexpr const char* CP::IFakeBkgTool::defaultSelection ( )

inlinestaticconstexprinherited

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.

33 { return "0!T"; }

◆ getEventWeight()

virtual StatusCode CP::ILinearFakeBkgTool::getEventWeight	(	float &	weight,
		const std::string &	selection = `defaultSelection()`,
		const std::string &	process = `defaultProcess()`
	)

pure virtual

returns an event weight addEvent() must have been called before hand.

Can be called several times for the same event, possibly with different arguments. The 'selection' argument indicates how the analysis selects leptons in the signal region The 'process' argument indicates what should be treated as fake lepton background. The syntax supported for these two arguments is described in the package documentation. The extraWeight argument specified to addEvent() is NOT included in the returned weight.

Implemented in CP::BaseLinearFakeBkgTool.

◆ getSystDescriptor()

virtual const IFakeBkgSystDescriptor& CP::IFakeBkgTool::getSystDescriptor ( ) const

pure virtualinherited

retrieves an interface to various helper methods to identify what the different SystematicVariations correspond to

Implemented in CP::BaseFakeBkgTool.

◆ getTotalYield()

virtual StatusCode CP::IFakeBkgTool::getTotalYield	(	float &	yield,
		float &	statErrorUp,
		float &	statErrorDown
	)

pure virtualinherited

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::LhoodMM_tools, and CP::BaseLinearFakeBkgTool.

◆ 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

◆ print()

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

pure virtualinherited

Print the state of the tool.

Implemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, asg::AsgTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

◆ recommendedSystematics()

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

pure virtualinherited

the list of all systematics this tool recommends to use

◆ register1DHistogram()

virtual StatusCode CP::IFakeBkgTool::register1DHistogram	(	TH1 *	h1,
		const float *	val
	)

pure virtualinherited

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 CP::BaseFakeBkgTool, CP::BaseLinearFakeBkgTool, and CP::LhoodMM_tools.

◆ register2DHistogram()

virtual StatusCode CP::IFakeBkgTool::register2DHistogram	(	TH2 *	h2,
		const float *	xval,
		const float *	yval
	)

pure virtualinherited

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 CP::BaseFakeBkgTool, CP::BaseLinearFakeBkgTool, and CP::LhoodMM_tools.

◆ register3DHistogram()

virtual StatusCode CP::IFakeBkgTool::register3DHistogram	(	TH3 *	h3,
		const float *	xval,
		const float *	yval,
		const float *	zval
	)

pure virtualinherited

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 CP::BaseFakeBkgTool, CP::BaseLinearFakeBkgTool, and CP::LhoodMM_tools.

◆ saveProgress()

virtual StatusCode CP::IFakeBkgTool::saveProgress ( TDirectory * dir )

pure virtualinherited

Implemented in CP::LhoodMM_tools, and CP::BaseLinearFakeBkgTool.

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

ILinearFakeBkgTool.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ addEvent() [1/2]

◆ addEvent() [2/2]

◆ affectingSystematics()

◆ applySystematicVariation()

◆ defaultProcess()

◆ defaultSelection()

◆ getEventWeight()

◆ getSystDescriptor()

◆ getTotalYield()

◆ isAffectedBySystematic()

◆ print()

◆ recommendedSystematics()

◆ register1DHistogram()

◆ register2DHistogram()

◆ register3DHistogram()

◆ saveProgress()