#include <CaloClusterMatchingTool.h>

Inheritance diagram for ClusterMatching::CaloClusterMatchingTool:

Collaboration diagram for ClusterMatching::CaloClusterMatchingTool:

Public Types
using	elementLinkDecorHandle_t = SG::WriteDecorHandle< xAOD::CaloClusterContainer, std::vector< ElementLink< xAOD::CaloClusterContainer > > >

Public Member Functions
virtual	~CaloClusterMatchingTool ()
	Destructor: More...

virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...

virtual StatusCode	finalize () override

StatusCode	fillClusterMap (const EventContext &ctx, TopoClusterMap &tcmap) const override final

float	getClusterSharedEfrac (const xAOD::CaloCluster &refCluster, const xAOD::CaloCluster &testCluster) const override final

bool	clustersAreMatched (const xAOD::CaloCluster &refCluster, const xAOD::CaloCluster &testCluster) const override final

bool	getMatchedClusters (const xAOD::CaloCluster &refCluster, const std::vector< const xAOD::CaloCluster * > &testClusters, std::vector< const xAOD::CaloCluster * > &matchedClusters) const override final

bool	getMatchedClusters (const xAOD::CaloCluster &refCluster, std::vector< const xAOD::CaloCluster * > &matchedClusters, const TopoClusterMap &tcmap, bool useLeadingCellEtaPhi) const override final

bool	getMatchedClusters (const xAOD::CaloCluster &refCluster, const std::vector< const xAOD::CaloCluster * > &testClusters, std::vector< std::pair< const xAOD::CaloCluster *, float > > &matchedClusters) const override final

bool	getMatchedClusters (const xAOD::CaloCluster &refCluster, std::vector< std::pair< const xAOD::CaloCluster *, float > > &matchedClusters, const TopoClusterMap &tcmap, bool useLeadingCellEtaPhi) const override final

StatusCode	linkMatchedClusters (elementLinkDecorHandle_t &elementLinkDec, const xAOD::CaloCluster &refCluster, const std::vector< const xAOD::CaloCluster * > &testClusters, bool(gtrthan)(const std::pair< const xAOD::CaloCluster , float > &pair1, const std::pair< const xAOD::CaloCluster *, float > &pair2)) const override final

StatusCode	linkMatchedClusters (elementLinkDecorHandle_t &elementLinkDec, const xAOD::CaloCluster &refCluster, const TopoClusterMap &tcmap, bool useLeadingCellEtaPhi, bool(gtrthan)(const std::pair< const xAOD::CaloCluster , float > &pair1, const std::pair< const xAOD::CaloCluster *, float > &pair2)) const override final

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
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
Gaudi::Property< bool >	m_reqPosE { this, "RequirePositiveE", true }

Gaudi::Property< float >	m_minSharedEfrac { this, "MinSharedEfrac", 0.2 }

SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_clustersIn

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

Definition at line 32 of file CaloClusterMatchingTool.h.

Member Typedef Documentation

◆ elementLinkDecorHandle_t

using ICaloClusterMatchingTool::elementLinkDecorHandle_t = SG::WriteDecorHandle<xAOD::CaloClusterContainer,std::vector<ElementLink<xAOD::CaloClusterContainer> > >

inherited

Definition at line 47 of file ICaloClusterMatchingTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ~CaloClusterMatchingTool()

ClusterMatching::CaloClusterMatchingTool::~CaloClusterMatchingTool ( )

virtualdefault

Destructor:

Member Function Documentation

◆ clustersAreMatched()

bool ClusterMatching::CaloClusterMatchingTool::clustersAreMatched	(	const xAOD::CaloCluster &	refCluster,
		const xAOD::CaloCluster &	testCluster
	)		const

finaloverridevirtual

Implements ICaloClusterMatchingTool.

Definition at line 93 of file CaloClusterMatchingTool.cxx.

   {
     return getClusterSharedEfrac(refCluster,testCluster)>m_minSharedEfrac;
   }

◆ 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

◆ fillClusterMap()

StatusCode ClusterMatching::CaloClusterMatchingTool::fillClusterMap	(	const EventContext &	ctx,
		TopoClusterMap &	tcmap
	)		const

