top-level tool for performing overlap removal. More...

#include <OverlapRemovalTool.h>

Inheritance diagram for ORUtils::OverlapRemovalTool:

Collaboration diagram for ORUtils::OverlapRemovalTool:

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

virtual StatusCode	initialize () override
	Initialize the tool. More...

virtual StatusCode	removeOverlaps (const xAOD::ElectronContainer electrons, const xAOD::MuonContainer muons, const xAOD::JetContainer jets, const xAOD::TauJetContainer taus=0, const xAOD::PhotonContainer photons=0, const xAOD::JetContainer fatJets=0) const override
	Top-level method for performing full overlap-removal. More...

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

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

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	removeOverlap (const ToolHandle< IOverlapTool > &tool, const xAOD::IParticleContainer cont1, const xAOD::IParticleContainer cont2) const
	Use one tool to remove overlaps. 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
std::string	m_inputLabel
	Input object decoration which specifies which objects to look at. More...

std::string	m_outputLabel
	Output object decoration which specifies overlapping objects. More...

bool	m_outputPassValue
	Toggle the output flag logic. More...

bool	m_requireExpectedPointers
	Require non-null container pointers when expected; i.e., when corresponding overlap tools are configured. More...

std::unique_ptr< OverlapDecorationHelper >	m_decHelper
	Helper used to reset decorations. More...

ToolHandle< IOverlapTool >	m_eleEleORT
	Ele-ele overlap handle. More...

ToolHandle< IOverlapTool >	m_eleMuORT
	Ele-mu overlap handle. More...

ToolHandle< IOverlapTool >	m_eleJetORT
	Ele-jet overlap handle. More...

ToolHandle< IOverlapTool >	m_muJetORT
	Mu-jet overlap handle. More...

ToolHandle< IOverlapTool >	m_tauEleORT
	Tau-ele overlap handle. More...

ToolHandle< IOverlapTool >	m_tauMuORT
	Tau-mu overlap handle. More...

ToolHandle< IOverlapTool >	m_tauJetORT
	Tau-jet overlap handle. More...

ToolHandle< IOverlapTool >	m_phoEleORT
	Pho-ele overlap handle. More...

ToolHandle< IOverlapTool >	m_phoMuORT
	Pho-mu overlap handle. More...

ToolHandle< IOverlapTool >	m_phoJetORT
	Pho-jet overlap handle. More...

ToolHandle< IOverlapTool >	m_eleFatJetORT
	ele-fatjet overlap handle More...

ToolHandle< IOverlapTool >	m_jetFatJetORT
	jet-fatjet overlap handle More...

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

top-level tool for performing overlap removal.

This tool will apply the overlap removals specified by the user in the form of IOverlapTools in the recommended order.

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

Definition at line 30 of file OverlapRemovalTool.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

◆ OverlapRemovalTool()

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

Create a proper constructor for Athena.

Constructor for standalone usage

