#include <ITrigGlobalEfficiencyCorrectionTool.h>

Inheritance diagram for ITrigGlobalEfficiencyCorrectionTool:

Collaboration diagram for ITrigGlobalEfficiencyCorrectionTool:

Public Member Functions
virtual CP::CorrectionCode	getEfficiencyScaleFactor (const std::vector< const xAOD::IParticle * > &particles, double &efficiencyScaleFactor)=0

virtual CP::CorrectionCode	getEfficiency (const std::vector< const xAOD::IParticle * > &particles, double &efficiencyData, double &efficiencyMc)=0

virtual CP::CorrectionCode	checkTriggerMatching (bool &matched, const std::vector< const xAOD::IParticle * > &particles)=0

template<typename... Args>
auto	getEfficiencyScaleFactor (Args &... args) -> std::enable_if_t< validArgs< Args... >(1), CP::CorrectionCode >
	Alternatively, the list of particles can be supplied via one or several vectors of xAOD::Electron‍/Muon‍/Photon* The generic signature is getEfficiencyScaleFactor((const) vector<(const)Type1>&, ..., (const) vector<(const)TypeN>&, double& efficiencyScaleFactor) e.g. More...

template<typename... Args>
auto	getEfficiency (Args &... args) -> std::enable_if_t< validArgs< Args... >(2), CP::CorrectionCode >

template<typename... Args>
auto	checkTriggerMatching (bool &matched, Args &... args) -> std::enable_if_t< validArgs< Args... >(0), CP::CorrectionCode >

virtual CP::CorrectionCode	getRelevantTriggers (std::vector< std::string > &triggers)=0
	This will fill the 'triggers' argument with the names of the triggers relevant for the current run number, among those specified in the tool configuration. More...

virtual CP::CorrectionCode	countTriggerLegs (const std::string &trigger, std::size_t &numberOfLegs)=0
	This utility function provides the number of legs for the specified trigger. More...

virtual CP::CorrectionCode	getEfficiencyScaleFactor (unsigned runNumber, const std::vector< const xAOD::IParticle * > &particles, double &efficiencyScaleFactor)=0
	These should in principle not be used (except by unit tests), as the CP tools require the EventInfo decoration "RandomRunNumber" to be present. More...

virtual CP::CorrectionCode	getEfficiency (unsigned runNumber, const std::vector< const xAOD::IParticle * > &particles, double &efficiencyData, double &efficiencyMc)=0

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
template<typename Arg >
static constexpr bool	validArgs (unsigned nTrailingDoubles)

template<typename Arg1 , typename Arg2 , typename... OtherArgs>
static constexpr bool	validArgs (unsigned nTrailingDoubles)

static std::string	toolnameForDefaultScaleFactor ()
	To be used with the ListOfLegsPerTool property: More...

Protected Member Functions
double *	handleArg (double &arg, std::vector< const xAOD::IParticle * > &)

template<typename P >
double *	handleArg (const std::vector< P > &arg, std::vector< const xAOD::IParticle * > &particles)

Detailed Description

Definition at line 20 of file ITrigGlobalEfficiencyCorrectionTool.h.

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.

◆ 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

◆ checkTriggerMatching() [1/2]

template<typename... Args>

auto ITrigGlobalEfficiencyCorrectionTool::checkTriggerMatching	(	bool &	matched,
		Args &...	args
	)		-> std::enable_if_t<validArgs<Args...>(0), CP::CorrectionCode>

Definition at line 110 of file ITrigGlobalEfficiencyCorrectionTool.h.

 {
     std::vector<const xAOD::IParticle*> particles;
     double* eff[] __attribute__((unused)) = { nullptr, handleArg(args, particles)... };
     return checkTriggerMatching(matched, particles);
 }

◆ checkTriggerMatching() [2/2]

virtual CP::CorrectionCode ITrigGlobalEfficiencyCorrectionTool::checkTriggerMatching	(	bool &	matched,
		const std::vector< const xAOD::IParticle * > &	particles
	)

pure virtual

Implemented in TrigGlobalEfficiencyCorrectionTool.

