A simple overlap finder that uses a dR match. More...

#include <DeltaROverlapTool.h>

Inheritance diagram for ORUtils::DeltaROverlapTool:

Collaboration diagram for ORUtils::DeltaROverlapTool:

Public Member Functions
	DeltaROverlapTool (const std::string &name)
	Create proper constructor for Athena.
virtual StatusCode	findOverlaps (columnar::Particle1Range cont1, columnar::Particle2Range cont2, columnar::EventContextId eventContext) const override
	Identify overlaps with simple dR check.
StatusCode	findOverlaps (const xAOD::IParticleContainer &cont1, const xAOD::IParticleContainer &cont2, const EventContext &eventContext=Gaudi::Hive::currentContext()) const
StatusCode	initialize () override final
	Initialize base class functionality.
virtual void	callEvents (columnar::EventContextRange events) const override
	The callEvents() for columnar tools.
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
virtual StatusCode	initializeDerived () override
	Initialize the tool.
template<columnar::RegularContainerIdConcept CI1, columnar::RegularContainerIdConcept CI2, typename CM>
StatusCode	handleOverlap (const columnar::ObjectId< CI1, CM > &testParticle, const columnar::ObjectId< CI2, CM > &refParticle) const
	Common helper method to handle an overlap result.
template<typename XAODContainer, columnar::RegularContainerIdConcept CI, typename CM>
StatusCode	checkForXAODContainer (columnar::ObjectRange< CI, CM > cont, std::string_view message) const
	check whether the container is of the right type
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.
Helper Functions
void	initializeDecorations (columnar::Particle1Range container) const
void	initializeDecorations (columnar::Particle2Range container) const
char	getObjectPriority (columnar::Particle1Id obj) const
char	getObjectPriority (columnar::Particle2Id obj) const
bool	isSurvivingObject (columnar::Particle1Id obj) const
bool	isSurvivingObject (columnar::Particle2Id obj) const
bool	isRejectedObject (columnar::Particle1Id obj) const
bool	isRejectedObject (columnar::Particle2Id obj) const
void	setObjectFail (columnar::Particle1Id obj) const
void	setObjectFail (columnar::Particle2Id obj) const
template<columnar::ContainerIdConcept CI>
StatusCode	addObjectLink (columnar::Particle1Id p1, columnar::ObjectId< CI > p2) const
template<columnar::ContainerIdConcept CI>
StatusCode	addObjectLink (columnar::Particle2Id p1, columnar::ObjectId< CI > p2) const

Protected Attributes
Common configurable properties
std::string	m_inputLabel
	Input object decoration which specifies which objects to look at.
std::string	m_outputLabel
	Output object decoration which specifies overlapping objects.
bool	m_outputPassValue
	Toggle the output flag logic.
bool	m_linkOverlapObjects
	Flag to toggle overlap object links.
bool	m_enableUserPrio
	Enable user-priority scoring.
Utilities
std::unique_ptr< BaseAccessors >	m_baseAccessors {std::make_unique<BaseAccessors> (this)}
std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle1 > >	m_decHelper1
	Helper for handling input/output decorations.
std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle2 > >	m_decHelper2
std::unique_ptr< OverlapLinkHelper< columnar::ContainerId::particle1 > >	m_objLinkHelper1
	Helper for linking overlap objects.
std::unique_ptr< OverlapLinkHelper< columnar::ContainerId::particle2 > >	m_objLinkHelper2

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
template<columnar::ContainerIdConcept CI1, columnar::RegularContainerIdConcept CI2, typename CM>
StatusCode	internalFindOverlaps (columnar::ObjectRange< CI1, CM > testCont, columnar::ObjectRange< CI2, CM > refCont) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared
Configurable properties
float	m_dR
	Delta-R cone for flagging objects as overlap.
bool	m_useRapidity
	Calculate delta-R using rapidity.
bool	m_swapContainerPrecedence
	In default configuration, the first container is the one that gets tested for object rejection.
Gaudi::Property< unsigned >	m_objectType1
Gaudi::Property< unsigned >	m_objectType2
Utilities
std::unique_ptr< DeltaRMatcher >	m_dRMatcher
	Delta-R matcher.

Detailed Description

A simple overlap finder that uses a dR match.

This class will remove all objects that fit the criteria.

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

Definition at line 26 of file DeltaROverlapTool.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

◆ DeltaROverlapTool()

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

Create proper constructor for Athena.

