#include <CalibrationDataInterfaceTool.h>

Inheritance diagram for Analysis::CalibrationDataInterfaceTool:

Collaboration diagram for Analysis::CalibrationDataInterfaceTool:

Public Types
enum	Uncertainty { None, Total, Statistical, Systematic }
	retrieve either the total uncertainty or only the statistical or systematic components More...

enum	variableType { kEta, kAbsEta, kPt }
	known variable types that can be used as function arguments More...

Public Member Functions
	CalibrationDataInterfaceTool (const std::string &, const std::string &, const IInterface *)

virtual	~CalibrationDataInterfaceTool ()=default
	default destructor More...

StatusCode	queryInterface (const InterfaceID &riid, void **ppvIf)
	allow access to the ICalibrationDataInterfaceTool interface More...

virtual StatusCode	initialize () override
	standard Athena-Algorithm method More...

CalibResult	getEfficiency (const Jet &jet, const std::string &label, const std::string &OP, Uncertainty unc=None) const
	Main interface methods accessing the flavour tagging performance information. More...

CalibResult	getMCEfficiency (const Jet &jet, const std::string &label, const std::string &OP, Uncertainty unc=None) const
	"MC" efficiency retrieval More...

CalibResult	getScaleFactor (const Jet &jet, const std::string &label, const std::string &OP, Uncertainty unc=None) const
	efficiency scale factor retrieval More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

const std::string &	EffCalibrationName (const std::string &flavour, unsigned int mapIndex=0) const
	Main interface methods accessing the flavour tagging performance information. More...

void	setEffCalibrationNames (const std::map< std::string, std::vector< std::string > > &names)

const std::string &	SFCalibrationName (const std::string &flavour) const

void	setSFCalibrationNames (const std::map< std::string, std::string > &names)

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

std::string	getContainername (const std::string &flavour, bool SF, unsigned int mapIndex=0) const
	auxiliary function for retrieval of container name More...

std::string	getBasename (const std::string &name) const
	auxiliary function for retrieval of name within the directory More...

double	combinedUncertainty (double stat, const std::pair< double, double > &syst) const
	utility function for combination of statistical and (a priori asymmetric) systematic uncertainty. More...

Protected Attributes
std::string	m_taggerName
	tagging algorithm name More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	registerObjects (const std::string &folder, const std::string &OP) const
	auxiliary function dealing with registration of objects More...

void	retrieveFunctionArguments (const Jet &jet, const std::string &object, Double_t *x) const
	auxiliary function to retrieve values of function arguments More...

void	makeVariables (const Jet &jet, CalibrationDataVariables &x) const
	auxiliary function to create the intermediate struct needed for the data layer More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
std::string	m_EffcalibrationBName
	calibration curves for b, c, and light-flavour jets More...

std::string	m_EffcalibrationCName

std::string	m_EffcalibrationTName

std::string	m_EffcalibrationLightName

std::string	m_SFcalibrationBName

std::string	m_SFcalibrationCName

std::string	m_SFcalibrationTName

std::string	m_SFcalibrationLightName

ToolHandle< CalibrationBroker >	m_broker {this, "CalibrationBroker", "", "brief pointer to the performance broker"}
	pointer to the performance broker More...

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

std::map< std::string, std::vector< std::string > >	m_calibrationEffNames
	this simply collects the per-flavour properties. More...

std::map< std::string, std::string >	m_calibrationSFNames

Detailed Description

hold: in particular, "channel" (jet author) aliasing is possible. The difference is that run-time information is to be provided in a text file to be interpreted using ROOT's TEnv and

DB representation (all residing under a common root folder): .../<jet author>/<tagger>/<operating point>/<flavour>/<object name> where <operating point> can be a weight cut (represented as a string, with the period replaced with an underscore) or the string "Continuous" (for continuous calibration purposes).

Author: Frank Filthaut F.Fil.nosp@m.thau.nosp@m.t@sci.nosp@m.ence.nosp@m..ru.n.nosp@m.l

This tool provides an interface to flavour tagging performance estimates.

A separate instance should be used for each different tagging algorithm. For each instance, all appropriate jet collections and tagger operating points need to be specified.