finaloverridevirtual

Implements ICaloClusterMatchingTool.

Definition at line 58 of file CaloClusterMatchingTool.cxx.

   {
  
     SG::ReadHandle<xAOD::CaloClusterContainer> topoclusters (m_clustersIn, ctx);
     ATH_CHECK( tcmap.SetTopoClusters(topoclusters.cptr()) );
  
     return StatusCode::SUCCESS;
   }

◆ finalize()

StatusCode ClusterMatching::CaloClusterMatchingTool::finalize ( )

overridevirtual

Definition at line 47 of file CaloClusterMatchingTool.cxx.

   {
     ATH_MSG_INFO ("Finalizing " << name() << "...");
  
     return StatusCode::SUCCESS;
   }

◆ getClusterSharedEfrac()

float ClusterMatching::CaloClusterMatchingTool::getClusterSharedEfrac	(	const xAOD::CaloCluster &	refCluster,
		const xAOD::CaloCluster &	testCluster
	)		const

finaloverridevirtual

Implements ICaloClusterMatchingTool.

Definition at line 68 of file CaloClusterMatchingTool.cxx.

   {
     int nSharedCells(0);
     float sharedE(0.);
     float totalE(0.);
     for (auto tcItr = testCluster.cell_begin(); tcItr != testCluster.cell_end();++tcItr) {
       if (tcItr->e() > 1e-9 || !m_reqPosE) {
         for (auto rcItr = refCluster.cell_begin(); rcItr != refCluster.cell_end(); ++rcItr) {
           if (*tcItr && *rcItr && (*tcItr == *rcItr)) {
             ++nSharedCells;
             sharedE += tcItr->e();
           }
         }
         totalE += tcItr->e();
       }
     }
     if(nSharedCells>0) {
       ATH_MSG_VERBOSE("Reference cluster and target cluster share " << nSharedCells << " cells, " << sharedE << " / " << totalE << " MeV");
       ATH_MSG_VERBOSE("DeltaR = " << refCluster.p4().DeltaR(testCluster.p4()));
     }
     return totalE<1e-9 ? 0. : sharedE/totalE;
   }

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

◆ getMatchedClusters() [1/4]

bool ClusterMatching::CaloClusterMatchingTool::getMatchedClusters	(	const xAOD::CaloCluster &	refCluster,
		const std::vector< const xAOD::CaloCluster * > &	testClusters,
		std::vector< const xAOD::CaloCluster * > &	matchedClusters
	)		const

finaloverridevirtual

Implements ICaloClusterMatchingTool.

Definition at line 102 of file CaloClusterMatchingTool.cxx.

   {
     // check that it's empty?
     matchedClusters.clear();
  
     for(const auto& testCluster : testClusters) {
       if(clustersAreMatched(refCluster, *testCluster)) matchedClusters.push_back(testCluster);
     }
     return !matchedClusters.empty();
   }

◆ getMatchedClusters() [2/4]

bool ClusterMatching::CaloClusterMatchingTool::getMatchedClusters	(	const xAOD::CaloCluster &	refCluster,
		const std::vector< const xAOD::CaloCluster * > &	testClusters,
		std::vector< std::pair< const xAOD::CaloCluster *, float > > &	matchedClusters
	)		const

finaloverridevirtual

Implements ICaloClusterMatchingTool.

Definition at line 150 of file CaloClusterMatchingTool.cxx.

   {
     // check that it's empty?
     matchedClustersAndE.clear();
  
     for(const auto& testCluster : testClusters) {
       float sharedEfrac = getClusterSharedEfrac(refCluster, *testCluster);
       if(sharedEfrac>m_minSharedEfrac) {
     matchedClustersAndE.emplace_back(testCluster,sharedEfrac);
       }
     }
     return !matchedClustersAndE.empty();
   }

◆ getMatchedClusters() [3/4]

bool ClusterMatching::CaloClusterMatchingTool::getMatchedClusters	(	const xAOD::CaloCluster &	refCluster,
		std::vector< const xAOD::CaloCluster * > &	matchedClusters,
		const TopoClusterMap &	tcmap,
		bool	useLeadingCellEtaPhi
	)		const

