#include <DiTauEfficiencyCorrectionsTool.h>

Inheritance diagram for TauAnalysisTools::DiTauEfficiencyCorrectionsTool:

Collaboration diagram for TauAnalysisTools::DiTauEfficiencyCorrectionsTool:

Public Member Functions
	DiTauEfficiencyCorrectionsTool (const std::string &sName)
	Create a proper constructor for Athena. More...

	~DiTauEfficiencyCorrectionsTool ()

virtual StatusCode	initialize ()
	Function initialising the tool. More...

virtual void	printConfig () const
	Print tool configuration. More...

virtual CP::CorrectionCode	getEfficiencyScaleFactor (const xAOD::DiTauJet &xDiTau, double &eff, unsigned int iRunNumber=0, unsigned int iMu=0)
	Get the ditau Efficiency Scale Factor as a return value. More...

virtual CP::CorrectionCode	applyEfficiencyScaleFactor (const xAOD::DiTauJet &xDiTau, unsigned int iRunNumber=0, unsigned int iMu=0)
	decorate the ditau jet with eff scale factor More...

virtual bool	isAffectedBySystematic (const CP::SystematicVariation &systematic) const
	returns whether this tool is affected by the given systematic More...

virtual CP::SystematicSet	affectingSystematics () const
	returns: the list of all systematics this tool can be affected by More...

virtual CP::SystematicSet	recommendedSystematics () const
	returns: the list of all systematics this tool recommends to use More...

virtual StatusCode	applySystematicVariation (const CP::SystematicSet &systConfig)
	apply systematic variations More...

virtual bool	isSupportedRunNumber (int) const
	check if run number is supperted in recommendations More...

virtual void	print () const =0
	Print the state of the tool. More...

virtual StatusCode	sysInitialize ()
	Function initialising the tool in the correct way in Athena. More...

virtual void	print () const
	Print the state of the tool. 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	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

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	beginEvent ()
	Function called when a new events is loaded. More...

std::string	ConvertJetIDToString (const int iLevel) const

StatusCode	initializeTools_2017_moriond ()
	Initialize Moriond 2017 recommendations. 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::vector< int >	m_vEfficiencyCorrectionTypes

std::vector< asg::AnaToolHandle< IDiTauEfficiencyCorrectionsTool > * >	m_vCommonEfficiencyTools

std::string	m_sInputFilePathJetIDHadTau

std::string	m_sVarNameJetIDHadTau

std::string	m_sRecommendationTag

bool	m_bSkipTruthMatchCheck

bool	m_bIsData

bool	m_bIsConfigured

int	m_iJetIDLevel

MetaStore_t	m_inputMetaStore
	Object accessing the input metadata store. More...

MetaStore_t	m_outputMetaStore
	Object accessing the output metadata store. More...

bool	m_beginInputFileCalled
	Flag helping to discover when the tool misses the opening of the first input file. More...

bool	m_useIncidents

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

Callback functions helping in metadata reading/writing
void	setUseIncidents (const bool flag)

virtual void	handle (const Incident &inc)
	Function receiving incidents from IncidentSvc/TEvent. More...

virtual StatusCode	beginInputFile ()
	Function called when a new input file is opened. More...

virtual StatusCode	endInputFile ()
	Function called when the currently open input file got completely processed. More...

virtual StatusCode	metaDataStop ()
	Function called when the tool should write out its metadata. More...

Detailed Description

Definition at line 29 of file DiTauEfficiencyCorrectionsTool.h.

Member Typedef Documentation

◆ MetaStore_t

typedef ServiceHandle< StoreGateSvc > asg::AsgMetadataTool::MetaStore_t

inherited

Type of the metadata store object in Athena.

Definition at line 66 of file AsgMetadataTool.h.

◆ MetaStorePtr_t

typedef const ServiceHandle< StoreGateSvc >& asg::AsgMetadataTool::MetaStorePtr_t

inherited

Type of the metadata store pointer in standalone mode.

