Implements mu-jet OR optimized for high-pt muons in boosted and highly radiative (jetty) topologies. More...

#include <AltMuJetOverlapTool.h>

Inheritance diagram for ORUtils::AltMuJetOverlapTool:

Collaboration diagram for ORUtils::AltMuJetOverlapTool:

Public Member Functions
	AltMuJetOverlapTool (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 muons and jets. More...

virtual StatusCode	findOverlaps (const xAOD::MuonContainer &muons, const xAOD::JetContainer &jets) const
	Identify overlapping muons 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...

const xAOD::Vertex *	getPrimVtx () const
	Retrieve the primary vertex used to count jet tracks. More...

int	getNumTracks (const xAOD::Jet *jet) const
	Helper method to get the number of tracks in a jet w.r.t. 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
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_bJetLabel
	Input jet decoration which labels a bjet. More...

int	m_numJetTrk
	Minimum number of tracks to keep an overlapping jet. More...

float	m_muJetPtRatio
	Maximum ratio of mu/jet PT to keep an overlapping jet. More...

float	m_innerDR
	Inner dR cone within which jets get removed. More...

double	m_slidingDRC1
	Outer cone C1, the constant offset in sliding dR. More...

double	m_slidingDRC2
	Outer cone C2, the inverse pt factor in sliding dR. More...

double	m_slidingDRMaxCone
	MaxCone, the upper limit of the sliding cone. More...

bool	m_useRapidity
	Calculate deltaR using rapidity. More...

std::unique_ptr< BJetHelper >	m_bJetHelper
	BJet helper. More...

std::unique_ptr< IParticleAssociator >	m_dRMatchCone1
	Delta-R matcher for the inner cone. More...

std::unique_ptr< IParticleAssociator >	m_dRMatchCone2
	Delta-R matcher for the outer cone. 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

Implements mu-jet OR optimized for high-pt muons in boosted and highly radiative (jetty) topologies.

This implementation comes from the strong 2Lep SUSY analysis studies which were presented in the SUSY meeting here: https://indico.cern.ch/event/436702

The procedure is two-staged:

Remove (non-b-tagged) jets overlapping with muons in an inner delta-R cone (default 0.2).
Remove muons overlapping with remaining jets using the sliding delta-R cone. See the SlidingDeltaRMatcher for more info.

Special configuration properties BJetLabel - input decoration flagging b-jets InnerDR - cone in which non-bjets are removed (default 0.2) SlidingDRC1 - constant offset for sliding dR (default 0.04) SlidingDRC2 - mu-pt dividend for sliding dR (default 10GeV) SlidingDRMaxCone - max cone size cutoff for sliding dR (default: off)

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

Definition at line 45 of file AltMuJetOverlapTool.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

◆ AltMuJetOverlapTool()

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

Create proper constructor for Athena.

Standalone constructor

Definition at line 28 of file AltMuJetOverlapTool.cxx.

     : BaseOverlapTool(name)
   {
     declareProperty("BJetLabel", m_bJetLabel = "",
                     "Input b-jet flag. Disabled by default.");
     // Disabled by default
     declareProperty("NumJetTrk", m_numJetTrk = std::numeric_limits<int>::max(),
                     "Min number of jet tracks to keep jet and remove muon");
     // Disabled by default
     declareProperty("MuJetPtRatio", m_muJetPtRatio = 0.,
                     "Max PT ratio to keep jet and remove muon");
     declareProperty("InnerDR", m_innerDR = 0.2,
                     "Inner cone for removing jets");
     declareProperty("SlidingDRC1", m_slidingDRC1 = 0.04,
                     "The constant offset for sliding dR");
     declareProperty("SlidingDRC2", m_slidingDRC2 = 10.*GeV,
                     "The inverse muon pt factor for sliding dR");
     declareProperty("SlidingDRMaxCone",
                     m_slidingDRMaxCone = std::numeric_limits<double>::max(),
                     "Maximum allowed size of sliding dR cone");
     declareProperty("UseRapidity", m_useRapidity = true,
                     "Calculate delta-R using rapidity");
   }

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

◆ findOverlaps() [1/2]

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

overridevirtual

Identify overlapping muons and jets.

First, low-track-multiplicity jets are flagged if they overlap with muons. Second, muons are flagged if they overlap with the remaining jets.

Implements ORUtils::IOverlapTool.

Definition at line 75 of file AltMuJetOverlapTool.cxx.

   {
     // Check the container types
     if(typeid(cont1) != typeid(xAOD::MuonContainer) &&
        typeid(cont1) != typeid(ConstDataVector<xAOD::MuonContainer>)) {
       ATH_MSG_ERROR("First container arg is not of type MuonContainer!");
       return StatusCode::FAILURE;
     }
     if(typeid(cont2) != typeid(xAOD::JetContainer) &&
        typeid(cont2) != typeid(ConstDataVector<xAOD::JetContainer>)) {
       ATH_MSG_ERROR("Second container arg is not of type JetContainer!");
       return StatusCode::FAILURE;
     }
     ATH_CHECK( findOverlaps(static_cast<const xAOD::MuonContainer&>(cont1),
                             static_cast<const xAOD::JetContainer&>(cont2)) );
     return StatusCode::SUCCESS;
   }

◆ findOverlaps() [2/2]

StatusCode ORUtils::AltMuJetOverlapTool::findOverlaps	(	const xAOD::MuonContainer &	muons,
		const xAOD::JetContainer &	jets
	)		const

virtual

Identify overlapping muons and jets.

The above method calls this one.

Definition at line 98 of file AltMuJetOverlapTool.cxx.

   {
     ATH_MSG_DEBUG("Removing overlapping muons and jets");
  
     // Initialize output decorations if necessary
     m_decHelper->initializeDecorations(muons);
     m_decHelper->initializeDecorations(jets);
  
     // Remove jets that overlap with muons in first cone.
     for(const auto muon : muons){
       if(!m_decHelper->isSurvivingObject(*muon)) continue;
  
       for(const auto jet : jets){
         if(!m_decHelper->isSurvivingObject(*jet)) continue;
         // User-defined jet criteria include b-tagging,
         // numTrack, and the mu/jet PT ratio
         if(m_bJetHelper && m_bJetHelper->isBJet(*jet)) continue;
         if(getNumTracks(jet) >= m_numJetTrk) continue;
         float ptRatio = muon->pt() / jet->pt();
         if(ptRatio < m_muJetPtRatio) continue;
  
         if(m_dRMatchCone1->objectsMatch(*jet, *muon)){
           ATH_CHECK( handleOverlap(jet, muon) );
         }
       }
     }
  
     // Remove muons from remaining overlapping jets
     for(const auto jet : jets){
       if(!m_decHelper->isSurvivingObject(*jet)) continue;
  
       for(const auto muon : muons){
         if(!m_decHelper->isSurvivingObject(*muon)) continue;
  
         if(m_dRMatchCone2->objectsMatch(*muon, *jet)){
           ATH_CHECK( handleOverlap(muon, jet) );
         }
       }
     }
  
     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
    }

◆ getNumTracks()

int ORUtils::AltMuJetOverlapTool::getNumTracks ( const xAOD::Jet * jet ) const

protected

Helper method to get the number of tracks in a jet w.r.t.

the primary vertex. Returns -1 if no primary vertex is found. TODO: reduce duplication with MuJetOverlapTool.

Definition at line 165 of file AltMuJetOverlapTool.cxx.

   {
     // Find the primary vertex
     auto vtx = getPrimVtx();
     if(!vtx) return -1;
     static const SG::AuxElement::ConstAccessor< std::vector<int> > acc("NumTrkPt500");
     return acc(*jet)[vtx->index()];
   }

◆ getPrimVtx()

const xAOD::Vertex * ORUtils::AltMuJetOverlapTool::getPrimVtx ( ) const

protected

Retrieve the primary vertex used to count jet tracks.

TODO: reduce duplication with MuJetOverlapTool.

Definition at line 146 of file AltMuJetOverlapTool.cxx.

   {
     const char* contName = "PrimaryVertices";
     const xAOD::VertexContainer* vertices = nullptr;
     if(evtStore()->retrieve(vertices, contName).isSuccess()) {
       for(auto vtx : *vertices) {
         if(vtx->vertexType() == xAOD::VxType::PriVtx)
           return vtx;
       }
     }
     else {
       ATH_MSG_WARNING("Failed to retrieve " << contName);
     }
     return nullptr;
   }

◆ 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::AltMuJetOverlapTool::initializeDerived ( )

overrideprotectedvirtual

Initialize the tool.

Reimplemented from ORUtils::BaseOverlapTool.

Definition at line 55 of file AltMuJetOverlapTool.cxx.

   {
     // Initialize the b-jet helper
     if(!m_bJetLabel.empty())
       m_bJetHelper = std::make_unique<BJetHelper> (m_bJetLabel);
  
     // Initialize the inner cone dR matcher
     m_dRMatchCone1 =
       std::make_unique<DeltaRMatcher> (m_innerDR, m_useRapidity);
     // Initialize the sliding dR matcher
     m_dRMatchCone2 =
       std::make_unique<SlidingDeltaRMatcher>
         (m_slidingDRC1, m_slidingDRC2, m_slidingDRMaxCone, m_useRapidity);
  
     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.

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

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

Definition at line 80 of file BaseOverlapTool.h.

◆ m_slidingDRC1

double ORUtils::AltMuJetOverlapTool::m_slidingDRC1

private

Outer cone C1, the constant offset in sliding dR.

Definition at line 102 of file AltMuJetOverlapTool.h.

◆ m_slidingDRC2

double ORUtils::AltMuJetOverlapTool::m_slidingDRC2

private

Outer cone C2, the inverse pt factor in sliding dR.

Definition at line 104 of file AltMuJetOverlapTool.h.

◆ m_slidingDRMaxCone

double ORUtils::AltMuJetOverlapTool::m_slidingDRMaxCone

private

MaxCone, the upper limit of the sliding cone.

Definition at line 106 of file AltMuJetOverlapTool.h.

◆ m_useRapidity

bool ORUtils::AltMuJetOverlapTool::m_useRapidity

private

Calculate deltaR using rapidity.

Definition at line 108 of file AltMuJetOverlapTool.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

◆ AltMuJetOverlapTool()

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

◆ findOverlaps() [1/2]

◆ findOverlaps() [2/2]

◆ getKey()

◆ getName()

◆ getNumTracks()

◆ getPrimVtx()

◆ getProperty()

◆ handleOverlap()

◆ initialize()

◆ initializeDerived()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_bJetHelper

◆ m_bJetLabel

◆ m_decHelper

◆ m_detStore

◆ m_dRMatchCone1

◆ m_dRMatchCone2

◆ m_enableUserPrio

◆ m_evtStore

◆ m_innerDR

◆ m_inputLabel

◆ m_linkOverlapObjects

◆ m_muJetPtRatio

◆ m_numJetTrk

◆ m_objLinkHelper

◆ m_outputLabel

◆ m_outputPassValue

◆ m_slidingDRC1

◆ m_slidingDRC2

◆ m_slidingDRMaxCone

◆ m_useRapidity

◆ m_varHandleArraysDeclared

◆ m_vhka