◆ countTriggerLegs()

virtual CP::CorrectionCode ITrigGlobalEfficiencyCorrectionTool::countTriggerLegs	(	const std::string &	trigger,
		std::size_t &	numberOfLegs
	)

pure virtual

This utility function provides the number of legs for the specified trigger.

Implemented in TrigGlobalEfficiencyCorrectionTool.

◆ getEfficiency() [1/3]

template<typename... Args>

auto ITrigGlobalEfficiencyCorrectionTool::getEfficiency ( Args &... args ) -> std::enable_if_t<validArgs<Args...>(2), CP::CorrectionCode>

Definition at line 101 of file ITrigGlobalEfficiencyCorrectionTool.h.

 {
     std::vector<const xAOD::IParticle*> particles;
     double* eff[] = { nullptr, handleArg(args, particles)... };
     return getEfficiency(particles, *eff[sizeof...(Args)-1], *eff[sizeof...(Args)]);
 }

◆ getEfficiency() [2/3]

virtual CP::CorrectionCode ITrigGlobalEfficiencyCorrectionTool::getEfficiency	(	const std::vector< const xAOD::IParticle * > &	particles,
		double &	efficiencyData,
		double &	efficiencyMc
	)

pure virtual

Implemented in TrigGlobalEfficiencyCorrectionTool.

◆ getEfficiency() [3/3]

virtual CP::CorrectionCode ITrigGlobalEfficiencyCorrectionTool::getEfficiency	(	unsigned	runNumber,
		const std::vector< const xAOD::IParticle * > &	particles,
		double &	efficiencyData,
		double &	efficiencyMc
	)

pure virtual

Implemented in TrigGlobalEfficiencyCorrectionTool.

◆ getEfficiencyScaleFactor() [1/3]

template<typename... Args>

auto ITrigGlobalEfficiencyCorrectionTool::getEfficiencyScaleFactor ( Args &... args ) -> std::enable_if_t<validArgs<Args...>(1), CP::CorrectionCode>

Alternatively, the list of particles can be supplied via one or several vectors of xAOD::Electron*‍/Muon*‍/Photon* The generic signature is getEfficiencyScaleFactor((const) vector<(const)Type1*>&, ..., (const) vector<(const)TypeN*>&, double& efficiencyScaleFactor) e.g.

getEfficiencyScaleFactor(electrons, muons, sf); getEfficiencyScaleFactor(photons, sf); getEfficiencyScaleFactor(muons, electrons, photons, sf); don't forget the last argument(s)! (scale factor for getEfficiencyScaleFactor(), data and MC efficiencies for getEfficiency())

Definition at line 92 of file ITrigGlobalEfficiencyCorrectionTool.h.

 {
     std::vector<const xAOD::IParticle*> particles;
     double* sf[] = { nullptr, handleArg(args, particles)... };
     return getEfficiencyScaleFactor(particles, *sf[sizeof...(Args)]);
 }

◆ getEfficiencyScaleFactor() [2/3]

virtual CP::CorrectionCode ITrigGlobalEfficiencyCorrectionTool::getEfficiencyScaleFactor	(	const std::vector< const xAOD::IParticle * > &	particles,
		double &	efficiencyScaleFactor
	)

pure virtual

Implemented in TrigGlobalEfficiencyCorrectionTool.

◆ getEfficiencyScaleFactor() [3/3]

virtual CP::CorrectionCode ITrigGlobalEfficiencyCorrectionTool::getEfficiencyScaleFactor	(	unsigned	runNumber,
		const std::vector< const xAOD::IParticle * > &	particles,
		double &	efficiencyScaleFactor
	)

pure virtual

These should in principle not be used (except by unit tests), as the CP tools require the EventInfo decoration "RandomRunNumber" to be present.

Implemented in TrigGlobalEfficiencyCorrectionTool.

◆ getRelevantTriggers()

virtual CP::CorrectionCode ITrigGlobalEfficiencyCorrectionTool::getRelevantTriggers ( std::vector< std::string > & triggers )

pure virtual

This will fill the 'triggers' argument with the names of the triggers relevant for the current run number, among those specified in the tool configuration.