Definition at line 68 of file AsgMetadataTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ DiTauEfficiencyCorrectionsTool()

TauAnalysisTools::DiTauEfficiencyCorrectionsTool::DiTauEfficiencyCorrectionsTool ( const std::string & sName )

Create a proper constructor for Athena.

Definition at line 25 of file DiTauEfficiencyCorrectionsTool.cxx.

   : asg::AsgMetadataTool( sName )
   , m_vCommonEfficiencyTools()
   , m_bIsData(false)
   , m_bIsConfigured(false)
 {
   declareProperty( "EfficiencyCorrectionTypes",    m_vEfficiencyCorrectionTypes    = {} );
   declareProperty( "InputFilePathJetIDHadTau",     m_sInputFilePathJetIDHadTau     = "" );
   declareProperty( "VarNameJetIDHadTau",           m_sVarNameJetIDHadTau           = "" );
   declareProperty( "RecommendationTag",            m_sRecommendationTag            = "2017-moriond" );
   declareProperty( "JetIDLevel",                   m_iJetIDLevel                   = (int)JETIDBDTTIGHT );
   declareProperty( "SkipTruthMatchCheck",          m_bSkipTruthMatchCheck          = false );
 }

◆ ~DiTauEfficiencyCorrectionsTool()

TauAnalysisTools::DiTauEfficiencyCorrectionsTool::~DiTauEfficiencyCorrectionsTool ( )

Definition at line 41 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   for (auto tTool : m_vCommonEfficiencyTools)
     delete tTool;
 }

Member Function Documentation

◆ affectingSystematics()

CP::SystematicSet TauAnalysisTools::DiTauEfficiencyCorrectionsTool::affectingSystematics ( ) const

virtual

returns: the list of all systematics this tool can be affected by

Implements CP::IReentrantSystematicsTool.

Definition at line 167 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   CP::SystematicSet sAffectingSystematics;
   for (auto it = m_vCommonEfficiencyTools.begin(); it != m_vCommonEfficiencyTools.end(); it++)
     sAffectingSystematics.insert((**it)->affectingSystematics());
   return sAffectingSystematics;
 }

◆ applyEfficiencyScaleFactor()

CP::CorrectionCode TauAnalysisTools::DiTauEfficiencyCorrectionsTool::applyEfficiencyScaleFactor	(	const xAOD::DiTauJet &	xDiTau,
		unsigned int	iRunNumber = `0`,
		unsigned int	iMu = `0`
	)

virtual

decorate the ditau jet with eff scale factor

Parameters

xDiTau	: reco DiTauJet
iRunNumber	: run number
iMu	: number of interactions

Returns: CP::CorrectionCode

Implements TauAnalysisTools::IDiTauEfficiencyCorrectionsTool.

Definition at line 138 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   if (m_bIsData)
     return CP::CorrectionCode::Ok;
  
   for (auto it = m_vCommonEfficiencyTools.begin(); it != m_vCommonEfficiencyTools.end(); it++)
   {
     CP::CorrectionCode tmpCorrectionCode = (**it)->applyEfficiencyScaleFactor(xDiTau, iRunNumber, iMu);
     if (tmpCorrectionCode != CP::CorrectionCode::Ok)
     {
       return tmpCorrectionCode;
     }
   }
   return CP::CorrectionCode::Ok;
 }

◆ applySystematicVariation()

StatusCode TauAnalysisTools::DiTauEfficiencyCorrectionsTool::applySystematicVariation ( const CP::SystematicSet & systConfig )

virtual

apply systematic variations

Implements CP::ISystematicsTool.

Definition at line 188 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   for (auto it = m_vCommonEfficiencyTools.begin(); it != m_vCommonEfficiencyTools.end(); it++)
     if ((**it)->applySystematicVariation(sSystematicSet) == StatusCode::FAILURE)
     {
       return StatusCode::FAILURE;
     }
   return StatusCode::SUCCESS;
 }

