The base class for all tau tools. More...

#include <TauRecToolBase.h>

Inherits asg::AsgTool, and ITauToolBase.

Inherited by JetSeedBuilder, MvaTESEvaluator, MvaTESVariableDecorator, PanTau::PanTauProcessor [virtual], TauAODLeptonRemovalTool, TauAODSelector, TauAxisSetter, TauCalibrateLC, TauCellVariables, TauClusterFinder, TauCombinedTES, TauCommonCalcVars, TauDecayModeNNClassifier, TauElectronVetoVariables, TauEleOverlapChecker, TauGNNEvaluator, TauIDVarCalculator, TauJetRNNEvaluator, TauPi0ClusterCreator, TauPi0ClusterScaler [virtual], TauPi0CreateROI, TauPi0ScoreCalculator, TauPi0Selector, tauRecTools::TauTrackRNNClassifier, tauRecTools::TrackRNN, TauShotFinder, TauSubstructureVariables, TauTrackFinder, TauVertexedClusterDecorator, TauVertexFinder, TauVertexVariables, and TauWPDecorator.

Collaboration diagram for TauRecToolBase:

Public Member Functions
	TauRecToolBase (const std::string &name)

virtual	~TauRecToolBase ()

virtual StatusCode	initialize () override
	Tool initializer. More...

virtual StatusCode	eventInitialize () override
	Event initializer - called at the beginning of each event. More...

virtual StatusCode	execute (xAOD::TauJet &pTau) const override
	Execute - called for each tau candidate. More...

virtual StatusCode	executePi0CreateROI (xAOD::TauJet &pTau, CaloConstCellContainer &caloCellContainer, boost::dynamic_bitset<> &map) const override

virtual StatusCode	executeVertexFinder (xAOD::TauJet &pTau, const xAOD::VertexContainer *vertexContainer=nullptr) const override

virtual StatusCode	executeTrackFinder (xAOD::TauJet &pTau, xAOD::TauTrackContainer &tauTrackContainer) const override

virtual StatusCode	executeTrackClassifier (xAOD::TauJet &pTau, xAOD::TauTrackContainer &tauTrackContainer) const override

virtual StatusCode	executeShotFinder (xAOD::TauJet &pTau, xAOD::CaloClusterContainer &shotClusterContainer, xAOD::PFOContainer &PFOContainer) const override

virtual StatusCode	executePi0ClusterCreator (xAOD::TauJet &pTau, xAOD::PFOContainer &neutralPFOContainer, xAOD::PFOContainer &hadronicPFOContainer, const xAOD::CaloClusterContainer &pCaloClusterContainer) const override

virtual StatusCode	executeVertexVariables (xAOD::TauJet &pTau, xAOD::VertexContainer &vertexContainer) const override

virtual StatusCode	executePi0ClusterScaler (xAOD::TauJet &pTau, xAOD::PFOContainer &neutralPFOContainer, xAOD::PFOContainer &chargedPFOContainer) const override

virtual StatusCode	executePi0nPFO (xAOD::TauJet &pTau, xAOD::PFOContainer &neutralPFOContainer) const override

virtual StatusCode	executePanTau (xAOD::TauJet &pTau, xAOD::ParticleContainer &particleContainer, xAOD::PFOContainer &neutralPFOContainer) const override

virtual StatusCode	eventFinalize () override
	Event finalizer - called at the end of each event. More...

virtual StatusCode	finalize () override
	Finalizer. More...

std::string	find_file (const std::string &fname) const

virtual StatusCode	readConfig () override

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

Protected Member Functions
bool	inTrigger () const

bool	inAOD () const

bool	inEleRM () const

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

Protected Attributes
Gaudi::Property< bool >	m_in_trigger {this, "inTrigger", false, "Indicate if the tool is running on trigger"}

Gaudi::Property< bool >	m_in_AOD {this, "inAOD", false, "Indicate if the tool is running on AOD"}

Gaudi::Property< bool >	m_in_EleRM {this, "inEleRM", false, "Indicate if the tool is running on EleRM routine"}

