Tool to perform matching to selected offline particles using the list of candidates created by the DerivationFramework::TriggerMatchingTool. More...

#include <MatchFromCompositeTool.h>

Inheritance diagram for Trig::MatchFromCompositeTool:

Collaboration diagram for Trig::MatchFromCompositeTool:

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

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

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

bool	match (const xAOD::IParticle &recoObject, const std::string &chain, double=0.1, bool=false) const override
	Match a single object. More...

bool	match (const std::vector< const xAOD::IParticle * > &recoObject, const std::string &chain, double=0.1, bool=false) const override
	Match a multiple objects. 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 Types
template<typename T >
using	constAcc_t = SG::AuxElement::ConstAccessor< T >
	Helper typedefs for accessors/decorators, vectors of ele links. More...

template<typename T >
using	dec_t = SG::AuxElement::Decorator< T >

template<typename T >
using	vecLink_t = std::vector< ElementLink< T > >

Protected Member Functions
virtual MatchingImplementation *	impl () const override
	Inherited from the interface but does nothing. More...

bool	testCombination (const vecLink_t< xAOD::IParticleContainer > &onlineLinks, const std::vector< const xAOD::IParticle * > &offline) const
	Test a combination of offline objects against a combination of online objects. More...

bool	areTheSame (const xAOD::IParticle &lhs, const xAOD::IParticle &rhs) const
	Check if two particles are the same. More...

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
bool	m_matchShallow = true
	Allow matching shallow copy to shallow copy. More...

float	m_drThreshold = -1
	If greater than 0 then will skip the above check and just check that DR between the two particles is less than this value. More...

std::string	m_inputPrefix
	The prefix to expect at the front of the trig composite container name. More...

std::map< SG::sgkey_t, SG::sgkey_t >	m_keyRemap

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

Tool to perform matching to selected offline particles using the list of candidates created by the DerivationFramework::TriggerMatchingTool.

Author: Jon Burr

Definition at line 26 of file MatchFromCompositeTool.h.

Member Typedef Documentation

◆ constAcc_t

template<typename T >

using Trig::MatchFromCompositeTool::constAcc_t = SG::AuxElement::ConstAccessor<T>

protected

Helper typedefs for accessors/decorators, vectors of ele links.

Definition at line 73 of file MatchFromCompositeTool.h.

◆ dec_t

template<typename T >

using Trig::MatchFromCompositeTool::dec_t = SG::AuxElement::Decorator<T>

protected

Definition at line 75 of file MatchFromCompositeTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

◆ vecLink_t

template<typename T >

using Trig::MatchFromCompositeTool::vecLink_t = std::vector<ElementLink<T> >

protected

Definition at line 77 of file MatchFromCompositeTool.h.

Constructor & Destructor Documentation

◆ MatchFromCompositeTool()

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

Standard constructor.

Definition at line 21 of file MatchFromCompositeTool.cxx.

                                                                       :
     asg::AsgTool(name)
   {
     declareProperty("MatchShallow", m_matchShallow,
         "Whether to check if two objects are shallow copies of each other. "
         "If this is not true then pointer equality will be used.");
     declareProperty("DRThreshold", m_drThreshold,
         "If greater than 0 then use the DR between two objects to check if "
         "they are the same object.");
     declareProperty("InputPrefix", m_inputPrefix="TrigMatch_",
         "The input prefix to expect at the beginning of the TrigComposite "
         "container names.");
 #ifdef XAOD_STANDALONE
     declareProperty("RemapBrokenLinks", m_remapBrokenLinks,
         "Whether to remap element links which are broken in some derivations for AnalysisBase");
     declareProperty("RemapContainers", m_remapContainers,
         "Containers whose links need remapping");
     declareProperty("RemapCLIDs", m_remapCLIDs, "CLIDs for those containers");
 #endif
   }

◆ ~MatchFromCompositeTool()

Trig::MatchFromCompositeTool::~MatchFromCompositeTool ( )

override

Default destructor.

Definition at line 42 of file MatchFromCompositeTool.cxx.

42 {}

Member Function Documentation

◆ areTheSame()

bool Trig::MatchFromCompositeTool::areTheSame	(	const xAOD::IParticle &	lhs,
		const xAOD::IParticle &	rhs
	)		const