Implemented in TrigGlobalEfficiencyCorrectionTool.

◆ handleArg() [1/2]

template<typename P >

double* ITrigGlobalEfficiencyCorrectionTool::handleArg	(	const std::vector< P > &	arg,
		std::vector< const xAOD::IParticle * > &	particles
	)

inlineprotected

Definition at line 59 of file ITrigGlobalEfficiencyCorrectionTool.h.

     {
         for(auto ptr : arg) particles.push_back(static_cast<const xAOD::IParticle*>(ptr));
         return nullptr;
     }

◆ handleArg() [2/2]

double* ITrigGlobalEfficiencyCorrectionTool::handleArg	(	double &	arg,
		std::vector< const xAOD::IParticle * > &
	)

inlineprotected

Definition at line 58 of file ITrigGlobalEfficiencyCorrectionTool.h.

58 { return &arg; }

◆ 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

◆ toolnameForDefaultScaleFactor()

static std::string ITrigGlobalEfficiencyCorrectionTool::toolnameForDefaultScaleFactor ( )

inlinestatic

To be used with the ListOfLegsPerTool property:

Definition at line 56 of file ITrigGlobalEfficiencyCorrectionTool.h.

56 { return "RETURN_DEFAULT_SCALE_FACTOR"; }

◆ validArgs() [1/2]

template<typename Arg >

constexpr bool ITrigGlobalEfficiencyCorrectionTool::validArgs ( unsigned nTrailingDoubles )

staticconstexpr

Definition at line 67 of file ITrigGlobalEfficiencyCorrectionTool.h.

 {
     if(std::is_same<double, Arg>::value) return (nTrailingDoubles==1);
     using P = std::remove_cv_t<Arg>;
     return std::is_same<P, std::vector<xAOD::Electron*>>::value
         || std::is_same<P, std::vector<const xAOD::Electron*>>::value
         || std::is_same<P, std::vector<xAOD::Muon*>>::value
         || std::is_same<P, std::vector<const xAOD::Muon*>>::value
         || std::is_same<P, std::vector<xAOD::Photon*>>::value
         || std::is_same<P, std::vector<const xAOD::Photon*>>::value;
 }

◆ validArgs() [2/2]

template<typename Arg1 , typename Arg2 , typename... OtherArgs>

constexpr bool ITrigGlobalEfficiencyCorrectionTool::validArgs ( unsigned nTrailingDoubles )

staticconstexpr

Definition at line 80 of file ITrigGlobalEfficiencyCorrectionTool.h.

 {
     bool xs [] = { std::is_same<OtherArgs, double>::value..., true };
     for(bool x : xs) if(!x) return validArgs<Arg1>(0) && validArgs<Arg2, OtherArgs...>(nTrailingDoubles);
     unsigned nTD = sizeof...(OtherArgs);
     if(nTD == nTrailingDoubles) return validArgs<Arg1>(0) && validArgs<Arg2>(0);
     if(nTD == nTrailingDoubles-1) return validArgs<Arg1>(0) && std::is_same<Arg2, double>::value;
     if(nTD == nTrailingDoubles-2) return std::is_same<Arg1, double>::value && std::is_same<Arg2, double>::value;
     return false;
 }

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

ITrigGlobalEfficiencyCorrectionTool.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ affectingSystematics()

◆ applySystematicVariation()

◆ checkTriggerMatching() [1/2]

◆ checkTriggerMatching() [2/2]

◆ countTriggerLegs()

◆ getEfficiency() [1/3]

◆ getEfficiency() [2/3]

◆ getEfficiency() [3/3]

◆ getEfficiencyScaleFactor() [1/3]

◆ getEfficiencyScaleFactor() [2/3]

◆ getEfficiencyScaleFactor() [3/3]

◆ getRelevantTriggers()

◆ handleArg() [1/2]

◆ handleArg() [2/2]

◆ isAffectedBySystematic()

◆ print()

◆ recommendedSystematics()

◆ toolnameForDefaultScaleFactor()

◆ validArgs() [1/2]

◆ validArgs() [2/2]