◆ beginEvent()

StatusCode TauAnalysisTools::DiTauEfficiencyCorrectionsTool::beginEvent ( )

privatevirtual

Function called when a new events is loaded.

Dummy implementation that can be overridden by the derived tool.

Reimplemented from asg::AsgMetadataTool.

Definition at line 91 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   if (!m_bIsConfigured)
   {
     const xAOD::EventInfo* xEventInfo = nullptr;
     ATH_CHECK(evtStore()->retrieve(xEventInfo,"EventInfo"));
     m_bIsData = !(xEventInfo->eventType( xAOD::EventInfo::IS_SIMULATION));
     m_bIsConfigured = true;
   }
  
   return StatusCode::SUCCESS;
 }

◆ beginInputFile()

StatusCode asg::AsgMetadataTool::beginInputFile ( )

protectedvirtualinherited

Function called when a new input file is opened.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in AsgElectronEfficiencyCorrectionTool, TrigConf::xAODConfigTool, PMGTools::PMGTruthWeightTool, BookkeeperTool, xAODMaker::FileMetaDataTool, BookkeeperDumperTool, Trig::TrigDecisionTool, xAODMaker::TriggerMenuMetaDataTool, xAODMaker::TruthMetaDataTool, Trig::xAODBunchCrossingTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, and TauAnalysisTools::TauSmearingTool.

Definition at line 180 of file AsgMetadataTool.cxx.

                                               {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ ConvertJetIDToString()

std::string TauAnalysisTools::DiTauEfficiencyCorrectionsTool::ConvertJetIDToString ( const int iLevel ) const

private

Definition at line 229 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   switch(iLevel)
   {
   case JETIDNONE:
     return "ditaureconstruction";
     break;
   case JETIDBDTVERYLOOSE:
     return "jetbdtsigveryloose";
     break;
   case JETIDBDTLOOSE:
     return "jetbdtsigloose";
     break;
   case JETIDBDTMEDIUM:
     return "jetbdtsigmedium";
     break;
   case JETIDBDTTIGHT:
     return "jetbdtsigtight";
     break;
   default:
     assert(false && "No valid ID level passed. Breaking up ...");
     break;
   }
   return "";
 }

◆ 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; }

◆ endInputFile()

StatusCode asg::AsgMetadataTool::endInputFile ( )

protectedvirtualinherited

