#include <IParticleRetrievalTool.h>

Inheritance diagram for Trig::IParticleRetrievalTool:

Collaboration diagram for Trig::IParticleRetrievalTool:

Public Member Functions
	IParticleRetrievalTool (const std::string &name)
	Standard constructor. More...

	~IParticleRetrievalTool () override
	Default destructor. More...

StatusCode	initialize () override
	Initialise the tool. More...

StatusCode	retrieveParticles (std::vector< std::vector< const xAOD::IParticle * >> &combinations, const std::string &chain, bool rerun=false) const override
	Retrieve the particles that caused this trigger to fire. More...

StatusCode	retrieveParticles (std::vector< const xAOD::IParticle * > &combination, const HLT::TriggerElement *te, bool &navFailure) const
	Retrieve particles that caused this trigger element to pass. More...

xAOD::Type::ObjectType	getEGammaTEType (const HLT::TriggerElement *te) const
	Get the type of particle that should be retrieved from this TE. More...

StatusCode	retrieveFeatureParticle (const xAOD::IParticle &particle, const HLT::TriggerElement::FeatureAccessHelper &feature, const HLT::TriggerElement te, bool &navFailure) const
	Retrieve an IParticle from a feature. More...

virtual void	print () const =0
	Print the state of the tool. 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	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
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
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
ToolHandle< Trig::TrigDecisionTool >	m_tdt
	The TrigDecisionTool that will be used to get the navigation. More...

bool	m_warnOnNavigationFailure
	Be forgiving about the navigation not matching our expectations. 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

Detailed Description

Definition at line 16 of file IParticleRetrievalTool.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

◆ IParticleRetrievalTool()

Trig::IParticleRetrievalTool::IParticleRetrievalTool ( const std::string & name )

Standard constructor.

Definition at line 55 of file IParticleRetrievalTool.cxx.

                                                                       :
     asg::AsgTool(name)
   {
     declareProperty("TrigDecisionTool", m_tdt,
         "The trigger decision tool to use.");
     declareProperty("WarnOnNavigationError", m_warnOnNavigationFailure = true,
         "Only spit a warning on a navigation error, don't cause a job failure.");
  
   }

◆ ~IParticleRetrievalTool()

Trig::IParticleRetrievalTool::~IParticleRetrievalTool ( )

override

Default destructor.

Definition at line 65 of file IParticleRetrievalTool.cxx.

65 {}

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

◆ 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

◆ getEGammaTEType()

xAOD::Type::ObjectType Trig::IParticleRetrievalTool::getEGammaTEType ( const HLT::TriggerElement * te ) const

Get the type of particle that should be retrieved from this TE.

Parameters

egammaTE The TE to query

Returns: The type of object that caused this TE to fire.

This function should only be called on a TE from a single leg of an EGamma trigger.

Definition at line 227 of file IParticleRetrievalTool.cxx.

   {
     // We need to check the TE name for this
     std::string teName = Trig::getTEName(*te);
     if (teName.find("etcut") != std::string::npos &&
         teName.find("trkcut") == std::string::npos)
       return xAOD::Type::CaloCluster;
     else if (CxxUtils::starts_with (teName, "EF_e"))
       return xAOD::Type::Electron;
     else if (CxxUtils::starts_with (teName, "EF_g"))
       return xAOD::Type::Photon;
     else 
       return xAOD::Type::Other;
   }

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

◆ initialize()

StatusCode Trig::IParticleRetrievalTool::initialize ( )

overridevirtual

Initialise the tool.

Reimplemented from asg::AsgTool.