finaloverridevirtual

Implements ICaloClusterMatchingTool.

Definition at line 118 of file CaloClusterMatchingTool.cxx.

   {
     float refEta(0.), refPhi(0.);
     if(useLeadingCellEtaPhi) { // needed for muons because muon clusters have no eta/phi
       const CaloCell* leadcell(nullptr);
       float leadcellE(0.);
       for(auto refItr = refCluster.cell_begin(); refItr!=refCluster.cell_end(); ++refItr) {
     if(refItr->e() > leadcellE) leadcell = *refItr;
       }
       if(leadcell) {
         refEta = leadcell->eta();
         refPhi = leadcell->phi();
       }
     } else {
       refEta = refCluster.eta();
       refPhi = refCluster.phi();
     }
  
     // for now use the standard matching sizes determined by egamma, but may need to change for muons??
     // egamma shower is probably wider than muon cell track
     const std::vector<const xAOD::CaloCluster*> testClusters =
       tcmap.RetrieveTopoClusters(refEta, refPhi, refCluster.e()*cosh(refEta));
  
     return getMatchedClusters(refCluster, testClusters, matchedClusters);
   }

◆ getMatchedClusters() [4/4]

bool ClusterMatching::CaloClusterMatchingTool::getMatchedClusters	(	const xAOD::CaloCluster &	refCluster,
		std::vector< std::pair< const xAOD::CaloCluster *, float > > &	matchedClusters,
		const TopoClusterMap &	tcmap,
		bool	useLeadingCellEtaPhi
	)		const

finaloverridevirtual

Implements ICaloClusterMatchingTool.

Definition at line 169 of file CaloClusterMatchingTool.cxx.

   {
     float refEta(0.), refPhi(0.);
     if(useLeadingCellEtaPhi) { // needed for muons because muon clusters have no eta/phi
       const CaloCell* leadcell(nullptr);
       float leadcellE(0.);
       for(auto refItr = refCluster.cell_begin(); refItr!=refCluster.cell_end(); ++refItr) {
     if(refItr->e() > leadcellE) leadcell = *refItr;
       }
       if(leadcell) {
     refEta = leadcell->eta();
     refPhi = leadcell->phi();
       }
     } else {
       refEta = refCluster.eta();
       refPhi = refCluster.phi();
     }
  
     // for now use the standard matching sizes determined by egamma, but may need to change for muons??
     // egamma shower is probably wider than muon cell track
     const std::vector<const xAOD::CaloCluster*> testClusters =
       tcmap.RetrieveTopoClusters(refEta, refPhi, refCluster.e()*cosh(refEta));
  
     return getMatchedClusters(refCluster, testClusters, matchedClustersAndE);
   }