Function called when the currently open input file got completely processed.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperTool, xAODMaker::FileMetaDataTool, BookkeeperDumperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 188 of file AsgMetadataTool.cxx.

                                             {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ 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

◆ getEfficiencyScaleFactor()

CP::CorrectionCode TauAnalysisTools::DiTauEfficiencyCorrectionsTool::getEfficiencyScaleFactor	(	const xAOD::DiTauJet &	xDiTau,
		double &	eff,
		unsigned int	iRunNumber = `0`,
		unsigned int	iMu = `0`
	)

virtual

Get the ditau Efficiency Scale Factor as a return value.

Parameters

xDiTau	: reco DiTauJet
eff	: reference to output variable where efficiency is returned
iRunNumber	: run number
iMu	: number of interactions

Returns: CP::CorrectionCode

Implements TauAnalysisTools::IDiTauEfficiencyCorrectionsTool.

Definition at line 118 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   eff = 1.;
  
   if (m_bIsData)
     return CP::CorrectionCode::Ok;
  
   for (auto it = m_vCommonEfficiencyTools.begin(); it != m_vCommonEfficiencyTools.end(); it++)
   {
     double dToolEff = 1.;
     CP::CorrectionCode tmpCorrectionCode = (**it)->getEfficiencyScaleFactor(xDiTau, dToolEff);
     if (tmpCorrectionCode != CP::CorrectionCode::Ok)
       return tmpCorrectionCode;
     eff *= dToolEff;
   }
   return CP::CorrectionCode::Ok;
 }

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                     {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getKey( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       return ( proxy == nullptr ? 0 : proxy->sgkey() );
 #endif // XAOD_STANDALONE
    }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                             {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getName( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       static const std::string dummy = "";
       return ( proxy == nullptr ? dummy : proxy->name() );
 #endif // XAOD_STANDALONE
    }

◆ getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ handle()

void asg::AsgMetadataTool::handle ( const Incident & inc )

protectedvirtualinherited

Function receiving incidents from IncidentSvc/TEvent.

Reimplemented in Trig::TrigDecisionTool.

Definition at line 130 of file AsgMetadataTool.cxx.

                                                      {
  
       // Tell the user what's happening:
       ATH_MSG_VERBOSE( "Callback received with incident: " << inc.type() );
  
       // Call the appropriate member function:
       if( inc.type() == IncidentType::BeginInputFile ) {
         m_beginInputFileCalled = true;
         if( beginInputFile().isFailure() ) {
           ATH_MSG_FATAL( "Failed to call beginInputFile()" );
           throw std::runtime_error( "Couldn't call beginInputFile()" );
          }
       } else if( inc.type() == IncidentType::EndInputFile ) {
         if( endInputFile().isFailure() ) {
           ATH_MSG_FATAL( "Failed to call endInputFile()" );
           throw std::runtime_error( "Couldn't call endInputFile()" );
          }
       } else if( inc.type() == IncidentType::BeginEvent ) {
          // If the tool didn't catch the begin input file incident for the
          // first input file of the job, then call the appropriate function
          // now.
          if( ! m_beginInputFileCalled ) {
             m_beginInputFileCalled = true;
             if( beginInputFile().isFailure() ) {
                ATH_MSG_FATAL( "Failed to call beginInputFile()" );
                throw std::runtime_error( "Couldn't call beginInputFile()" );
             }
          }
          if( beginEvent().isFailure() ) {
             ATH_MSG_FATAL( "Failed to call beginEvent()" );
             throw std::runtime_error( "Couldn't call beginEvent()" );
          }
  
      #ifdef XAOD_STANDALONE
       } else if( inc.type() == IncidentType::MetaDataStop ) {
          if( metaDataStop().isFailure() ) {
             ATH_MSG_FATAL( "Failed to call metaDataStop()" );
             throw std::runtime_error( "Couldn't call metaDataStop()" );
          }
          
      #endif // XAOD_STANDALONE
       } else {
          ATH_MSG_WARNING( "Unknown incident type received in AsgMetaDataTool: " << inc.type() );
       }
  
       return;
    }

◆ initialize()

StatusCode TauAnalysisTools::DiTauEfficiencyCorrectionsTool::initialize ( )

virtual

Function initialising the tool.

Reimplemented from asg::AsgTool.

Definition at line 49 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   // Greet the user:
   ATH_MSG_INFO( "Initializing DiTauEfficiencyCorrectionsTool" );
  
   if (m_bSkipTruthMatchCheck)
     ATH_MSG_WARNING("Truth match check will be skipped. This is ONLY FOR TESTING PURPOSE!");
  
   // configure default set of variations if not set by the constructor using TauSelectionTool or the user
   if ((m_sRecommendationTag== "2017-moriond") and m_vEfficiencyCorrectionTypes.empty())
     m_vEfficiencyCorrectionTypes = {SFJetIDHadTau
                                    };
  
   if (m_sRecommendationTag == "2017-moriond")
     ATH_CHECK(initializeTools_2017_moriond());
   else
   {
     ATH_MSG_FATAL("Unknown RecommendationTag: "<<m_sRecommendationTag);
     return StatusCode::FAILURE;
   }
  
   for (auto it = m_vCommonEfficiencyTools.begin(); it != m_vCommonEfficiencyTools.end(); it++)
   {
     ATH_CHECK((**it).setProperty("OutputLevel", this->msg().level()));
     ATH_CHECK((**it).initialize());
   }
  
   // Add the affecting systematics to the global registry
   CP::SystematicRegistry& registry = CP::SystematicRegistry::getInstance();
   if (!registry.registerSystematics(*this))
   {
     ATH_MSG_ERROR ("Unable to register the systematics");
     return StatusCode::FAILURE;
   }
  
   printConfig();
  
   return StatusCode::SUCCESS;
 }

◆ initializeTools_2017_moriond()

StatusCode TauAnalysisTools::DiTauEfficiencyCorrectionsTool::initializeTools_2017_moriond ( )

private

Initialize Moriond 2017 recommendations.

Definition at line 201 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   std::string sDirectory = "TauAnalysisTools/" + std::string(sSharedFilesVersion) + "/EfficiencyCorrections/";
   for (auto iEfficiencyCorrectionType : m_vEfficiencyCorrectionTypes)
   {
     if (iEfficiencyCorrectionType == SFJetIDHadTau)
     {
       // only set vars if they have been configured by the user
       if (m_sInputFilePathJetIDHadTau.empty()) m_sInputFilePathJetIDHadTau = sDirectory+"JetID_TrueHadDiTau_2017-fall.root";
       if (m_sVarNameJetIDHadTau.empty()) m_sVarNameJetIDHadTau = "DiTauScaleFactorJetIDHadTau";
  
       asg::AnaToolHandle<IDiTauEfficiencyCorrectionsTool>* tTool = new asg::AnaToolHandle<IDiTauEfficiencyCorrectionsTool>("JetIDHadTauTool", this);
       m_vCommonEfficiencyTools.push_back(tTool);
       ATH_CHECK(ASG_MAKE_ANA_TOOL(*tTool, TauAnalysisTools::CommonDiTauEfficiencyTool));
       ATH_CHECK(tTool->setProperty("InputFilePath", m_sInputFilePathJetIDHadTau));
       ATH_CHECK(tTool->setProperty("VarName", m_sVarNameJetIDHadTau));
       ATH_CHECK(tTool->setProperty("SkipTruthMatchCheck", m_bSkipTruthMatchCheck));
       ATH_CHECK(tTool->setProperty("WP", ConvertJetIDToString(m_iJetIDLevel)));
     }
     else
     {
       ATH_MSG_WARNING("unsupported EfficiencyCorrectionsType with enum " << iEfficiencyCorrectionType);
     }
   }
   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.

◆ inputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::inputMetaStore ( ) const

inherited

Accessor for the input metadata store.

Definition at line 88 of file AsgMetadataTool.cxx.

                                                                        {
  
 #ifdef XAOD_STANDALONE
       return &m_inputMetaStore;
 #else // XAOD_STANDALONE
       return m_inputMetaStore;
 #endif // XAOD_STANDALONE
    }

◆ isAffectedBySystematic()

bool TauAnalysisTools::DiTauEfficiencyCorrectionsTool::isAffectedBySystematic ( const CP::SystematicVariation & systematic ) const

virtual

returns whether this tool is affected by the given systematic

returns: whether this tool is affected by the given systematis

Parameters

systematic

Returns: true; false

Implements CP::ISystematicsTool.

Definition at line 157 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   for (auto it = m_vCommonEfficiencyTools.begin(); it != m_vCommonEfficiencyTools.end(); it++)
     if ((**it)->isAffectedBySystematic(systematic))
       return true;
   return false;
 }