The model:

b-jets: data-MC scale factor (factorised 2D function of eta, pt) MC reference the product is the data efficiency; alternatively, the scale factor may be used
c-jets: as for b-jets, but with a different MC reference
light-flavour jets: data-MC scale factor (factorised 2D function of eta, pt) MC reference Besides the results, it is also possible to retrieve associated uncertainties. This need not be configured, and a choice as to the uncertainty component can be made on a case-by-case basis.

To retrieve results from COOL, a CalibrationBroker instance is used (a separate one from the one used for tagger weight distributions). This allows to use the CalibrationBroker's channel aliasing (although possibly with different aliases). Of course it is up to the user to verify that the aliasing is appropriate!

DB representation (all residing under a common root folder): .../<jet author>/<tagger>/<operating point>/<flavour>/<object name>

Author: Frank Filthaut F.Fil.nosp@m.thau.nosp@m.t@sci.nosp@m.ence.nosp@m..ru.n.nosp@m.l

Definition at line 64 of file CalibrationDataInterfaceTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ Uncertainty

enum Analysis::ICalibrationDataInterfaceTool::Uncertainty

inherited

retrieve either the total uncertainty or only the statistical or systematic components

Enumerator
None
Total
Statistical
Systematic

Definition at line 28 of file ICalibrationDataInterfaceTool.h.

28 { None, Total, Statistical, Systematic };

◆ variableType

enum Analysis::CalibrationDataInterfaceBase::variableType

inherited

known variable types that can be used as function arguments

Enumerator
kEta
kAbsEta
kPt

Definition at line 67 of file CalibrationDataInterfaceBase.h.

67 { kEta, kAbsEta, kPt };

Constructor & Destructor Documentation

◆ CalibrationDataInterfaceTool()

Analysis::CalibrationDataInterfaceTool::CalibrationDataInterfaceTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

Definition at line 28 of file CalibrationDataInterfaceTool.cxx.

                                                             :
   AthAlgTool(t,n,p),
   m_broker("PerformanceBroker")
 {
   declareInterface<Analysis::ICalibrationDataInterfaceTool>(this);
  
   declareProperty("taggerName", m_taggerName = "undefined",
           "tagging algorithm name");
   declareProperty("operatingPoints", m_operatingPoints,
           "operating points for this tagging algorithm");
   declareProperty("efficiencyCalibrationBName", m_EffcalibrationBName = "default",
           "efficiency calibration curve for b jets");
   declareProperty("efficiencyCalibrationCName", m_EffcalibrationCName = "default",
           "efficiency calibration curve for c jets");
   declareProperty("efficiencyCalibrationTName", m_EffcalibrationTName = "default",
           "efficiency calibration curve for tau jets");
   declareProperty("efficiencyCalibrationLightName", m_EffcalibrationLightName = "default",
           "efficiency calibration curve for light-flavour jets");
   declareProperty("scaleFactorCalibrationBName", m_SFcalibrationBName = "default",
           "scale factor calibration curve for b jets");
   declareProperty("scaleFactorCalibrationCName", m_SFcalibrationCName = "default",
           "scale factor calibration curve for c jets");
   declareProperty("scaleFactorCalibrationTName", m_SFcalibrationTName = "default",
           "scale factor calibration curve for tau jets");
   declareProperty("scaleFactorCalibrationLightName", m_SFcalibrationLightName = "default",
           "scale factor calibration curve for light-flavour jets");
   declareProperty("PerformanceBroker", m_broker,
           "tool interfacing with COOL Database");
 }

◆ ~CalibrationDataInterfaceTool()

virtual Analysis::CalibrationDataInterfaceTool::~CalibrationDataInterfaceTool ( )

virtualdefault

default destructor

Member Function Documentation

◆ combinedUncertainty()

double Analysis::CalibrationDataInterfaceBase::combinedUncertainty	(	double	stat,
		const std::pair< double, double > &	syst
	)		const

protectedinherited

utility function for combination of statistical and (a priori asymmetric) systematic uncertainty.

NB perhaps this should be in its own