Gaudi::Property< std::string >	m_tauRecToolsTag {this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
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
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

Detailed Description

The base class for all tau tools.

Author: Lukasz Janyst; Justin Griffiths Thanks to Lianyou Shan, Lorenz Hauswald

Definition at line 21 of file TauRecToolBase.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TauRecToolBase()

TauRecToolBase::TauRecToolBase ( const std::string & name )

Definition at line 125 of file TauRecToolBase.cxx.

                                                     :
   asg::AsgTool(name) {
 }

◆ ~TauRecToolBase()

virtual TauRecToolBase::~TauRecToolBase ( )

inlinevirtual

Definition at line 28 of file TauRecToolBase.h.

28 {}

Member Function Documentation

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

◆ eventFinalize()

StatusCode TauRecToolBase::eventFinalize ( )

overridevirtual

Event finalizer - called at the end of each event.

Implements ITauToolBase.

Definition at line 202 of file TauRecToolBase.cxx.

                                          {
   return StatusCode::SUCCESS;
 }

◆ eventInitialize()

StatusCode TauRecToolBase::eventInitialize ( )

overridevirtual

Event initializer - called at the beginning of each event.

Implements ITauToolBase.

Definition at line 133 of file TauRecToolBase.cxx.

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

◆ execute()

StatusCode TauRecToolBase::execute ( xAOD::TauJet & pTau ) const

overridevirtual

Execute - called for each tau candidate.

Implements ITauToolBase.

Reimplemented in TauDecayModeNNClassifier, MvaTESVariableDecorator, TauCombinedTES, MvaTESEvaluator, TauWPDecorator, TauAxisSetter, TauEleOverlapChecker, TauJetRNNEvaluator, TauClusterFinder, TauCalibrateLC, TauGNNEvaluator, TauSubstructureVariables, TauVertexedClusterDecorator, TauAODSelector, TauElectronVetoVariables, JetSeedBuilder, TauCellVariables, TauCommonCalcVars, TauIDVarCalculator, and TauAODLeptonRemovalTool.

Definition at line 138 of file TauRecToolBase.cxx.

                                                     {
   ATH_MSG_ERROR("function not implemented");
   return StatusCode::FAILURE;
 }

◆ executePanTau()

StatusCode TauRecToolBase::executePanTau	(	xAOD::TauJet &	pTau,
		xAOD::ParticleContainer &	particleContainer,
		xAOD::PFOContainer &	neutralPFOContainer
	)		const

overridevirtual

Implements ITauToolBase.

Reimplemented in PanTau::PanTauProcessor.

Definition at line 197 of file TauRecToolBase.cxx.

                                                                                                            {
   ATH_MSG_ERROR("function not implemented");
   return StatusCode::FAILURE;
 }

◆ executePi0ClusterCreator()

StatusCode TauRecToolBase::executePi0ClusterCreator	(	xAOD::TauJet &	pTau,
		xAOD::PFOContainer &	neutralPFOContainer,
		xAOD::PFOContainer &	hadronicPFOContainer,
		const xAOD::CaloClusterContainer &	pCaloClusterContainer
	)		const

overridevirtual

Implements ITauToolBase.

Reimplemented in TauPi0ClusterCreator.

Definition at line 175 of file TauRecToolBase.cxx.

                                                                     {
   ATH_MSG_ERROR("function not implemented");
   return StatusCode::FAILURE;
 }

◆ executePi0ClusterScaler()

StatusCode TauRecToolBase::executePi0ClusterScaler	(	xAOD::TauJet &	pTau,
		xAOD::PFOContainer &	neutralPFOContainer,
		xAOD::PFOContainer &	chargedPFOContainer
	)		const

overridevirtual

Implements ITauToolBase.

Reimplemented in TauPi0ClusterScaler.

Definition at line 187 of file TauRecToolBase.cxx.

                                                                                                                  {
   ATH_MSG_ERROR("function not implemented");
   return StatusCode::FAILURE;
 } 

◆ executePi0CreateROI()

StatusCode TauRecToolBase::executePi0CreateROI	(	xAOD::TauJet &	pTau,
		CaloConstCellContainer &	caloCellContainer,
		boost::dynamic_bitset<> &	map
	)		const

overridevirtual

Implements ITauToolBase.

Reimplemented in TauPi0CreateROI.

Definition at line 149 of file TauRecToolBase.cxx.

                                                                                                                         {
   ATH_MSG_ERROR("function not implemented");
   return StatusCode::FAILURE;
 }

◆ executePi0nPFO()

StatusCode TauRecToolBase::executePi0nPFO	(	xAOD::TauJet &	pTau,
		xAOD::PFOContainer &	neutralPFOContainer
	)		const

overridevirtual

Implements ITauToolBase.

Reimplemented in TauPi0ScoreCalculator, and TauPi0Selector.

Definition at line 192 of file TauRecToolBase.cxx.

                                                                                   {
   ATH_MSG_ERROR("function not implemented");
   return StatusCode::FAILURE;
 }

◆ executeShotFinder()

StatusCode TauRecToolBase::executeShotFinder	(	xAOD::TauJet &	pTau,
		xAOD::CaloClusterContainer &	shotClusterContainer,
		xAOD::PFOContainer &	PFOContainer
	)		const

overridevirtual

Implements ITauToolBase.

Reimplemented in TauShotFinder.

Definition at line 170 of file TauRecToolBase.cxx.

                                                                                                                    {
   ATH_MSG_ERROR("function not implemented");
   return StatusCode::FAILURE;
 }

◆ executeTrackClassifier()

StatusCode TauRecToolBase::executeTrackClassifier	(	xAOD::TauJet &	pTau,
		xAOD::TauTrackContainer &	tauTrackContainer
	)		const

overridevirtual

Implements ITauToolBase.

Reimplemented in tauRecTools::TauTrackRNNClassifier.

Definition at line 165 of file TauRecToolBase.cxx.

                                                                                            {
   ATH_MSG_ERROR("function not implemented");
   return StatusCode::FAILURE;
 }

◆ executeTrackFinder()

StatusCode TauRecToolBase::executeTrackFinder	(	xAOD::TauJet &	pTau,
		xAOD::TauTrackContainer &	tauTrackContainer
	)		const

overridevirtual

Implements ITauToolBase.

Reimplemented in TauTrackFinder.

Definition at line 160 of file TauRecToolBase.cxx.

                                                                                        {
   ATH_MSG_ERROR("function not implemented");
   return StatusCode::FAILURE;
 }

◆ executeVertexFinder()

StatusCode TauRecToolBase::executeVertexFinder	(	xAOD::TauJet &	pTau,
		const xAOD::VertexContainer *	vertexContainer = `nullptr`
	)		const

overridevirtual

Implements ITauToolBase.

Reimplemented in TauVertexFinder.

Definition at line 155 of file TauRecToolBase.cxx.

                                                                                             {
   ATH_MSG_ERROR("function not implemented");
   return StatusCode::FAILURE;
 }

◆ executeVertexVariables()

StatusCode TauRecToolBase::executeVertexVariables	(	xAOD::TauJet &	pTau,
		xAOD::VertexContainer &	vertexContainer
	)		const

overridevirtual

Implements ITauToolBase.

Reimplemented in TauVertexVariables.

Definition at line 182 of file TauRecToolBase.cxx.

                                                                                               {
   ATH_MSG_ERROR("function not implemented");
   return StatusCode::FAILURE;
 }

◆ 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

◆ finalize()

StatusCode TauRecToolBase::finalize ( )

overridevirtual

Finalizer.

Implements ITauToolBase.

Reimplemented in PanTau::PanTauProcessor.

Definition at line 206 of file TauRecToolBase.cxx.

                                    {
   return StatusCode::SUCCESS;
 }

◆ find_file()

std::string TauRecToolBase::find_file ( const std::string & fname ) const

Definition at line 19 of file TauRecToolBase.cxx.

                                                                 {
   std::string full_path;
   //offline calib files are in GroupData
   //online calib files are in release
   full_path = PathResolverFindCalibFile(m_tauRecToolsTag+"/"+fname);
   if(full_path.empty()) full_path = PathResolverFindCalibFile(fname);
   return full_path;
 }

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

◆ inAOD()

bool TauRecToolBase::inAOD ( ) const

inlineprotected

Definition at line 88 of file TauRecToolBase.h.

88 { return m_in_AOD; }

◆ inEleRM()

bool TauRecToolBase::inEleRM ( ) const

inlineprotected

Definition at line 89 of file TauRecToolBase.h.

89 { return m_in_EleRM; }

◆ initialize()

StatusCode TauRecToolBase::initialize ( )

overridevirtual

Tool initializer.

Reimplemented from asg::AsgTool.

Reimplemented in tauRecTools::TrackRNN, TauTrackFinder, tauRecTools::TauTrackRNNClassifier, TauWPDecorator, TauVertexFinder, TauDecayModeNNClassifier, TauPi0CreateROI, TauShotFinder, TauElectronVetoVariables, TauEleOverlapChecker, TauJetRNNEvaluator, TauCalibrateLC, TauGNNEvaluator, TauPi0ScoreCalculator, TauVertexVariables, TauVertexedClusterDecorator, MvaTESVariableDecorator, TauAODLeptonRemovalTool, TauCombinedTES, MvaTESEvaluator, and PanTau::PanTauProcessor.

Definition at line 129 of file TauRecToolBase.cxx.

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

◆ inTrigger()

bool TauRecToolBase::inTrigger ( ) const

inlineprotected

Definition at line 87 of file TauRecToolBase.h.

87 { return m_in_trigger; }

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

◆ print()

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, top::TopObjectSelection, 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;
    }