◆ isSupportedRunNumber()

virtual bool TauAnalysisTools::DiTauEfficiencyCorrectionsTool::isSupportedRunNumber ( int ) const

inlinevirtual

check if run number is supperted in recommendations

Parameters

iRunNumber

Returns: true if ditau recommendations support this run

Note: currently no implementaion exists, alwasys returns true

Definition at line 98 of file DiTauEfficiencyCorrectionsTool.h.

   {
     return true;
   };

◆ metaDataStop()

StatusCode asg::AsgMetadataTool::metaDataStop ( )

protectedvirtualinherited

Function called when the tool should write out its metadata.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in xAODMaker::FileMetaDataTool, BookkeeperTool, BookkeeperDumperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 204 of file AsgMetadataTool.cxx.

                                             {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ 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);
   }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                   {
  
       return MSG::name( msg().level() );
    }

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

◆ outputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::outputMetaStore ( ) const

inherited

Accessor for the output metadata store.

Definition at line 97 of file AsgMetadataTool.cxx.

                                                                         {
  
 #ifdef XAOD_STANDALONE
       return &m_outputMetaStore;
 #else // XAOD_STANDALONE
       return m_outputMetaStore;
 #endif // XAOD_STANDALONE
    }

◆ print() [1/2]

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

                              {
  
       ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
       return;
    }

