A tool implementing the recommended ele-ele overlap removal. More...

#include <EleEleOverlapTool.h>

Inheritance diagram for ORUtils::EleEleOverlapTool:

Collaboration diagram for ORUtils::EleEleOverlapTool:

Public Member Functions
	EleEleOverlapTool (const std::string &name)
	Create proper constructor for Athena. More...

virtual StatusCode	findOverlaps (const xAOD::IParticleContainer &cont1, const xAOD::IParticleContainer &cont2) const override
	Identify overlapping electrons. More...

virtual StatusCode	findOverlaps (const xAOD::ElectronContainer &electrons) const
	Identify overlapping electrons and jets. More...

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

StatusCode	initialize () override final
	Initialize base class functionality. 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
virtual StatusCode	initializeDerived () override
	Initialize the tool. More...

virtual StatusCode	handleOverlap (const xAOD::IParticle testParticle, const xAOD::IParticle refParticle) const
	Common helper method to handle an overlap result. 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...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	electronsMatch (const xAOD::Electron &el1, const xAOD::Electron &el2) const
	Helper method for matching electrons. More...

bool	rejectFirst (const xAOD::Electron &el1, const xAOD::Electron &el2) const
	Helper method to decide which electron to reject. More...

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

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

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

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

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

Configurable properties
bool	m_useTrackMatch
	Match electrons by shared track (on by default) More...

bool	m_useClusterMatch
	Match electrons by cluster distance (off by default) More...

double	m_clusterDeltaEta
	Cluster-matching dEta. More...

double	m_clusterDeltaPhi
	Cluster-matching dPhi. More...

Detailed Description

A tool implementing the recommended ele-ele overlap removal.

This tool flags electrons that match to other electrons under two possible criteria:

The electrons share a track (on by default)
The electron clusters are overlapping (off by default)

The rejected electron is decided as follows:

author 'Ambiguous' rejected from author 'Electron'
otherwise, the softer electron is rejected (in PT)

The implementation here comes from discussions on JIRA issue ATLASG-438.

Author: Steve Farrell Steve.nosp@m.n.Fa.nosp@m.rrell.nosp@m.@cer.nosp@m.n.ch

Definition at line 34 of file EleEleOverlapTool.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

◆ EleEleOverlapTool()

ORUtils::EleEleOverlapTool::EleEleOverlapTool ( const std::string & name )

Create proper constructor for Athena.

Standalone constructor

Definition at line 43 of file EleEleOverlapTool.cxx.

     : BaseOverlapTool(name),
       m_useTrackMatch(true),
       m_useClusterMatch(false),
       m_clusterDeltaEta(3*0.025),
       m_clusterDeltaPhi(5*0.025)
   {
     declareProperty("UseTrackMatch", m_useTrackMatch,
                     "Match electrons by shared track");
     declareProperty("UseClusterMatch", m_useClusterMatch,
                     "Match electrons by cluster proximity");
     declareProperty("ClusterDeltaEta", m_clusterDeltaEta,
                     "Cluster matching delta eta");
     declareProperty("ClusterDeltaPhi", m_clusterDeltaPhi,
                     "Cluster matching delta phi");
   }

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

◆ electronsMatch()

bool ORUtils::EleEleOverlapTool::electronsMatch	(	const xAOD::Electron &	el1,
		const xAOD::Electron &	el2
	)		const

private

Helper method for matching electrons.

Definition at line 145 of file EleEleOverlapTool.cxx.

   {
     // Look for a shared track
     if(m_useTrackMatch && el1.trackParticleLink() == el2.trackParticleLink())
       return true;
  
     // Look for overlapping clusters
     if(m_useClusterMatch) {
       const auto& clus1 = *el1.caloCluster();
       const auto& clus2 = *el2.caloCluster();
       using xAOD::P4Helpers::deltaPhi;
  
       // We use coordinates from 2nd sampling
       const unsigned layer = 2;
       const float eta1 = clus1.etaBE(layer);
       const float eta2 = clus2.etaBE(layer);
       const float phi1 = clus1.phiBE(layer);
       const float phi2 = clus2.phiBE(layer);
  
       // Check validity of the eta/phi (no dummy -999 values)
       if(isDummyVal(eta1) || isDummyVal(eta2) ||
          isDummyVal(phi1) || isDummyVal(phi2)) {
         throw DummyValError();
       }
  
       const float dEta = clus1.etaBE(layer) - clus2.etaBE(layer);
       const float dPhi = deltaPhi(clus1.phiBE(layer), clus2.phiBE(layer));
  
       if( std::abs(dEta) < m_clusterDeltaEta &&
           std::abs(dPhi) < m_clusterDeltaPhi )
       {
         return true;
       }
     }
  
     return false;
   }

◆ 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

◆ findOverlaps() [1/2]

StatusCode ORUtils::EleEleOverlapTool::findOverlaps ( const xAOD::ElectronContainer & electrons ) const