protected

Check if two particles are the same.

Definition at line 151 of file MatchFromCompositeTool.cxx.

   {
     // If we've been given a dR threshold > 0 then we just use that.
     if (m_drThreshold > 0) {
       return xAOD::P4Helpers::deltaR(lhs, rhs, false) < m_drThreshold;
     }
     else if (m_matchShallow) {
       static const SG::AuxElement::ConstAccessor<
         ElementLink<xAOD::IParticleContainer>> accOOL("originalObjectLink");
       // For now assume that we've got a shallow copy iff this is available
       const xAOD::IParticle* lhsOrig = 
         accOOL.isAvailable(lhs) ? *accOOL(lhs) : &lhs;
       const xAOD::IParticle* rhsOrig = 
         accOOL.isAvailable(rhs) ? *accOOL(rhs) : &rhs;
       return lhsOrig == rhsOrig;
     }
     else {
       // Otherwise just use pointer equality
       return &lhs == &rhs;
     }
   }

◆ 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

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

◆ impl()

virtual MatchingImplementation* Trig::MatchFromCompositeTool::impl ( ) const

inlineoverrideprotectedvirtual

Inherited from the interface but does nothing.

Implements Trig::IMatchingTool.

Definition at line 104 of file MatchFromCompositeTool.h.

104 { return nullptr; }

◆ initialize()

StatusCode Trig::MatchFromCompositeTool::initialize ( )

overridevirtual

Initialise the tool.

Reimplemented from asg::AsgTool.