◆ print() [2/2]

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.

◆ printConfig()

void TauAnalysisTools::DiTauEfficiencyCorrectionsTool::printConfig ( ) const

virtual

Print tool configuration.

Definition at line 106 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   ATH_MSG_DEBUG( "DiTauEfficiencyCorrectionsTool with name " << name() << " is configured as follows:" );
   for (auto iEfficiencyCorrectionType : m_vEfficiencyCorrectionTypes) {
     ATH_MSG_DEBUG( "  EfficiencyCorrectionTypes " << iEfficiencyCorrectionType );
   }
   ATH_MSG_DEBUG( "  InputFilePathJetIDHadTau " << m_sInputFilePathJetIDHadTau );
   ATH_MSG_DEBUG( "  VarNameJetIDHadTau " << m_sVarNameJetIDHadTau );
   ATH_MSG_DEBUG( "  RecommendationTag " << m_sRecommendationTag );
 }

◆ recommendedSystematics()

CP::SystematicSet TauAnalysisTools::DiTauEfficiencyCorrectionsTool::recommendedSystematics ( ) const

virtual

returns: the list of all systematics this tool recommends to use

Implements CP::IReentrantSystematicsTool.

Definition at line 177 of file DiTauEfficiencyCorrectionsTool.cxx.

 {
   CP::SystematicSet sRecommendedSystematics;
   for (auto it = m_vCommonEfficiencyTools.begin(); it != m_vCommonEfficiencyTools.end(); it++)
   {
     sRecommendedSystematics.insert((**it)->recommendedSystematics());
   }
   return sRecommendedSystematics;
 }

◆ 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();
   }

◆ setUseIncidents()

void asg::AsgMetadataTool::setUseIncidents ( const bool flag )

inlineprotectedinherited

Definition at line 132 of file AsgMetadataTool.h.

    {
       m_useIncidents = flag;
    }

◆ sysInitialize()

StatusCode asg::AsgMetadataTool::sysInitialize ( )

virtualinherited

Function initialising the tool in the correct way in Athena.

This function is used to set up the callbacks from IncidentSvc in Athena at the right time during initialisation, without the user having to do anything special in his/her code.

Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.