◆ 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 ClusterMatching::CaloClusterMatchingTool::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 32 of file CaloClusterMatchingTool.cxx.

   {
     ATH_MSG_INFO ("Initializing " << name() << "...");
  
     if (m_clustersIn.empty()) {
       ATH_MSG_ERROR("Empty name provided for TopoCluster collection nothing to "
                     "work with -- aborting");
       return StatusCode::FAILURE;
     }
  
     ATH_CHECK(m_clustersIn.initialize());
  
     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.

◆ linkMatchedClusters() [1/2]

StatusCode ClusterMatching::CaloClusterMatchingTool::linkMatchedClusters	(	elementLinkDecorHandle_t &	elementLinkDec,
		const xAOD::CaloCluster &	refCluster,
		const std::vector< const xAOD::CaloCluster * > &	testClusters,
		bool()(const std::pair< const xAOD::CaloCluster , float > &pair1, const std::pair< const xAOD::CaloCluster *, float > &pair2)	gtrthan
	)		const

finaloverridevirtual

Implements ICaloClusterMatchingTool.

Definition at line 201 of file CaloClusterMatchingTool.cxx.

   {
     std::vector<std::pair<const CaloCluster*,float> > matchedClustersAndE;
     std::vector<ElementLink<CaloClusterContainer> > tcLinks;
     std::vector<float> tcSharedE;
     if(!testClusters.empty()) {
       const CaloClusterContainer* pClCont = static_cast<const CaloClusterContainer*>(testClusters.front()->container());
       if(getMatchedClusters(refCluster, testClusters, matchedClustersAndE)) {
         std::sort(matchedClustersAndE.begin(),matchedClustersAndE.end(),gtrthan);
         for(const auto& tcAndE : matchedClustersAndE) {
           tcLinks.emplace_back(*pClCont,tcAndE.first->index());
           tcSharedE.push_back(tcAndE.second);
         }
       }
     }
     // apply the decoration to the reference cluster -- no exceptions
     elementLinkDec(refCluster) = tcLinks;
     ATH_MSG_VERBOSE("Decorate cluster " << refCluster.index() << " with " << elementLinkDec(refCluster).size() << " tc links");
  
     return StatusCode::SUCCESS;
   }

◆ linkMatchedClusters() [2/2]

StatusCode ClusterMatching::CaloClusterMatchingTool::linkMatchedClusters	(	elementLinkDecorHandle_t &	elementLinkDec,
		const xAOD::CaloCluster &	refCluster,
		const TopoClusterMap &	tcmap,
		bool	useLeadingCellEtaPhi,
		bool()(const std::pair< const xAOD::CaloCluster , float > &pair1, const std::pair< const xAOD::CaloCluster *, float > &pair2)	gtrthan
	)		const

finaloverridevirtual

Implements ICaloClusterMatchingTool.

Definition at line 230 of file CaloClusterMatchingTool.cxx.

   {
     std::vector<std::pair<const CaloCluster*,float> > matchedClustersAndE;
     std::vector<ElementLink<CaloClusterContainer> > tcLinks;
     std::vector<float> tcSharedE;
     // no need to worry about return value.
     if(getMatchedClusters(refCluster, matchedClustersAndE, tcmap, useLeadingCellEtaPhi)) {
       const CaloClusterContainer* pClCont = static_cast<const CaloClusterContainer*>(matchedClustersAndE.front().first->container());
       std::sort(matchedClustersAndE.begin(),matchedClustersAndE.end(),gtrthan);
       for(const auto& tcAndE : matchedClustersAndE) {
         tcLinks.emplace_back(*pClCont,tcAndE.first->index());
         tcSharedE.push_back(tcAndE.second);
       }
     }
     // apply the decoration to the reference cluster -- no exceptions
     elementLinkDec(refCluster) = tcLinks;
     ATH_MSG_VERBOSE("Decorate cluster " << refCluster.index() << " with " << elementLinkDec(refCluster).size() << " tc links");
  
     return StatusCode::SUCCESS;
   }

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

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

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

SG::ReadHandleKey<xAOD::CaloClusterContainer> ClusterMatching::CaloClusterMatchingTool::m_clustersIn

private

Initial value:

{
      this,
      "InputClusterCollection",
      "CaloCalTopoClusters",
      "The CaloCluster collection to match to "
    }

Definition at line 122 of file CaloClusterMatchingTool.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_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_minSharedEfrac

Gaudi::Property<float> ClusterMatching::CaloClusterMatchingTool::m_minSharedEfrac { this, "MinSharedEfrac", 0.2 }

private

Definition at line 121 of file CaloClusterMatchingTool.h.

◆ m_reqPosE

Gaudi::Property<bool> ClusterMatching::CaloClusterMatchingTool::m_reqPosE { this, "RequirePositiveE", true }

private

Definition at line 120 of file CaloClusterMatchingTool.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 Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ elementLinkDecorHandle_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ~CaloClusterMatchingTool()

Member Function Documentation

◆ clustersAreMatched()

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

◆ fillClusterMap()

◆ finalize()

◆ getClusterSharedEfrac()

◆ getKey()

◆ getMatchedClusters() [1/4]

◆ getMatchedClusters() [2/4]

◆ getMatchedClusters() [3/4]

◆ getMatchedClusters() [4/4]

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ linkMatchedClusters() [1/2]

◆ linkMatchedClusters() [2/2]

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_clustersIn

◆ m_detStore

◆ m_evtStore

◆ m_minSharedEfrac

◆ m_reqPosE

◆ m_varHandleArraysDeclared

◆ m_vhka