◆ readConfig()

StatusCode TauRecToolBase::readConfig ( )

overridevirtual

Implements ITauToolBase.

Definition at line 27 of file TauRecToolBase.cxx.

                                       {
   // Sanity check to see if property ConfigPath is declared for a tool. Might be
   // removed once all tools are updated to have a config path declared.
   // in athena getProperties returns std::vector<Gaudi::Details::PropertyBase*>
   // in rc     getProperties returns std::map<std::string,Property*>
 #ifndef XAOD_STANDALONE
   bool configPathDeclared = false;
   for (Gaudi::Details::PropertyBase* property : getProperties())
   {
     if (property->name() == "ConfigPath")
     {
       configPathDeclared = true;
       break;
     }
   }
   if (!configPathDeclared)
 #elif defined(XAOD_STANDALONE)
   PropertyMgr::PropMap_t property_map = getPropertyMgr()->getProperties();
   if (property_map.find("ConfigPath") == property_map.end())
 #else
 #   error "What environment are we in?!?"
 #endif // XAOD_STANDALONE
   {
     ATH_MSG_INFO("No config file path property declared yet, this is not recommended");
     return StatusCode::SUCCESS;
   }
   
   // get configured config path and load file via TEnv
   const std::string* config_file_path_property;
   // if (getProperty("ConfigPath", config_file_path).isFailure())
   //   return StatusCode::FAILURE;
   config_file_path_property = getProperty<std::string>("ConfigPath");
   std::string config_file_path = find_file(*config_file_path_property);
   TEnv env;
   env.ReadFile(PathResolverFindCalibFile(config_file_path).c_str(),kEnvAll);
  
   THashList* lList = env.GetTable();
   for( Int_t i = 0; lList && i < lList->GetEntries(); ++i )
   {
     StatusCode sc;
     // types of properties are handled differently as well 
 #ifndef XAOD_STANDALONE
     // get type of variable with the entry name
     const std::type_info* type = getProperty(lList->At( i )->GetName()).type_info();
  
     // search for type is needed by env.GetValue function (needs a variable of the correct type as 2nd argument)
     if (*type == typeid(bool))
       sc = this->setProperty(lList->At( i )->GetName(),
         bool(env.GetValue(lList->At( i )->GetName(),bool(true))));
     else if (*type == typeid(int))
       sc = this->setProperty(lList->At( i )->GetName(),
         env.GetValue(lList->At( i )->GetName(),int(0)));
     else if (*type == typeid(float))
       sc = this->setProperty(lList->At( i )->GetName(),
         env.GetValue(lList->At( i )->GetName(),float(0)));
     else if (*type == typeid(double))
       sc = this->setProperty(lList->At( i )->GetName(),
         env.GetValue(lList->At( i )->GetName(),double(0)));
     else if (*type == typeid(std::string))
       sc = this->setProperty(lList->At( i )->GetName(),
         env.GetValue(lList->At( i )->GetName(),""));
 #else
     // get type of variable with the entry name
     Property::Type type = getPropertyMgr()->getProperty(lList->At( i )->GetName())->type();
  
     if (type == Property::BOOL)
       sc = this->setProperty(lList->At( i )->GetName(),
         bool(env.GetValue(lList->At( i )->GetName(),bool(true))));
     else if (type == Property::INT)
       sc = this->setProperty(lList->At( i )->GetName(),
         env.GetValue(lList->At( i )->GetName(),int(0)));
     else if (type == Property::FLOAT)
       sc = this->setProperty(lList->At( i )->GetName(),
         env.GetValue(lList->At( i )->GetName(),float(0)));
     else if (type == Property::DOUBLE)
       sc = this->setProperty(lList->At( i )->GetName(),
         env.GetValue(lList->At( i )->GetName(),double(0)));
     else if (type == Property::STRING)
       sc = this->setProperty(lList->At( i )->GetName(),
         env.GetValue(lList->At( i )->GetName(),""));
 #endif // XAOD_STANDALONE
     else
     {
 #ifndef XAOD_STANDALONE
       ATH_MSG_FATAL("there was a problem to find the correct type enum: "<<type->name());
 #else
       ATH_MSG_FATAL("there was a problem to find the correct type enum: "<<type);
 #endif // XAOD_STANDALONE
       return StatusCode::FAILURE;
     }
     if (!sc.isSuccess()) {
       ATH_MSG_FATAL("failed to set property: " << lList->At( i )->GetName());
       return StatusCode::FAILURE;
     }
   }
   return StatusCode::SUCCESS;
 }

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