Standalone constructor

Definition at line 14 of file DeltaROverlapTool.cxx.

    : BaseOverlapTool(name)
  {
    declareProperty("DR", m_dR = 0.4, "Maximum dR for overlap match");
    declareProperty("UseRapidity", m_useRapidity = true,
                    "Calculate delta-R using rapidity");
    declareProperty("SwapContainerPrecedence", m_swapContainerPrecedence = false,
                    "Use second container for flagging overlaps");
  }

Member Function Documentation

◆ addObjectLink() [1/2]

template<columnar::ContainerIdConcept CI>

StatusCode ORUtils::BaseOverlapTool::addObjectLink	(	columnar::Particle1Id	p1,
		columnar::ObjectId< CI >	p2 ) const

inlineprotectedinherited

Definition at line 163 of file BaseOverlapTool.h.

163 {

164 return m_objLinkHelper1->addObjectLink (p1, p2); }

ORUtils::BaseOverlapTool::m_objLinkHelper1

std::unique_ptr< OverlapLinkHelper< columnar::ContainerId::particle1 > > m_objLinkHelper1

Helper for linking overlap objects.

Definition BaseOverlapTool.h:132

◆ addObjectLink() [2/2]

template<columnar::ContainerIdConcept CI>

StatusCode ORUtils::BaseOverlapTool::addObjectLink	(	columnar::Particle2Id	p1,
		columnar::ObjectId< CI >	p2 ) const

inlineprotectedinherited

Definition at line 166 of file BaseOverlapTool.h.

166 {

167 return m_objLinkHelper2->addObjectLink (p1, p2); }

ORUtils::BaseOverlapTool::m_objLinkHelper2

std::unique_ptr< OverlapLinkHelper< columnar::ContainerId::particle2 > > m_objLinkHelper2

Definition BaseOverlapTool.h:133

◆ callEvents()

void ORUtils::BaseOverlapTool::callEvents ( columnar::EventContextRange events ) const

overridevirtualinherited

The callEvents() for columnar tools.

Definition at line 65 of file BaseOverlapTool.cxx.

  {
    auto& baseAcc = *m_baseAccessors;
    for (auto event : events)
    {
      ANA_CHECK_THROW (findOverlaps (baseAcc.m_particles1Acc (event), baseAcc.m_particles2Acc (event), event));
    }
  }

◆ checkForXAODContainer()

template<typename XAODContainer, columnar::RegularContainerIdConcept CI, typename CM>

StatusCode ORUtils::BaseOverlapTool::checkForXAODContainer	(	columnar::ObjectRange< CI, CM >	cont,
		std::string_view	message ) const

inlineprotectedinherited

check whether the container is of the right type

Definition at line 83 of file BaseOverlapTool.h.

      {
        if constexpr (CM::isXAOD) {
          if(typeid(cont.getXAODObjectNoexcept()) != typeid(XAODContainer) &&
            typeid(cont.getXAODObjectNoexcept()) != typeid(ConstDataVector<XAODContainer>)) {
            ATH_MSG_ERROR(message);
            return StatusCode::FAILURE;
          }
        }
        return StatusCode::SUCCESS;
      }

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & 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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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::DeltaROverlapTool::findOverlaps	(	columnar::Particle1Range	cont1,
		columnar::Particle2Range	cont2,
		columnar::EventContextId	eventContext ) const

overridevirtual

Identify overlaps with simple dR check.

Flags all objects in cont1 which are found to overlap with any object in cont2 within the configured dR window.

Implements ORUtils::IOverlapTool.

Definition at line 70 of file DeltaROverlapTool.cxx.

  {
    ATH_MSG_DEBUG("Removing overlaps");
 
    // Initialize output decoration if necessary
    initializeDecorations(cont1);
    initializeDecorations(cont2);
 
    if (m_swapContainerPrecedence)
      ATH_CHECK ( internalFindOverlaps(cont2, cont1) );
    else
      ATH_CHECK ( internalFindOverlaps(cont1, cont2) );
    return StatusCode::SUCCESS;
  }

◆ findOverlaps() [2/2]

StatusCode ORUtils::IOverlapTool::findOverlaps	(	const xAOD::IParticleContainer &	cont1,
		const xAOD::IParticleContainer &	cont2,
		const EventContext &	eventContext = Gaudi::Hive::currentContext() ) const

inline