virtual

Identify overlapping electrons and jets.

The above method calls this one.

Definition at line 107 of file EleEleOverlapTool.cxx.

   {
     ATH_MSG_DEBUG("Removing overlapping electrons");
  
     // Initialize output decorations if necessary
     m_decHelper->initializeDecorations(electrons);
  
     // TODO: consider adding cluster-based matching also
  
     // Loop over surviving electron pairs
     for(const auto el1 : electrons) {
       if(!m_decHelper->isSurvivingObject(*el1)) continue;
       for(const auto el2 : electrons) {
         if(el1 == el2) continue;
         if(!m_decHelper->isSurvivingObject(*el2)) continue;
  
         // Perform the match and decide whether to reject el1
         try {
           if(electronsMatch(*el1, *el2) && rejectFirst(*el1, *el2)) {
             ATH_CHECK( handleOverlap(el1, el2) );
           }
         }
         catch(const DummyValError& e) {
           ATH_MSG_ERROR("Cluster 2nd sampling eta/phi values are -999. " <<
                         "It seems you are missing the neccesary variables to "
                         "do the requested electron-electron cluster matching");
           return StatusCode::FAILURE;
         }
       }
     }
  
     return StatusCode::SUCCESS;
   }

◆ findOverlaps() [2/2]

StatusCode ORUtils::EleEleOverlapTool::findOverlaps	(	const xAOD::IParticleContainer &	cont1,
		const xAOD::IParticleContainer &	cont2
	)		const

overridevirtual

Identify overlapping electrons.

Note that in this tool, the two containers should be the same.

Implements ORUtils::IOverlapTool.

Definition at line 82 of file EleEleOverlapTool.cxx.

   {
     // I require that the two containers are the same so that I can
     // arbitrarily pick one of them to use.
     if(&cont1 != &cont2) {
       ATH_MSG_ERROR("This tool expects both electron containers to be the " <<
                     "same for now");
       return StatusCode::FAILURE;
     }
     // Check the container type
     if(typeid(cont1) != typeid(xAOD::ElectronContainer) &&
        typeid(cont1) != typeid(ConstDataVector<xAOD::ElectronContainer>)) {
       ATH_MSG_ERROR("Container is not an ElectronContainer!");
       return StatusCode::FAILURE;
     }
     // Call the type-specific method
     ATH_CHECK( findOverlaps(static_cast<const xAOD::ElectronContainer&>(cont1)) );
     return StatusCode::SUCCESS;
   }

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

◆ handleOverlap()

StatusCode ORUtils::BaseOverlapTool::handleOverlap	(	const xAOD::IParticle *	testParticle,
		const xAOD::IParticle *	refParticle
	)		const

protectedvirtualinherited

Common helper method to handle an overlap result.

This method for now applies the user-defined object priorities set as the input decoration, so if the testParticle is higher prio than the refParticle, nothing happens. Otherwise, this method prints a debug message, decorates the testParticle as overlap, and optionally sets the object element link.

Definition at line 63 of file BaseOverlapTool.cxx.

   {
     // Apply user-priority override
     if(!m_enableUserPrio ||
        m_decHelper->getObjectPriority(*testParticle) <=
        m_decHelper->getObjectPriority(*refParticle))
     {
       ATH_MSG_DEBUG("  Found overlap " << testParticle->type() <<
                     " pt " << testParticle->pt()*invGeV);
       m_decHelper->setObjectFail(*testParticle);
       if(m_objLinkHelper) {
         ATH_CHECK( m_objLinkHelper->addObjectLink(*testParticle, *refParticle) );
       }
     }
     return StatusCode::SUCCESS;
   }

◆ initialize()

StatusCode ORUtils::BaseOverlapTool::initialize ( )

finaloverridevirtualinherited

Initialize base class functionality.

Concrete tool specific initialization can be implemented by overriding the initializeDerived() method.

Reimplemented from asg::AsgTool.

Definition at line 38 of file BaseOverlapTool.cxx.

   {
     ATH_MSG_DEBUG("Initializing " << name());
     ATH_MSG_DEBUG("Base config options: InputLabel " << m_inputLabel <<
                   " OutputLabel " << m_outputLabel <<
                   " OutputPassValue " << m_outputPassValue <<
                   " UserPrio " << m_enableUserPrio);
  
     // Initialize the decoration helper
     m_decHelper = std::make_unique<OverlapDecorationHelper>
       (m_inputLabel, m_outputLabel, m_outputPassValue);
  
     // Initialize the obj-link helper
     if(m_linkOverlapObjects)
       m_objLinkHelper = std::make_unique<OverlapLinkHelper>("overlapObject");
  
     // Initialize the derived tool
     ATH_CHECK( initializeDerived() );
  
     return StatusCode::SUCCESS;
   }

◆ initializeDerived()