Definition at line 147 of file CalibrationDataInterfaceBase.cxx.

 {
   // Return the total (combined statistical and systematic) uncertainty started from
   // its individual components. The result is symmetrised by using only the larger of
   // the (a priori asymmetric) up- and downward systematic uncertainties.
  
   // The systematic uncertainty is (a priori) asymmetric, but this interface doesn't
   // at present allow for asymmetric uncertainties.
   // Address this by taking the larger (absolute) value of the two.
   double largest = syst.first;
   if (TMath::Abs(syst.second) > TMath::Abs(largest)) largest = syst.second;
  
   return TMath::Sqrt(stat*stat + largest*largest);
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ EffCalibrationName()

const std::string & Analysis::CalibrationDataInterfaceBase::EffCalibrationName	(	const std::string &	flavour,
		unsigned int	mapIndex = `0`
	)		const

inherited

Main interface methods accessing the flavour tagging performance information.

Note that for both of the following, the label is assumed to adhere to the TruthInfo conventions (see package PhysicsAnalysis/JetTagging/JetTagInfo).

Definition at line 47 of file CalibrationDataInterfaceBase.cxx.

 {
   // Return the MC efficiency name for the given flavour.
   // Note that no check is performed on the validity of the flavour.
   
   try {
     return m_calibrationEffNames.at(flavour)[mapIndex];
   }
   catch (const std::out_of_range& e) {
     std::cerr << "EffCalibrationName: flavour '" << flavour << "' is not known." << std::endl;
     throw e;
   }
 }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getBasename()

std::string Analysis::CalibrationDataInterfaceBase::getBasename ( const std::string & name ) const

protectedinherited

auxiliary function for retrieval of name within the directory

Definition at line 138 of file CalibrationDataInterfaceBase.cxx.

 {
   // Retrieve the name within the directory starting from the full name
  
   return name.substr(name.find_last_of('/')+1, std::string::npos);
 }

◆ getContainername()

std::string Analysis::CalibrationDataInterfaceBase::getContainername	(	const std::string &	flavour,
		bool	SF,
		unsigned int	mapIndex = `0`
	)		const

protectedinherited

auxiliary function for retrieval of container name

Definition at line 118 of file CalibrationDataInterfaceBase.cxx.

 {
   // Construct the full pathname corresponding to the container indicated by the combination
   // of tagging operating point, jet flavour, and a possible extra extension. The calibration
   // container name (stored internally) is also attached.
  
   const std::vector<std::string>& effNames = m_calibrationEffNames.at(flavour);
   if (!SF && mapIndex >= effNames.size()) {
     std::cerr << "getContainername: given mapIndex=" << mapIndex << " incompatible with array size "
           << effNames.size() << "; resetting to 0" << std::endl;
     mapIndex = 0;
   }
   std::string name = SF ? m_calibrationSFNames.at(flavour) : effNames[mapIndex];
   name += SF ? "_SF" : "_Eff";
  
   return name;
 }

◆ getEfficiency()

Analysis::CalibResult Analysis::CalibrationDataInterfaceTool::getEfficiency	(	const Jet &	jet,
		const std::string &	label,
		const std::string &	OP,
		Uncertainty	unc = `None`
	)		const

virtual

Main interface methods accessing the flavour tagging performance information.

Note that for both of the following, the label is assumed to adhere to the TruthInfo conventions (see package PhysicsAnalysis/JetTagging/JetTagInfo). efficiency retrieval

Implements Analysis::ICalibrationDataInterfaceTool.

Definition at line 287 of file CalibrationDataInterfaceTool.cxx.

 {
   Analysis::CalibResult sfResult = getScaleFactor(jet, label, OP, unc);
   Analysis::CalibResult effResult = getMCEfficiency(jet, label, OP, unc);
  
   double relative = 0;
   double value = effResult.first*sfResult.first;
   if (value != 0) {
     relative = effResult.second/effResult.first;
     double sfRelative = sfResult.second/sfResult.first;
     relative = std::sqrt(sfRelative*sfRelative + relative*relative);
   } else {
     ATH_MSG_WARNING("in " << name() << ": null result, SF=" << sfResult.first
             << " MC eff=" << effResult.first);
     relative = Analysis::dummyValue;
   }
  
   return std::make_pair(value,value*relative);
 }

◆ getMCEfficiency()

Analysis::CalibResult Analysis::CalibrationDataInterfaceTool::getMCEfficiency	(	const Jet &	jet,
		const std::string &	label,
		const std::string &	OP,
		Uncertainty	unc = `None`
	)		const

virtual

"MC" efficiency retrieval

Implements Analysis::ICalibrationDataInterfaceTool.

Definition at line 225 of file CalibrationDataInterfaceTool.cxx.

 {
   // extract the relevant jet quantities: kinematic variables and jet author
  
   // for light-flavour jets, rename from "N/A"
   string flavour(label);
   if (flavour == "N/A") flavour = "Light";
  
   string author = jet.jetAuthor();
  
   string effName(getBasename(OP, flavour, "_Eff", false));
  
   // Return a dummy result if the object is not found
   std::pair<CalibrationDataContainer*,bool> ret =
     m_broker->retrieveTObject<CalibrationDataContainer>(m_taggerName, author, effName);
   CalibrationDataContainer* container = ret.first;
   if (! container) {
     ATH_MSG_WARNING("in " << name() << ": unable to find Eff calibration for object with "
             << "tagger/jetCollection/flavour/operating point = "
             << m_taggerName << "/" << author << "/" << flavour << "/" << OP);
     return Analysis::dummyResult;
   }
  
   /* Here, it isn't obvious what to do with the second element of the pair returned:
      This indicates whether a new object has been loaded (presumably due to IOV changes),
      but the CalibrationDataContainer should take of any necessary computations itself.
    */
  
   // fill the CalibrationDataVariables object
   CalibrationDataVariables variables;
   makeVariables (jet, variables);
  
   // always retrieve the result itself
   double value;
   if (container->getResult(variables, value) == CalibrationDataContainer::kError)
     return Analysis::dummyResult;
  
   // retrieve the statistical uncertainty if desired
   double stat(0);
   if (unc == Total || unc == Statistical) {
     if (container->getStatUncertainty(variables, stat) == CalibrationDataContainer::kError)
       cerr << "getMCEfficiency: error retrieving MC efficiency statistical uncertainty!"
        << endl;
   }
   UncertaintyResult resSyst(0,0);
   if (unc == Total || unc == Systematic) {
     if (container->getSystUncertainty(variables, resSyst) == CalibrationDataContainer::kError)
       cerr << "getMCEfficiency: error retrieving MC efficiency parameter systematic uncertainty!"
        << endl;
   }
  
   double uncertainty = combinedUncertainty(stat, resSyst);
   Analysis::CalibResult result = std::make_pair(value, uncertainty);
  
   result.first = std::max(0., std::min(1., result.first));
   return result;
 }

◆ getScaleFactor()

Analysis::CalibResult Analysis::CalibrationDataInterfaceTool::getScaleFactor	(	const Jet &	jet,
		const std::string &	label,
		const std::string &	OP,
		Uncertainty	unc = `None`
	)		const

virtual

efficiency scale factor retrieval

Implements Analysis::ICalibrationDataInterfaceTool.

Definition at line 160 of file CalibrationDataInterfaceTool.cxx.

 {
   // // For now, a calibration for the charm efficiency scale factor is assumed not to exist
   // if (label == "C") return getScaleFactor(jet, "B", OP, unc);
  
   // for light-flavour jets, rename from "N/A"
   string flavour(label);
   if (flavour == "N/A") flavour = "Light";
  
   string author = jet.jetAuthor();
  
   string sfName(getBasename(OP, flavour, "_SF", true));
  
   // Return a dummy result if the object is not found
   std::pair<CalibrationDataContainer*,bool> ret =
     m_broker->retrieveTObject<CalibrationDataContainer>(m_taggerName, author, sfName);
   CalibrationDataContainer* container = ret.first;
   if (! container) {
     ATH_MSG_WARNING("in " << name() << ": unable to find SF calibration for object with "
             << "tagger/jetCollection/flavour/operating point = "
             << m_taggerName << "/" << author << "/" << flavour << "/" << OP);
     return Analysis::dummyResult;
   }
  
   /* Here, it isn't obvious what to do with the second element of the pair returned:
      This indicates whether a new object has been loaded (presumably due to IOV changes),
      but the CalibrationDataContainer should take of any necessary computations itself.
    */
  
   // fill the CalibrationDataVariables object
   CalibrationDataVariables variables;
   makeVariables (jet, variables);
  
   // always retrieve the result itself
   double value;
   if (container->getResult(variables, value) == CalibrationDataContainer::kError)
     return Analysis::dummyResult;
  
   // retrieve the statistical uncertainty if desired
   double stat(0);
   if (unc == Total || unc == Statistical) {
     if (container->getStatUncertainty(variables, stat) == CalibrationDataContainer::kError)
       cerr << "getScaleFactor: error retrieving Scale factor statistical uncertainty!"
        << endl;
   }
   UncertaintyResult resSyst(0,0);
   if (unc == Total || unc == Systematic) {
     if (container->getSystUncertainty(variables, resSyst) == CalibrationDataContainer::kError)
       cerr << "getScaleFactor: error retrieving Scale factor parameter systematic uncertainty!"
        << endl;
   }
  
   double uncertainty = combinedUncertainty(stat, resSyst);
   Analysis::CalibResult result = std::make_pair(value, uncertainty);
  
   result.first = std::max(0., result.first);
   if (std::abs(result.first) < Analysis::CalibZERO)
     result.first = 1.;
   return result;
 }

◆ initialize()

StatusCode Analysis::CalibrationDataInterfaceTool::initialize ( )

overridevirtual

standard Athena-Algorithm method

Definition at line 75 of file CalibrationDataInterfaceTool.cxx.

 {
   
 //  StatusCode sc = AthAlgTool::initialize();
 //  if (sc.isFailure()) return sc;
 //
 //  sc = m_broker.retrieve();
 //  if (sc.isFailure()) {
 //    ATH_MSG_FATAL("initialize() in " << name() << ": unable to retrieve CalibrationBroker tool!");
 //    return sc;
 //  }
  
   string::size_type end;
  
   std::vector<string> calibrationBNames;
   if (m_EffcalibrationBName.size() > 0) {
     do {
       end = m_EffcalibrationBName.find(";");
       calibrationBNames.push_back(m_EffcalibrationBName.substr(0,end));
       if (end != string::npos) m_EffcalibrationBName = m_EffcalibrationBName.substr(end+1);
     } while (end != string::npos);
   }
  
   std::vector<string> calibrationCNames;
   if (m_EffcalibrationCName.size() > 0) {
     do {
       end = m_EffcalibrationCName.find(";");
       calibrationCNames.push_back(m_EffcalibrationCName.substr(0,end));
       if (end != string::npos) m_EffcalibrationCName = m_EffcalibrationCName.substr(end+1);
     } while (end != string::npos);
   }
  
   std::vector<string> calibrationTNames;
   if (m_EffcalibrationTName.size() > 0) {
     do {
       end = m_EffcalibrationTName.find(";");
       calibrationTNames.push_back(m_EffcalibrationTName.substr(0,end));
       if (end != string::npos) m_EffcalibrationTName = m_EffcalibrationTName.substr(end+1);
     } while (end != string::npos);
   }
  
   std::vector<string> calibrationLightNames;
   if (m_EffcalibrationLightName.size() > 0) {
     do {
       end = m_EffcalibrationLightName.find(";");
       calibrationLightNames.push_back(m_EffcalibrationLightName.substr(0,end));
       if (end != string::npos) m_EffcalibrationLightName = m_EffcalibrationLightName.substr(end+1);
     } while (end != string::npos);
   }
  
  
   // insert the calibration names into a common object
   std::map<string, std::vector<string> > effNames;
   effNames["B"] = calibrationBNames;
   effNames["C"] = calibrationCNames;
   effNames["T"] = calibrationTNames;
   effNames["Light"] = calibrationLightNames;
   setEffCalibrationNames(effNames);
  
   // insert the calibration names into a common object
   std::map<string, string> calibrationNames;
   calibrationNames["B"] = m_SFcalibrationBName;
   calibrationNames["C"] = m_SFcalibrationCName;
   calibrationNames["T"] = m_SFcalibrationTName;
   calibrationNames["Light"] = m_SFcalibrationLightName;
   setSFCalibrationNames(calibrationNames);
  
   // register all objects
   for (std::map<string, string>::const_iterator it = calibrationNames.begin();
        it != calibrationNames.end(); ++it) {
     for (std::vector<string>::const_iterator op = m_operatingPoints.begin();
      op != m_operatingPoints.end(); ++op) {
       registerObjects(it->first, *op);
     }
   }
  
   ATH_MSG_INFO("initialize() successful in " << name());
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

static const InterfaceID& Analysis::ICalibrationDataInterfaceTool::interfaceID ( )

inlinestaticinherited

Definition at line 23 of file ICalibrationDataInterfaceTool.h.

                                             {
       return IID_ICalibrationDataInterfaceTool;
     }

◆ makeVariables()

void Analysis::CalibrationDataInterfaceTool::makeVariables	(	const Jet &	jet,
		CalibrationDataVariables &	x
	)		const

private

auxiliary function to create the intermediate struct needed for the data layer

Definition at line 325 of file CalibrationDataInterfaceTool.cxx.

 {
   x.jetAuthor = jet.jetAuthor();
   x.jetPt = jet.pt() * 0.001;  // NB convert from MeV to GeV!
   x.jetEta = jet.eta();
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ queryInterface()

StatusCode Analysis::CalibrationDataInterfaceTool::queryInterface	(	const InterfaceID &	riid,
		void **	ppvIf
	)

allow access to the ICalibrationDataInterfaceTool interface

Definition at line 62 of file CalibrationDataInterfaceTool.cxx.

 {
    if ( riid == ICalibrationDataInterfaceTool::interfaceID() )  {
       *ppvIf = (ICalibrationDataInterfaceTool*)this;
       addRef();
       return StatusCode::SUCCESS;
    }
  
    return AthAlgTool::queryInterface( riid, ppvIf );
 }

◆ registerObjects()

void Analysis::CalibrationDataInterfaceTool::registerObjects	(	const std::string &	folder,
		const std::string &	OP
	)		const

private

auxiliary function dealing with registration of objects

Definition at line 310 of file CalibrationDataInterfaceTool.cxx.

 {
   static const string slash("/");
  
   string common = OP; common += slash;
   common += flavour; common += slash;
   string nameEff(common); nameEff += EffCalibrationName(flavour); nameEff += "_Eff";
   string nameSF(common); nameSF += SFCalibrationName(flavour); nameSF += "_SF";
  
   m_broker->registerHistogram(m_taggerName, nameSF);
   m_broker->registerHistogram(m_taggerName, nameEff);
 }

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ retrieveFunctionArguments()

void Analysis::CalibrationDataInterfaceTool::retrieveFunctionArguments	(	const Jet &	jet,
		const std::string &	object,
		Double_t *	x
	)		const

private

auxiliary function to retrieve values of function arguments

◆ setEffCalibrationNames()

void Analysis::CalibrationDataInterfaceBase::setEffCalibrationNames ( const std::map< std::string, std::vector< std::string > > & names )

inherited

Definition at line 63 of file CalibrationDataInterfaceBase.cxx.

 {
   // Set the MC efficiency names.
  
   m_calibrationEffNames = names;
 }

◆ setSFCalibrationNames()

void Analysis::CalibrationDataInterfaceBase::setSFCalibrationNames ( const std::map< std::string, std::string > & names )

inherited

Definition at line 87 of file CalibrationDataInterfaceBase.cxx.

 {
   // Set the efficiency scale factor calibration names.
  
   m_calibrationSFNames = names;
 }

◆ SFCalibrationName()

const std::string & Analysis::CalibrationDataInterfaceBase::SFCalibrationName ( const std::string & flavour ) const

inherited

Definition at line 72 of file CalibrationDataInterfaceBase.cxx.

 {
   // Return the efficiency scale factor calibration name for the given flavour.
   // Note that no check is performed on the validity of the flavour.
  
   try {
     return m_calibrationSFNames.at(flavour);
   }
   catch (const std::out_of_range& e) {
     std::cerr << "SFCalibrationName: flavour '" << flavour << "' is not known." << std::endl;
     throw e;
   }
 }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_broker

ToolHandle<CalibrationBroker> Analysis::CalibrationDataInterfaceTool::m_broker {this, "CalibrationBroker", "", "brief pointer to the performance broker"}

private

pointer to the performance broker

Definition at line 121 of file CalibrationDataInterfaceTool.h.

◆ m_calibrationEffNames

std::map<std::string, std::vector<std::string> > Analysis::CalibrationDataInterfaceBase::m_calibrationEffNames

privateinherited

this simply collects the per-flavour properties.

Definition at line 72 of file CalibrationDataInterfaceBase.h.

◆ m_calibrationSFNames

std::map<std::string, std::string> Analysis::CalibrationDataInterfaceBase::m_calibrationSFNames

privateinherited

Definition at line 73 of file CalibrationDataInterfaceBase.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_EffcalibrationBName

std::string Analysis::CalibrationDataInterfaceTool::m_EffcalibrationBName

private

calibration curves for b, c, and light-flavour jets

Definition at line 111 of file CalibrationDataInterfaceTool.h.

◆ m_EffcalibrationCName

std::string Analysis::CalibrationDataInterfaceTool::m_EffcalibrationCName

private

Definition at line 112 of file CalibrationDataInterfaceTool.h.

◆ m_EffcalibrationLightName

std::string Analysis::CalibrationDataInterfaceTool::m_EffcalibrationLightName

private

Definition at line 114 of file CalibrationDataInterfaceTool.h.

◆ m_EffcalibrationTName

std::string Analysis::CalibrationDataInterfaceTool::m_EffcalibrationTName

private

Definition at line 113 of file CalibrationDataInterfaceTool.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_SFcalibrationBName

std::string Analysis::CalibrationDataInterfaceTool::m_SFcalibrationBName

private

Definition at line 115 of file CalibrationDataInterfaceTool.h.

◆ m_SFcalibrationCName

std::string Analysis::CalibrationDataInterfaceTool::m_SFcalibrationCName

private

Definition at line 116 of file CalibrationDataInterfaceTool.h.

◆ m_SFcalibrationLightName

std::string Analysis::CalibrationDataInterfaceTool::m_SFcalibrationLightName

private

Definition at line 118 of file CalibrationDataInterfaceTool.h.

◆ m_SFcalibrationTName

std::string Analysis::CalibrationDataInterfaceTool::m_SFcalibrationTName

private

Definition at line 117 of file CalibrationDataInterfaceTool.h.

◆ m_taggerName

std::string Analysis::CalibrationDataInterfaceBase::m_taggerName

protectedinherited

tagging algorithm name

Definition at line 94 of file CalibrationDataInterfaceBase.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ Uncertainty

◆ variableType

Constructor & Destructor Documentation

◆ CalibrationDataInterfaceTool()

◆ ~CalibrationDataInterfaceTool()

Member Function Documentation

◆ combinedUncertainty()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ EffCalibrationName()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getBasename()

◆ getContainername()

◆ getEfficiency()

◆ getMCEfficiency()

◆ getScaleFactor()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ makeVariables()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ queryInterface()

◆ registerObjects()

◆ renounce()

◆ renounceArray()

◆ retrieveFunctionArguments()

◆ setEffCalibrationNames()

◆ setSFCalibrationNames()

◆ SFCalibrationName()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_broker

◆ m_calibrationEffNames

◆ m_calibrationSFNames

◆ m_detStore

◆ m_EffcalibrationBName

◆ m_EffcalibrationCName

◆ m_EffcalibrationLightName

◆ m_EffcalibrationTName

◆ m_evtStore

◆ m_SFcalibrationBName

◆ m_SFcalibrationCName

◆ m_SFcalibrationLightName

◆ m_SFcalibrationTName

◆ m_taggerName

◆ m_varHandleArraysDeclared

◆ m_vhka