Definition at line 46 of file IOverlapTool.h.

                                                                                                  {
        return findOverlaps(
          columnar::Particle1Range(cont1),
          columnar::Particle2Range(cont2),
          eventContext);
      }

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

◆ getObjectPriority() [1/2]

char ORUtils::BaseOverlapTool::getObjectPriority ( columnar::Particle1Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 146 of file BaseOverlapTool.h.

146 {

147 return m_decHelper1->getObjectPriority (obj); }

ORUtils::BaseOverlapTool::m_decHelper1

std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle1 > > m_decHelper1

Helper for handling input/output decorations.

Definition BaseOverlapTool.h:128

◆ getObjectPriority() [2/2]

char ORUtils::BaseOverlapTool::getObjectPriority ( columnar::Particle2Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 148 of file BaseOverlapTool.h.

148 {

149 return m_decHelper2->getObjectPriority (obj); }

ORUtils::BaseOverlapTool::m_decHelper2

std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle2 > > m_decHelper2

Definition BaseOverlapTool.h:129

◆ getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

◆ handleOverlap()

template<columnar::RegularContainerIdConcept CI1, columnar::RegularContainerIdConcept CI2, typename CM>

StatusCode ORUtils::BaseOverlapTool::handleOverlap	(	const columnar::ObjectId< CI1, CM > &	testParticle,
		const columnar::ObjectId< CI2, CM > &	refParticle ) const

protectedinherited

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.

Unit conversion constant

Definition at line 177 of file BaseOverlapTool.h.

  {
    // Apply user-priority override
    if(!m_enableUserPrio ||
       getObjectPriority(testParticle) <=
       getObjectPriority(refParticle))
    {
      if constexpr (CM::isXAOD)
      {
        const float invGeV = 1e-3;
        ATH_MSG_DEBUG("  Found overlap " << testParticle.getXAODObject().type() <<
                      " pt " << testParticle.getXAODObject().pt()*invGeV);
      } else
      {
        ATH_MSG_DEBUG("  Found overlap " << testParticle);
      }
      setObjectFail(testParticle);
      if(m_linkOverlapObjects) {
        ATH_CHECK( addObjectLink(testParticle, refParticle) );
      }
    }
    return StatusCode::SUCCESS;
  }

◆ initialize()

StatusCode ORUtils::BaseOverlapTool::initialize ( void )

finaloverridevirtualinherited

Initialize base class functionality.

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

Reimplemented from asg::AsgTool.

Definition at line 32 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_decHelper1 = std::make_unique<OverlapDecorationHelper<columnar::ContainerId::particle1>>
      (m_inputLabel, m_outputLabel, m_outputPassValue);
    addSubtool(*m_decHelper1);
    m_decHelper2 = std::make_unique<OverlapDecorationHelper<columnar::ContainerId::particle2>>
      (m_inputLabel, m_outputLabel, m_outputPassValue);
    addSubtool(*m_decHelper2);
 
    // Initialize the obj-link helper
    if(m_linkOverlapObjects)
    {
      m_objLinkHelper1 = std::make_unique<OverlapLinkHelper<columnar::ContainerId::particle1>>("overlapObject");
      addSubtool(*m_objLinkHelper1);
      m_objLinkHelper2 = std::make_unique<OverlapLinkHelper<columnar::ContainerId::particle2>>("overlapObject");
      addSubtool(*m_objLinkHelper2);
    }
 
    // Initialize the derived tool
    ATH_CHECK( initializeDerived() );
 
    ATH_CHECK ( initializeColumns() );
 
    return StatusCode::SUCCESS;
  }

◆ initializeDecorations() [1/2]

void ORUtils::BaseOverlapTool::initializeDecorations ( columnar::Particle1Range container ) const

inlineprotectedinherited

Definition at line 142 of file BaseOverlapTool.h.

142 {

143 m_decHelper1->initializeDecorations (container); }

◆ initializeDecorations() [2/2]

void ORUtils::BaseOverlapTool::initializeDecorations ( columnar::Particle2Range container ) const

inlineprotectedinherited

Definition at line 144 of file BaseOverlapTool.h.

144 {

145 m_decHelper2->initializeDecorations (container); }

◆ initializeDerived()

StatusCode ORUtils::DeltaROverlapTool::initializeDerived ( )

overrideprotectedvirtual

Initialize the tool.

Reimplemented from ORUtils::BaseOverlapTool.

Definition at line 27 of file DeltaROverlapTool.cxx.

  {
    ATH_MSG_DEBUG("Setting up dR matching with cone size " << m_dR);
 
    // Initialize the dR matcher
    m_dRMatcher = std::make_unique<DeltaRMatcher>(m_dR, m_useRapidity);
    if (m_objectType1.value() != 0 && m_objectType2.value() != 0) {
      ATH_CHECK (m_dRMatcher->setObjectTypes (static_cast<xAODType::ObjectType>(m_objectType1.value()),
                                              static_cast<xAODType::ObjectType>(m_objectType2.value())));
    } else if (!columnar::ColumnarModeDefault::isXAOD) {
      ATH_MSG_INFO("Object types not set, please set ObjectType1 and ObjectType2 properties");
    }
    addSubtool(*m_dRMatcher);
    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.

◆ internalFindOverlaps()

template<columnar::ContainerIdConcept CI1, columnar::RegularContainerIdConcept CI2, typename CM>

StatusCode ORUtils::DeltaROverlapTool::internalFindOverlaps	(	columnar::ObjectRange< CI1, CM >	testCont,
		columnar::ObjectRange< CI2, CM >	refCont ) const

private

Definition at line 47 of file DeltaROverlapTool.cxx.

  {
    // Loop over surviving input objects
    for(const auto testPar : testCont){
      if(isSurvivingObject(testPar)){
        for(const auto refPar : refCont){
          if(isSurvivingObject(refPar)){
            // Check for duplicates and overlap
            if constexpr (CM::isXAOD) {
              if(&testPar.getXAODObject() == &refPar.getXAODObject()) continue;
            }
            if(m_dRMatcher->objectsMatch(testPar, refPar)){
              ATH_CHECK( handleOverlap(testPar, refPar) );
            }
          }
        }
      }
    }
    return StatusCode::SUCCESS;
  }

◆ isRejectedObject() [1/2]

bool ORUtils::BaseOverlapTool::isRejectedObject ( columnar::Particle1Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 154 of file BaseOverlapTool.h.

154 {

155 return m_decHelper1->isRejectedObject (obj); }

◆ isRejectedObject() [2/2]

bool ORUtils::BaseOverlapTool::isRejectedObject ( columnar::Particle2Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 156 of file BaseOverlapTool.h.

156 {

157 return m_decHelper2->isRejectedObject (obj); }

◆ isSurvivingObject() [1/2]

bool ORUtils::BaseOverlapTool::isSurvivingObject ( columnar::Particle1Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 150 of file BaseOverlapTool.h.

150 {

151 return m_decHelper1->isSurvivingObject (obj);}

◆ isSurvivingObject() [2/2]

bool ORUtils::BaseOverlapTool::isSurvivingObject ( columnar::Particle2Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 152 of file BaseOverlapTool.h.

152 {

153 return m_decHelper2->isSurvivingObject (obj);}

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msg_level_name()

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

inherited

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

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

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

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

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

Definition at line 101 of file AsgTool.cxx.

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

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

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

◆ setObjectFail() [1/2]

void ORUtils::BaseOverlapTool::setObjectFail ( columnar::Particle1Id obj ) const

inlineprotectedinherited

Definition at line 158 of file BaseOverlapTool.h.

158 {

159 m_decHelper1->setObjectFail (obj); }

◆ setObjectFail() [2/2]

void ORUtils::BaseOverlapTool::setObjectFail ( columnar::Particle2Id obj ) const

inlineprotectedinherited

Definition at line 160 of file BaseOverlapTool.h.

160 {

161 m_decHelper2->setObjectFail (obj); }

◆ 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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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

std::unique_ptr<BaseAccessors> ORUtils::BaseOverlapTool::m_baseAccessors {std::make_unique<BaseAccessors> (this)}

protectedinherited

Definition at line 125 of file BaseOverlapTool.h.

125{std::make_unique<BaseAccessors> (this)};

◆ m_decHelper1

std::unique_ptr<OverlapDecorationHelper<columnar::ContainerId::particle1> > ORUtils::BaseOverlapTool::m_decHelper1

protectedinherited

Helper for handling input/output decorations.

Definition at line 128 of file BaseOverlapTool.h.

◆ m_decHelper2

std::unique_ptr<OverlapDecorationHelper<columnar::ContainerId::particle2> > ORUtils::BaseOverlapTool::m_decHelper2

protectedinherited

Definition at line 129 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_dR

float ORUtils::DeltaROverlapTool::m_dR

private

Delta-R cone for flagging objects as overlap.

Definition at line 58 of file DeltaROverlapTool.h.

◆ m_dRMatcher

std::unique_ptr<DeltaRMatcher> ORUtils::DeltaROverlapTool::m_dRMatcher

private

Delta-R matcher.

Definition at line 80 of file DeltaROverlapTool.h.

◆ m_enableUserPrio

bool ORUtils::BaseOverlapTool::m_enableUserPrio

protectedinherited

Enable user-priority scoring.

Definition at line 111 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 99 of file BaseOverlapTool.h.

◆ m_linkOverlapObjects

bool ORUtils::BaseOverlapTool::m_linkOverlapObjects

protectedinherited

Flag to toggle overlap object links.

Definition at line 108 of file BaseOverlapTool.h.

◆ m_objectType1

Gaudi::Property<unsigned> ORUtils::DeltaROverlapTool::m_objectType1

private

Initial value:

{this, "ObjectType1", 0,

"The xAOD::Type::ObjectType enum value for the first particle type"}

Definition at line 69 of file DeltaROverlapTool.h.

69 {this, "ObjectType1", 0,

70 "The xAOD::Type::ObjectType enum value for the first particle type"};

◆ m_objectType2

Gaudi::Property<unsigned> ORUtils::DeltaROverlapTool::m_objectType2

private

Initial value:

{this, "ObjectType2", 0,

"The xAOD::Type::ObjectType enum value for the second particle type"}

Definition at line 71 of file DeltaROverlapTool.h.

71 {this, "ObjectType2", 0,

72 "The xAOD::Type::ObjectType enum value for the second particle type"};

◆ m_objLinkHelper1

std::unique_ptr<OverlapLinkHelper<columnar::ContainerId::particle1> > ORUtils::BaseOverlapTool::m_objLinkHelper1

protectedinherited

Helper for linking overlap objects.

Definition at line 132 of file BaseOverlapTool.h.

◆ m_objLinkHelper2

std::unique_ptr<OverlapLinkHelper<columnar::ContainerId::particle2> > ORUtils::BaseOverlapTool::m_objLinkHelper2

protectedinherited

Definition at line 133 of file BaseOverlapTool.h.

◆ m_outputLabel

std::string ORUtils::BaseOverlapTool::m_outputLabel

protectedinherited

Output object decoration which specifies overlapping objects.

Definition at line 101 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 105 of file BaseOverlapTool.h.

◆ m_swapContainerPrecedence

bool ORUtils::DeltaROverlapTool::m_swapContainerPrecedence

private

In default configuration, the first container is the one that gets tested for object rejection.

If this switch is true, it will instead be the second container which gets flagged. This is useful for modifying the behavior of a master tool in which the argument order is fixed.

Definition at line 67 of file DeltaROverlapTool.h.

◆ m_useRapidity

bool ORUtils::DeltaROverlapTool::m_useRapidity

private

Calculate delta-R using rapidity.

Definition at line 60 of file DeltaROverlapTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ DeltaROverlapTool()

Member Function Documentation

◆ addObjectLink() [1/2]

◆ addObjectLink() [2/2]

◆ callEvents()

◆ checkForXAODContainer()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ findOverlaps() [1/2]

◆ findOverlaps() [2/2]

◆ getKey()

◆ getName()

◆ getObjectPriority() [1/2]

◆ getObjectPriority() [2/2]

◆ getProperty()

◆ handleOverlap()

◆ initialize()

◆ initializeDecorations() [1/2]

◆ initializeDecorations() [2/2]

◆ initializeDerived()

◆ inputHandles()

◆ internalFindOverlaps()

◆ isRejectedObject() [1/2]

◆ isRejectedObject() [2/2]

◆ isSurvivingObject() [1/2]

◆ isSurvivingObject() [2/2]

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ setObjectFail() [1/2]

◆ setObjectFail() [2/2]

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_baseAccessors

◆ m_decHelper1

◆ m_decHelper2

◆ m_detStore

◆ m_dR

◆ m_dRMatcher

◆ m_enableUserPrio

◆ m_evtStore

◆ m_inputLabel

◆ m_linkOverlapObjects

◆ m_objectType1

◆ m_objectType2

◆ m_objLinkHelper1

◆ m_objLinkHelper2

◆ m_outputLabel

◆ m_outputPassValue

◆ m_swapContainerPrecedence

◆ m_useRapidity

◆ m_varHandleArraysDeclared

◆ m_vhka