Definition at line 110 of file AsgMetadataTool.cxx.

                                              {
  
 #ifndef XAOD_STANDALONE
       if (m_useIncidents) {
          // Connect to the IncidentSvc:
          ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
          ATH_CHECK( incSvc.retrieve() );
  
          // Set up the right callbacks: don't rethrow exceptions, any failure and we should end
          incSvc->addListener( this, IncidentType::BeginEvent, 0, false );
       }
       // Let the base class do its thing:
       ATH_CHECK( AlgTool::sysInitialize() );
  
 #endif // not XAOD_STANDALONE
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

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

bool asg::AsgMetadataTool::m_beginInputFileCalled

privateinherited

Flag helping to discover when the tool misses the opening of the first input file.

Definition at line 126 of file AsgMetadataTool.h.

◆ m_bIsConfigured

bool TauAnalysisTools::DiTauEfficiencyCorrectionsTool::m_bIsConfigured

private

Definition at line 120 of file DiTauEfficiencyCorrectionsTool.h.

◆ m_bIsData

bool TauAnalysisTools::DiTauEfficiencyCorrectionsTool::m_bIsData

private

Definition at line 119 of file DiTauEfficiencyCorrectionsTool.h.

◆ m_bSkipTruthMatchCheck

bool TauAnalysisTools::DiTauEfficiencyCorrectionsTool::m_bSkipTruthMatchCheck

private

Definition at line 118 of file DiTauEfficiencyCorrectionsTool.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_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_iJetIDLevel

int TauAnalysisTools::DiTauEfficiencyCorrectionsTool::m_iJetIDLevel

private

Definition at line 121 of file DiTauEfficiencyCorrectionsTool.h.

◆ m_inputMetaStore

MetaStore_t asg::AsgMetadataTool::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 119 of file AsgMetadataTool.h.

◆ m_outputMetaStore

MetaStore_t asg::AsgMetadataTool::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 121 of file AsgMetadataTool.h.

◆ m_sInputFilePathJetIDHadTau

std::string TauAnalysisTools::DiTauEfficiencyCorrectionsTool::m_sInputFilePathJetIDHadTau

private

Definition at line 115 of file DiTauEfficiencyCorrectionsTool.h.

◆ m_sRecommendationTag

std::string TauAnalysisTools::DiTauEfficiencyCorrectionsTool::m_sRecommendationTag

private

Definition at line 117 of file DiTauEfficiencyCorrectionsTool.h.

◆ m_sVarNameJetIDHadTau

std::string TauAnalysisTools::DiTauEfficiencyCorrectionsTool::m_sVarNameJetIDHadTau

private

Definition at line 116 of file DiTauEfficiencyCorrectionsTool.h.

◆ m_useIncidents

bool asg::AsgMetadataTool::m_useIncidents

privateinherited

Definition at line 128 of file AsgMetadataTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vCommonEfficiencyTools

std::vector< asg::AnaToolHandle<IDiTauEfficiencyCorrectionsTool>* > TauAnalysisTools::DiTauEfficiencyCorrectionsTool::m_vCommonEfficiencyTools

private

Definition at line 114 of file DiTauEfficiencyCorrectionsTool.h.

◆ m_vEfficiencyCorrectionTypes

std::vector<int> TauAnalysisTools::DiTauEfficiencyCorrectionsTool::m_vEfficiencyCorrectionTypes

private

Definition at line 113 of file DiTauEfficiencyCorrectionsTool.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 Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Callback functions helping in metadata reading/writing

Detailed Description

Member Typedef Documentation

◆ MetaStore_t

◆ MetaStorePtr_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ DiTauEfficiencyCorrectionsTool()

◆ ~DiTauEfficiencyCorrectionsTool()

Member Function Documentation

◆ affectingSystematics()

◆ applyEfficiencyScaleFactor()

◆ applySystematicVariation()

◆ beginEvent()

◆ beginInputFile()

◆ ConvertJetIDToString()

◆ 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()

◆ endInputFile()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getEfficiencyScaleFactor()

◆ getKey()

◆ getName()

◆ getProperty()

◆ handle()

◆ initialize()

◆ initializeTools_2017_moriond()

◆ inputHandles()

◆ inputMetaStore()

◆ isAffectedBySystematic()

◆ isSupportedRunNumber()

◆ metaDataStop()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ outputMetaStore()

◆ print() [1/2]

◆ print() [2/2]

◆ printConfig()

◆ recommendedSystematics()

◆ renounce()

◆ renounceArray()

◆ setUseIncidents()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_beginInputFileCalled

◆ m_bIsConfigured

◆ m_bIsData

◆ m_bSkipTruthMatchCheck

◆ m_detStore

◆ m_evtStore

◆ m_iJetIDLevel

◆ m_inputMetaStore

◆ m_outputMetaStore

◆ m_sInputFilePathJetIDHadTau

◆ m_sRecommendationTag

◆ m_sVarNameJetIDHadTau

◆ m_useIncidents

◆ m_varHandleArraysDeclared

◆ m_vCommonEfficiencyTools