Definition at line 67 of file IParticleRetrievalTool.cxx.

   {
     ATH_MSG_INFO("Initializing " << name() );
     ATH_CHECK( m_tdt.retrieve() );
     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.

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

◆ 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, top::TopObjectSelection, asg::AsgTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

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

◆ retrieveFeatureParticle()

StatusCode Trig::IParticleRetrievalTool::retrieveFeatureParticle	(	const xAOD::IParticle *&	particle,
		const HLT::TriggerElement::FeatureAccessHelper &	feature,
		const HLT::TriggerElement *	te,
		bool &	navFailure
	)		const

Retrieve an IParticle from a feature.

Parameters

[out]	particle	The retrieved particle
	feature	The feature containing the particle
	te	The trigger element containing this feature
[out]	navFailure	Use to communicate a failure in the navigation without an error.

Expand the typedGet function here

Definition at line 243 of file IParticleRetrievalTool.cxx.

   {
     // Get the right container type name
     std::string containerType;
     if (!CLIDToContainerType(containerType, feature.getCLID() ) ) {
       ATH_MSG_ERROR("Unrecognised CLID " << feature.getCLID() << " received!");
       // This isn't a navigation error - this is a failure in the tool's
       // internal logic!
       return StatusCode::FAILURE;
     }
     // Build a vector of typeless features so that we can use the central
     // functions.
     const HLT::TrigNavStructure* navigation = 
       m_tdt->ExperimentalAndExpertMethods().getNavigation();
  
  
     auto typelessHolder = navigation->getHolder(feature);
  
     if (!typelessHolder) {
       std::string message = "Typeless holder for feature not present!";
       navFailure = true;
       if (m_warnOnNavigationFailure) {
         ATH_MSG_WARNING(message);
         return StatusCode::SUCCESS;
       }
       else {
         ATH_MSG_ERROR(message);
         return StatusCode::FAILURE;
       }
     }
     const xAOD::IParticleContainer* cont(nullptr);
     // Get the name used in the event store
     std::string key = HLTNavDetails::formatSGkey(
         "HLT", containerType, typelessHolder->label() );
     // Now things are *much* more familiar
     if (!evtStore()->contains<xAOD::IParticleContainer>(key) ) {
       std::string message = "Store does not contain " + key + "!";
       navFailure = true;
       if (m_warnOnNavigationFailure) {
         ATH_MSG_WARNING(message);
         return StatusCode::SUCCESS;
       }
       else {
         ATH_MSG_ERROR(message);
         return StatusCode::FAILURE;
       }
     }
     ATH_CHECK( evtStore()->retrieve(cont, key) );
     HLT::TriggerElement::ObjectIndex idx = feature.getIndex();
     if (cont->size() < idx.objectsEnd() ) {
       std::ostringstream os; 
       os << "Featured object end " << idx.objectsEnd()
         << " is *after* the end of container " << key;
       navFailure = true;
       if (m_warnOnNavigationFailure) {
         ATH_MSG_WARNING( os.str() );
         return StatusCode::SUCCESS;
       }
       else {
         ATH_MSG_ERROR( os.str() );
         return StatusCode::FAILURE;
       }
     }
     std::vector<const xAOD::IParticle*> particleFeatures;
     particleFeatures.reserve(idx.objectsEnd() - idx.objectsBegin() );
     auto begin = cont->begin();
     auto end = cont->begin();
     std::advance(begin, idx.objectsBegin() );
     std::advance(end, idx.objectsEnd() );
     particleFeatures.insert(particleFeatures.end(), begin, end);
  
     // Make sure the answer is what we expect
     std::ostringstream os;
     switch (particleFeatures.size() ) {
       case 0:
         os << "No particles retrieved from feature "
             << navigation->label(feature.getCLID(), feature.getIndex().subTypeIndex() )
             << " from TE " << Trig::getTEName(*te);
         navFailure = true;
         if (m_warnOnNavigationFailure) {
           ATH_MSG_WARNING(os.str() );
           return StatusCode::SUCCESS;
         }
         else {
           ATH_MSG_ERROR(os.str() );
           return StatusCode::FAILURE;
         }
       case 1:
         // Set the output.
         particle = particleFeatures.at(0);
         break;
       default:
         // Some TEs can end up reporting multiple outputs within the same RoI.
         // AFAIK this only happens within EGamma TEs but I don't know that for
         // sure. In any case this shouldn't matter too much for the matching
         // given that they will be nearby each other. Just return the highest pT
         // object.
         particle = *(std::max_element(
               particleFeatures.begin(), particleFeatures.end(),
               [] (const xAOD::IParticle* lhs, const xAOD::IParticle* rhs)
               { return lhs->pt() < rhs->pt(); }) );
     }
     return StatusCode::SUCCESS;
   }

◆ retrieveParticles() [1/2]

StatusCode Trig::IParticleRetrievalTool::retrieveParticles	(	std::vector< const xAOD::IParticle * > &	combination,
		const HLT::TriggerElement *	te,
		bool &	navFailure
	)		const

Retrieve particles that caused this trigger element to pass.

Parameters

[out]	combination	All particles that caused this TE to fire.
	te	The trigger element to be interrogated.
[out]	navFailure	Use to communicate a failure in the navigation without an error.

Definition at line 125 of file IParticleRetrievalTool.cxx.

   {
     ATH_MSG_DEBUG( "Processing TE " << Trig::getTEName(*te) );
     // Keep track of whether or not we found a particle here.
     const xAOD::IParticle* part = nullptr;
     for (const auto& feature : te->getFeatureAccessHelpers() ) {
       xAOD::Type::ObjectType type;
       if (!CLIDToObjectType(type, feature.getCLID() ) )
         // Skip any features that don't hold 'final' state particles
         continue;
       if (type == xAOD::Type::Electron || type == xAOD::Type::Photon) {
         // If this is an egamma type we have to check if we are meant to be
         // looking for a CaloCluster instead!
         xAOD::Type::ObjectType egType = getEGammaTEType(te);
         if (egType == xAOD::Type::Other) {
           std::string message = 
             "Unable to determine the correct type for TE " + Trig::getTEName(*te);
           navFailure = true;
           if (m_warnOnNavigationFailure) {
             ATH_MSG_WARNING( message );
             return StatusCode::SUCCESS;
           }
           else {
             ATH_MSG_ERROR( message );
             return StatusCode::FAILURE;
           }
         }
         else if (egType == xAOD::Type::CaloCluster) {
           HLT::class_id_type clid = 0;
           ObjectTypeToCLID(clid, egType);
           // This will be where we store the TE containing the calo cluster
           // feature
           const HLT::TriggerElement* sourceTE = nullptr;
           const HLT::TrigNavStructure* navigation = 
             m_tdt->ExperimentalAndExpertMethods().getNavigation();
           HLT::TriggerElement::FeatureAccessHelper egFeature = 
             navigation->getFeatureRecursively(te, clid, "", sourceTE);
           if (!sourceTE) {
             std::ostringstream os;
             os << "Unable to retrieve feature of type " << egType
                 << " from TE " << Trig::getTEName(*te);
             navFailure = true;
             if (m_warnOnNavigationFailure) {
               ATH_MSG_WARNING( os.str() );
               return StatusCode::SUCCESS;
             }
             else {
               ATH_MSG_ERROR( os.str() );
               return StatusCode::FAILURE;
             }
           }
           ATH_CHECK( retrieveFeatureParticle(part, egFeature, sourceTE, navFailure) );
           if (navFailure)
             return StatusCode::SUCCESS;
           // If it's a calo-cluster like TE then stop here, otherwise we'll
           // encounter the other EG type again and fail...
           break;
         }
         else if (egType != type) {
           // This is the wrong feature to be looking at
           continue;
         }
         // Otherwise we continue as before
       }
       // If we found a particle from another feature access helper then this is
       // a problem. Our assumption is that there is only one particle per leg!
       if (part) {
         std::string message = "TE" + Trig::getTEName(*te) + "has multiple " +
           "'final' particles attached to it! This breaks this tool's asumptions!";
         navFailure = true;
         if (m_warnOnNavigationFailure) {
           ATH_MSG_WARNING(message);
           return StatusCode::SUCCESS;
         }
         else {
           ATH_MSG_ERROR(message);
           return StatusCode::FAILURE;
         }
       }
       ATH_CHECK( retrieveFeatureParticle(part, feature, te, navFailure) );
       if (navFailure)
         return StatusCode::SUCCESS;
     } //> end loop over features
  
     // If we found a particle then we can stop going through this branch of the
     // tree
     if (part) {
       combination.push_back(part);
       return StatusCode::SUCCESS;
     }
  
     // Otherwise look at each of the next TEs separately
     for (const HLT::TriggerElement* nextTE : 
         HLT::TrigNavStructure::getDirectPredecessors(te) )
       ATH_CHECK( retrieveParticles(combination, nextTE, navFailure) );
  
     return StatusCode::SUCCESS;
   }

◆ retrieveParticles() [2/2]

StatusCode Trig::IParticleRetrievalTool::retrieveParticles	(	std::vector< std::vector< const xAOD::IParticle * >> &	combinations,
		const std::string &	chain,
		bool	rerun = `false`
	)		const

overridevirtual

Retrieve the particles that caused this trigger to fire.

Parameters

[out]	combinations	All combinations of particles that could have caused the trigger to fire.
	chain	The name of the chain.
	rerun	Whether to look at the chain in 'rerun' mode. The provided vector will be cleared before use! Note that this also only returns electrons, photons, muons, taus or (for egamma etcut triggers) calo clusters. This tool will not return (b-)jets. For combined (b-)jet+X triggers (where X is one of the above) only the X will be returned. This tool may not work if too much trigger information has been removed.

Implements Trig::IIParticleRetrievalTool.

Definition at line 74 of file IParticleRetrievalTool.cxx.

   {
     // Make sure what we're getting is cleared.
     combinations.clear();
     // Start by getting the chain group
     const ChainGroup* cg = m_tdt->getChainGroup(chain);
     // Make sure that this group actually contains triggers. If it doesn't then
     // this is very wrong and the job shouldn't be allowed to continue
     if (cg->getListOfTriggers().size() == 0) {
       ATH_MSG_ERROR("Chain group " << chain 
           << " is empty! This means that no matching chains were found!");
       return StatusCode::FAILURE;
     }
     unsigned int condition = TrigDefs::Physics;
     if (rerun)
       condition |= TrigDefs::allowResurrectedDecision;
     if (!cg->isPassed(condition) ) {
       ATH_MSG_DEBUG("Chain: " << chain << " was not passed!");
       return StatusCode::SUCCESS;
     }
     
     FeatureContainer features = cg->features(condition);
     for (const Combination& combo : features.getCombinations() ) {
       // The assumption here is that each combination represents a *single* way
       // in which the trigger could have been passed. This should be true for
       // the types of trigger that this tool expects to examine. It won't be
       // true for (e.g.) jet triggers. 
       std::vector<const xAOD::IParticle*> currentCombination;
       bool navFailure = false;
       for (const HLT::TriggerElement* te : combo.tes() ) {
         if (!retrieveParticles(currentCombination, te, navFailure).isSuccess() ) {
           // Interpret a failure this way so that we can report the chain name
           ATH_MSG_ERROR("Failed to retrieve particles for chain " << chain );
           return StatusCode::FAILURE;
         }
         // If the navigation failed for this combination ignore it completely
         if (navFailure)
           break;
       }
       if (navFailure)
         ATH_MSG_WARNING("Skipping combination for chain " << chain 
             << " due to navigation failure");
       else
         combinations.push_back(currentCombination);
     }
     return StatusCode::SUCCESS;
   }

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

ToolHandle<Trig::TrigDecisionTool> Trig::IParticleRetrievalTool::m_tdt

private

Initial value:

{

"Trig::TrigDecisionTool/TrigDecisionTool"}

The TrigDecisionTool that will be used to get the navigation.

Definition at line 88 of file IParticleRetrievalTool.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.

◆ m_warnOnNavigationFailure

bool Trig::IParticleRetrievalTool::m_warnOnNavigationFailure

private

Be forgiving about the navigation not matching our expectations.

Definition at line 91 of file IParticleRetrievalTool.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

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ IParticleRetrievalTool()

◆ ~IParticleRetrievalTool()

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

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getEGammaTEType()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ renounce()

◆ renounceArray()

◆ retrieveFeatureParticle()

◆ retrieveParticles() [1/2]

◆ retrieveParticles() [2/2]

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_tdt

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_warnOnNavigationFailure