Definition at line 16 of file OverlapRemovalTool.cxx.

     : asg::AsgTool(name),
       m_eleEleORT("", this),
       m_eleMuORT("", this), m_eleJetORT("", this), m_muJetORT("", this),
       m_tauEleORT("", this), m_tauMuORT("", this), m_tauJetORT("", this),
       m_phoEleORT("", this), m_phoMuORT("", this), m_phoJetORT("", this),
       m_eleFatJetORT("", this), m_jetFatJetORT("", this)
   {
     declareProperty("EleEleORT", m_eleEleORT, "Electron-electron overlap tool");
     declareProperty("EleMuORT", m_eleMuORT, "Electron-muon overlap tool");
     declareProperty("EleJetORT", m_eleJetORT, "Electron-jet overlap tool");
     declareProperty("MuJetORT", m_muJetORT, "Muon-jet overlap tool");
     declareProperty("TauEleORT", m_tauEleORT, "Tau-electron overlap tool");
     declareProperty("TauMuORT", m_tauMuORT, "Tau-muon overlap tool");
     declareProperty("TauJetORT", m_tauJetORT, "Tau-jet overlap tool");
     declareProperty("PhoEleORT", m_phoEleORT, "Photon-electron overlap tool");
     declareProperty("PhoMuORT", m_phoMuORT, "Photon-muon overlap tool");
     declareProperty("PhoJetORT", m_phoJetORT, "Photon-jet overlap tool");
     declareProperty("EleFatJetORT", m_eleFatJetORT, "electron-fatjet overlap tool");
     declareProperty("JetFatJetORT", m_jetFatJetORT, "jet-fatjet overlap tool");
  
     // Input/output labels for reset functionality.
     declareProperty("InputLabel", m_inputLabel = "selected",
                     "Decoration which specifies input objects");
     declareProperty("OutputLabel", m_outputLabel = "overlaps",
                     "Decoration given to objects that fail OR");
     declareProperty("OutputPassValue", m_outputPassValue = false,
                     "Set the result assigned to objects that pass");
     declareProperty("RequireExpectedPointers", m_requireExpectedPointers = true,
                     "Require non-null container pointers when expected by config");
   }

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                     {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getKey( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       return ( proxy == nullptr ? 0 : proxy->sgkey() );
 #endif // XAOD_STANDALONE
    }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                             {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getName( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       static const std::string dummy = "";
       return ( proxy == nullptr ? dummy : proxy->name() );
 #endif // XAOD_STANDALONE
    }

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode ORUtils::OverlapRemovalTool::initialize ( )

overridevirtual

Initialize the tool.

Reimplemented from asg::AsgTool.

Definition at line 51 of file OverlapRemovalTool.cxx.

   {
     ATH_MSG_DEBUG("Initializing master tool " << name());
     ATH_MSG_DEBUG("Master tool config: InputLabel " << m_inputLabel <<
                   " OutputLabel " << m_outputLabel <<
                   " OutputPassValue " << m_outputPassValue);
  
     // Initialize the decoration helper
     m_decHelper =
       std::make_unique<OverlapDecorationHelper>
         (m_inputLabel, m_outputLabel, m_outputPassValue);
  
     // Retrieve the configured tools
     if(!m_eleEleORT.empty()) ATH_CHECK( m_eleEleORT.retrieve() );
     if(!m_eleMuORT.empty())  ATH_CHECK( m_eleMuORT.retrieve() );
     if(!m_eleJetORT.empty()) ATH_CHECK( m_eleJetORT.retrieve() );
     if(!m_muJetORT.empty())  ATH_CHECK( m_muJetORT.retrieve() );
     if(!m_tauEleORT.empty()) ATH_CHECK( m_tauEleORT.retrieve() );
     if(!m_tauMuORT.empty())  ATH_CHECK( m_tauMuORT.retrieve() );
     if(!m_tauJetORT.empty()) ATH_CHECK( m_tauJetORT.retrieve() );
     if(!m_phoEleORT.empty()) ATH_CHECK( m_phoEleORT.retrieve() );
     if(!m_phoMuORT.empty())  ATH_CHECK( m_phoMuORT.retrieve() );
     if(!m_phoJetORT.empty()) ATH_CHECK( m_phoJetORT.retrieve() );
     if(!m_eleFatJetORT.empty()) ATH_CHECK( m_eleFatJetORT.retrieve() );
     if(!m_jetFatJetORT.empty()) ATH_CHECK( m_jetFatJetORT.retrieve() );
  
     return StatusCode::SUCCESS;
   }

◆ inputHandles()

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

overridevirtualinherited

Return this algorithm's input handles.

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

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msg_level_name()

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

inherited

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

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

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

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

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

Definition at line 101 of file AsgTool.cxx.

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

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

◆ print() [1/2]

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

◆ print() [2/2]

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

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

◆ removeOverlap()

StatusCode ORUtils::OverlapRemovalTool::removeOverlap	(	const ToolHandle< IOverlapTool > &	tool,
		const xAOD::IParticleContainer *	cont1,
		const xAOD::IParticleContainer *	cont2
	)		const

private

Use one tool to remove overlaps.

Definition at line 134 of file OverlapRemovalTool.cxx.

   {
     if(!tool.empty()) {
       if(cont1 && cont2) {
         ATH_CHECK( tool->findOverlaps(*cont1, *cont2) );
       }
       else if(!cont1 && m_requireExpectedPointers) {
         ATH_MSG_ERROR("First container pointer for " << tool.name() << " is NULL!");
         return StatusCode::FAILURE;
       }
       else if(!cont2 && m_requireExpectedPointers) {
         ATH_MSG_ERROR("Second container pointer for " << tool.name() << " is NULL!");
         return StatusCode::FAILURE;
       }
     }
     return StatusCode::SUCCESS;
   }

◆ removeOverlaps()

StatusCode ORUtils::OverlapRemovalTool::removeOverlaps	(	const xAOD::ElectronContainer *	electrons,
		const xAOD::MuonContainer *	muons,
		const xAOD::JetContainer *	jets,
		const xAOD::TauJetContainer *	taus = `0`,
		const xAOD::PhotonContainer *	photons = `0`,
		const xAOD::JetContainer *	fatJets = `0`
	)		const

overridevirtual

Top-level method for performing full overlap-removal.

The individual OR methods will be called in the recommended order, and the considered objects will be decorated with the output result.

Implements ORUtils::IOverlapRemovalTool.

Definition at line 83 of file OverlapRemovalTool.cxx.

   {
     // Reset all decorations to passing
     if(electrons) m_decHelper->resetDecorations(*electrons);
     if(muons)     m_decHelper->resetDecorations(*muons);
     if(jets)      m_decHelper->resetDecorations(*jets);
     if(taus)      m_decHelper->resetDecorations(*taus);
     if(photons)   m_decHelper->resetDecorations(*photons);
     if(fatJets)   m_decHelper->resetDecorations(*fatJets);
  
     // Following recommended removal sequence from harmonization note.
     // NOTE: some details are still unspecific in the recommendations.
     // Talk to me if this does not support your needs.
  
     // Electron-electron OR
     ATH_CHECK( removeOverlap(m_eleEleORT, electrons, electrons) );
     // Tau-electron OR
     ATH_CHECK( removeOverlap(m_tauEleORT, taus, electrons));
     // Tau-muon OR
     ATH_CHECK( removeOverlap(m_tauMuORT, taus, muons) );
     // Electron-muon OR
     ATH_CHECK( removeOverlap(m_eleMuORT, electrons, muons) );
     // Pho-electron OR
     ATH_CHECK( removeOverlap(m_phoEleORT, photons, electrons) );
     // Pho-muon OR
     ATH_CHECK( removeOverlap(m_phoMuORT, photons, muons) );
     // Electron-jet OR
     ATH_CHECK( removeOverlap(m_eleJetORT, electrons, jets) );
     // Muon-jet OR
     ATH_CHECK( removeOverlap(m_muJetORT, muons, jets) );
     // Tau-jet OR
     ATH_CHECK( removeOverlap(m_tauJetORT, jets, taus) );
     // Pho-jet OR
     ATH_CHECK( removeOverlap(m_phoJetORT, jets, photons) );
     // Electron-fatjet OR
     ATH_CHECK( removeOverlap(m_eleFatJetORT, fatJets, electrons) );
     // jet-fatjet OR
     ATH_CHECK( removeOverlap(m_jetFatJetORT, jets, fatJets) );
  
     return StatusCode::SUCCESS;
   }

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_decHelper

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

private

Helper used to reset decorations.

Definition at line 87 of file OverlapRemovalTool.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_eleEleORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_eleEleORT

private

Ele-ele overlap handle.

Definition at line 94 of file OverlapRemovalTool.h.

◆ m_eleFatJetORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_eleFatJetORT

private

ele-fatjet overlap handle

Definition at line 124 of file OverlapRemovalTool.h.

◆ m_eleJetORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_eleJetORT

private

Ele-jet overlap handle.

Definition at line 100 of file OverlapRemovalTool.h.

◆ m_eleMuORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_eleMuORT

private

Ele-mu overlap handle.

Definition at line 97 of file OverlapRemovalTool.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::OverlapRemovalTool::m_inputLabel

private

Input object decoration which specifies which objects to look at.

Definition at line 70 of file OverlapRemovalTool.h.

◆ m_jetFatJetORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_jetFatJetORT

private

jet-fatjet overlap handle

Definition at line 127 of file OverlapRemovalTool.h.

◆ m_muJetORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_muJetORT

private

Mu-jet overlap handle.

Definition at line 103 of file OverlapRemovalTool.h.

◆ m_outputLabel

std::string ORUtils::OverlapRemovalTool::m_outputLabel

private

Output object decoration which specifies overlapping objects.

Definition at line 72 of file OverlapRemovalTool.h.

◆ m_outputPassValue

bool ORUtils::OverlapRemovalTool::m_outputPassValue

private

Toggle the output flag logic.

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

Definition at line 76 of file OverlapRemovalTool.h.

◆ m_phoEleORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_phoEleORT

private

Pho-ele overlap handle.

Definition at line 115 of file OverlapRemovalTool.h.

◆ m_phoJetORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_phoJetORT

private

Pho-jet overlap handle.

Definition at line 121 of file OverlapRemovalTool.h.

◆ m_phoMuORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_phoMuORT

private

Pho-mu overlap handle.

Definition at line 118 of file OverlapRemovalTool.h.

◆ m_requireExpectedPointers

bool ORUtils::OverlapRemovalTool::m_requireExpectedPointers

private

Require non-null container pointers when expected; i.e., when corresponding overlap tools are configured.

On by default.

Definition at line 80 of file OverlapRemovalTool.h.

◆ m_tauEleORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_tauEleORT

private

Tau-ele overlap handle.

Definition at line 106 of file OverlapRemovalTool.h.

◆ m_tauJetORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_tauJetORT

private

Tau-jet overlap handle.

Definition at line 112 of file OverlapRemovalTool.h.

◆ m_tauMuORT

ToolHandle<IOverlapTool> ORUtils::OverlapRemovalTool::m_tauMuORT

private

Tau-mu overlap handle.

Definition at line 109 of file OverlapRemovalTool.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

◆ OverlapRemovalTool()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ removeOverlap()

◆ removeOverlaps()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_decHelper

◆ m_detStore

◆ m_eleEleORT

◆ m_eleFatJetORT

◆ m_eleJetORT

◆ m_eleMuORT

◆ m_evtStore

◆ m_inputLabel

◆ m_jetFatJetORT

◆ m_muJetORT

◆ m_outputLabel

◆ m_outputPassValue

◆ m_phoEleORT

◆ m_phoJetORT

◆ m_phoMuORT

◆ m_requireExpectedPointers

◆ m_tauEleORT

◆ m_tauJetORT

◆ m_tauMuORT

◆ m_varHandleArraysDeclared

◆ m_vhka