◆ 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_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_in_AOD

Gaudi::Property<bool> TauRecToolBase::m_in_AOD {this, "inAOD", false, "Indicate if the tool is running on AOD"}

protected

Definition at line 77 of file TauRecToolBase.h.

◆ m_in_EleRM

Gaudi::Property<bool> TauRecToolBase::m_in_EleRM {this, "inEleRM", false, "Indicate if the tool is running on EleRM routine"}

protected

Definition at line 78 of file TauRecToolBase.h.

◆ m_in_trigger

Gaudi::Property<bool> TauRecToolBase::m_in_trigger {this, "inTrigger", false, "Indicate if the tool is running on trigger"}

protected

Definition at line 76 of file TauRecToolBase.h.

◆ m_tauRecToolsTag

Gaudi::Property<std::string> TauRecToolBase::m_tauRecToolsTag {this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"}

protected

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

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TauRecToolBase()

◆ ~TauRecToolBase()

Member Function Documentation

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

◆ eventFinalize()

◆ eventInitialize()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ executePanTau()

◆ executePi0ClusterCreator()

◆ executePi0ClusterScaler()

◆ executePi0CreateROI()

◆ executePi0nPFO()

◆ executeShotFinder()

◆ executeTrackClassifier()

◆ executeTrackFinder()

◆ executeVertexFinder()

◆ executeVertexVariables()

◆ extraDeps_update_handler()

◆ finalize()

◆ find_file()

◆ getKey()

◆ getName()

◆ getProperty()

◆ inAOD()

◆ inEleRM()

◆ initialize()

◆ inputHandles()

◆ inTrigger()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ readConfig()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_in_AOD

◆ m_in_EleRM

◆ m_in_trigger

◆ m_tauRecToolsTag

◆ m_varHandleArraysDeclared

◆ m_vhka