Definition at line 44 of file MatchFromCompositeTool.cxx.

                                                 {
     ATH_MSG_INFO( "initializing " << name() );
 #ifdef XAOD_STANDALONE
     ATH_MSG_INFO("Remap broken links? " << m_remapBrokenLinks);
     if (m_remapBrokenLinks)
     {
         if (m_remapContainers.size() != m_remapCLIDs.size())
         {
             ATH_MSG_ERROR("Number of containers and CLIDs to remap do not match!");
             return StatusCode::FAILURE;
         }
         CLID iparticleCLID = ClassID_traits<xAOD::IParticleContainer>::ID();
         for (std::size_t idx = 0; idx < m_remapContainers.size(); ++idx)
         {
             const std::string &name = m_remapContainers[idx];
             m_keyRemap[hashContainer(name, iparticleCLID)] = hashContainer(name, m_remapCLIDs[idx]);
         }
         ATH_MSG_INFO("Remap: ");
         for (const auto &p : m_keyRemap)
             ATH_MSG_INFO("\t" << p.first << " -> " << p.second);
  
     }
 #endif
     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.

◆ match() [1/2]

bool Trig::MatchFromCompositeTool::match	(	const std::vector< const xAOD::IParticle * > &	recoObject,
		const std::string &	chain,
		double	= `0.1`,
		bool	= `false`
	)		const

overridevirtual

Match a multiple objects.

Parameters

recoObjects	The objects to match.
chain	The chain to match to. The final two parameters for this function are inherited from the interface but have no effect! To follow the implementation of the other tool, the matching returns true if all provided offline objects have a corresponding online object, not if all online objects match a provided offline object.

Implements Trig::IMatchingTool.

Definition at line 78 of file MatchFromCompositeTool.cxx.

   {
     std::string containerName = m_inputPrefix+chain;
     // We have to replace '.' characters with '_' characters so that these are
     // valid container names...
     std::replace(containerName.begin(), containerName.end(), '.', '_');
     const xAOD::TrigCompositeContainer* composites(nullptr);
     if (evtStore()->retrieve(composites, containerName).isFailure() ){
       ATH_MSG_ERROR("Failed to retrieve composite container for chain "+chain);
       ATH_MSG_ERROR("Please check your derivation to see if the container is there");
       ATH_MSG_ERROR("This likely means the trigger is not in your file's menu");
       throw std::runtime_error(
           "Failed to retrieve composite corresponding to chain " + chain);
     }
     for (const xAOD::TrigComposite* composite : *composites) {
       static const constAcc_t<vecLink_t<xAOD::IParticleContainer>> accMatched(
           "TrigMatchedObjects");
       if (testCombination(accMatched(*composite), recoObjects) )
         return true;
     }
     // If we get here then none of the online combinations worked
     return false;
   }

◆ match() [2/2]

bool Trig::MatchFromCompositeTool::match	(	const xAOD::IParticle &	recoObject,
		const std::string &	chain,
		double	= `0.1`,
		bool	= `false`
	)		const

overridevirtual

Match a single object.

Parameters

recoObject	The object to match.
chain	The chain to match to. The final two parameters for this function are inherited from the interface but have no effect! To follow the implementation of the other tool, the matching returns true if all provided offline objects have a corresponding online object, not if all online objects match a provided offline object.

Implements Trig::IMatchingTool.

Definition at line 70 of file MatchFromCompositeTool.cxx.

   {
     return match({&recoObject}, chain);
   }

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

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

◆ testCombination()

bool Trig::MatchFromCompositeTool::testCombination	(	const vecLink_t< xAOD::IParticleContainer > &	onlineLinks,
		const std::vector< const xAOD::IParticle * > &	offline
	)		const

protected

Test a combination of offline objects against a combination of online objects.

Parameters

onlineLinks	The online combination
offline	The offline combination

Definition at line 105 of file MatchFromCompositeTool.cxx.

   {
     // We need to make sure we don't allow two offline particles to match to the
     // same online particle, so we copy the vector so we can erase objects if
     // necessary. Dereference the links at the same time.
     std::vector<const xAOD::IParticle*> online;
     online.reserve(onlineLinks.size() );
     for (const ElementLink<xAOD::IParticleContainer>& link : onlineLinks)
       // Skip invalid links - these are usually objects that have been removed
       // by derivation framework level thinning. Going by the logic that we just
       // need a match for all the offline particles provided rather than for the
       // trigger particles implies that we should allow a combination that has
       // had some of its members removed.
       if (link.isValid() )
         online.push_back(*link);
 #ifdef XAOD_STANDALONE
       else if (m_remapBrokenLinks)
       {
         auto itr = m_keyRemap.find(link.persKey());
         if (itr != m_keyRemap.end())
             online.push_back(*ElementLink<xAOD::IParticleContainer>(itr->second, link.index()));
       }
 #endif
     // I will follow the way the current tool works and match even if there are
     // fewer reco objects than trigger objects
     for (const xAOD::IParticle* offlinePart : offline) {
       bool isMatched = false;
       for (auto itr = online.begin(); itr != online.end(); ++itr) {
         if (areTheSame(*offlinePart, **itr) ) {
           // Remove this online particle from consideration
           online.erase(itr);
           isMatched = true;
           break;
         }
       }
       if (!isMatched)
         // We've found an offline particle we couldn't match so the whole
         // combination doesn't match.
         return false;
     }
     // To reach this point every offline particle must have found a match.
     return true;
   }

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

float Trig::MatchFromCompositeTool::m_drThreshold = -1

protected

If greater than 0 then will skip the above check and just check that DR between the two particles is less than this value.

Definition at line 85 of file MatchFromCompositeTool.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_inputPrefix

std::string Trig::MatchFromCompositeTool::m_inputPrefix

protected

The prefix to expect at the front of the trig composite container name.

Definition at line 88 of file MatchFromCompositeTool.h.

◆ m_keyRemap

std::map<SG::sgkey_t, SG::sgkey_t> Trig::MatchFromCompositeTool::m_keyRemap

protected

Definition at line 121 of file MatchFromCompositeTool.h.

◆ m_matchShallow

bool Trig::MatchFromCompositeTool::m_matchShallow = true

protected

Allow matching shallow copy to shallow copy.

Definition at line 81 of file MatchFromCompositeTool.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 Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ constAcc_t

◆ dec_t

◆ StoreGateSvc_t

◆ vecLink_t

Constructor & Destructor Documentation

◆ MatchFromCompositeTool()

◆ ~MatchFromCompositeTool()

Member Function Documentation

◆ areTheSame()

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

◆ getKey()

◆ getName()

◆ getProperty()

◆ impl()

◆ initialize()

◆ inputHandles()

◆ match() [1/2]

◆ match() [2/2]

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ testCombination()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_drThreshold

◆ m_evtStore

◆ m_inputPrefix

◆ m_keyRemap

◆ m_matchShallow

◆ m_varHandleArraysDeclared

◆ m_vhka