StatusCode ORUtils::EleEleOverlapTool::initializeDerived ( )

overrideprotectedvirtual

Initialize the tool.

Reimplemented from ORUtils::BaseOverlapTool.

Definition at line 63 of file EleEleOverlapTool.cxx.

   {
     ATH_MSG_DEBUG("UseTrackMatch " << m_useTrackMatch <<
                   " UseClusterMatch " << m_useClusterMatch <<
                   " ClusterDeltaEta " << m_clusterDeltaEta <<
                   " ClusterDeltaPhi " << m_clusterDeltaPhi);
  
     // Sanity check
     if(!m_useTrackMatch && !m_useClusterMatch) {
       ATH_MSG_ERROR("You must enable at least one: UseTrackMatch or UseClusterMatch");
       return StatusCode::FAILURE;
     }
  
     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, 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.

◆ rejectFirst()

bool ORUtils::EleEleOverlapTool::rejectFirst	(	const xAOD::Electron &	el1,
		const xAOD::Electron &	el2
	)		const

private

Helper method to decide which electron to reject.

Definition at line 188 of file EleEleOverlapTool.cxx.

   {
     // TODO: consider incorporating track-match information in the priority
     // selection.
  
     // Always reject author "Ambiguous" when compared to author "Electron"
     if(el1.author() == xAOD::EgammaParameters::AuthorAmbiguous &&
        el2.author() == xAOD::EgammaParameters::AuthorElectron)
       return true;
     if(el1.author() == xAOD::EgammaParameters::AuthorElectron &&
        el2.author() == xAOD::EgammaParameters::AuthorAmbiguous)
       return false;
  
     // Reject the softer electron
     if(el1.pt() < el2.pt()) return true;
  
     return false;
   }

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

double ORUtils::EleEleOverlapTool::m_clusterDeltaEta

private

Cluster-matching dEta.

Definition at line 80 of file EleEleOverlapTool.h.

◆ m_clusterDeltaPhi

double ORUtils::EleEleOverlapTool::m_clusterDeltaPhi

private

Cluster-matching dPhi.

Definition at line 83 of file EleEleOverlapTool.h.

◆ m_decHelper

std::unique_ptr<OverlapDecorationHelper> ORUtils::BaseOverlapTool::m_decHelper

protectedinherited

Helper for handling input/output decorations.

Definition at line 95 of file BaseOverlapTool.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_enableUserPrio

bool ORUtils::BaseOverlapTool::m_enableUserPrio

protectedinherited

Enable user-priority scoring.

Definition at line 86 of file BaseOverlapTool.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_inputLabel

std::string ORUtils::BaseOverlapTool::m_inputLabel

protectedinherited

Input object decoration which specifies which objects to look at.

Definition at line 74 of file BaseOverlapTool.h.

◆ m_linkOverlapObjects

bool ORUtils::BaseOverlapTool::m_linkOverlapObjects

protectedinherited

Flag to toggle overlap object links.

Definition at line 83 of file BaseOverlapTool.h.

◆ m_objLinkHelper

std::unique_ptr<OverlapLinkHelper> ORUtils::BaseOverlapTool::m_objLinkHelper

protectedinherited

Helper for linking overlap objects.

Definition at line 98 of file BaseOverlapTool.h.

◆ m_outputLabel

std::string ORUtils::BaseOverlapTool::m_outputLabel

protectedinherited

Output object decoration which specifies overlapping objects.

Definition at line 76 of file BaseOverlapTool.h.

◆ m_outputPassValue

bool ORUtils::BaseOverlapTool::m_outputPassValue

protectedinherited

Toggle the output flag logic.

If true, then non-overlapping objects will be assigned "true".

Definition at line 80 of file BaseOverlapTool.h.

◆ m_useClusterMatch

bool ORUtils::EleEleOverlapTool::m_useClusterMatch

private

Match electrons by cluster distance (off by default)

Definition at line 77 of file EleEleOverlapTool.h.

◆ m_useTrackMatch

bool ORUtils::EleEleOverlapTool::m_useTrackMatch

private

Match electrons by shared track (on by default)

Definition at line 74 of file EleEleOverlapTool.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

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ EleEleOverlapTool()

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

◆ electronsMatch()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ findOverlaps() [1/2]

◆ findOverlaps() [2/2]

◆ getKey()

◆ getName()

◆ getProperty()

◆ handleOverlap()

◆ initialize()

◆ initializeDerived()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ rejectFirst()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_clusterDeltaEta

◆ m_clusterDeltaPhi

◆ m_decHelper

◆ m_detStore

◆ m_enableUserPrio

◆ m_evtStore

◆ m_inputLabel

◆ m_linkOverlapObjects

◆ m_objLinkHelper

◆ m_outputLabel

◆ m_outputPassValue

◆ m_useClusterMatch

◆ m_useTrackMatch

◆ m_varHandleArraysDeclared

◆ m_vhka