dRMatchingTool Class Reference

Tool to perform dR-based matching of tracks and truth particles. More...

#include <dRMatchingTool.h>

Inheritance diagram for dRMatchingTool:

Collaboration diagram for dRMatchingTool:

Classes
struct	CacheEntry

Public Member Functions
	dRMatchingTool (const std::string &name)
	Constructor(s).
virtual	~dRMatchingTool ()
	Destructor.
virtual StatusCode	initialize () override
	SelectionTool method(s).
virtual StatusCode	finalize () override
virtual const asg::AcceptInfo &	getAcceptInfo () const override
	Declare the interface ID for this pure-virtual interface class to the Athena framework.
virtual asg::AcceptData	accept (const xAOD::IParticle *p) const override
	The main accept method: the actual cuts are applied here.
virtual asg::AcceptData	acceptLegacy (const xAOD::TrackParticle *p, const xAOD::TruthParticleContainer *truthParticles, bool(*truthSelectionTool)(const xAOD::TruthParticle *)=nullptr) const
	dR-matching specific method(s).
asg::AcceptData	accept (const xAOD::TrackParticle *p, const xAOD::TruthParticleContainer *truthParticles, bool(*truthSelectionTool)(const xAOD::TruthParticle *)=nullptr) const
virtual asg::AcceptData	acceptLegacy (const xAOD::TruthParticle *p, const xAOD::TrackParticleContainer *trackParticles, bool(*trackSelectionTool)(const xAOD::TrackParticle *)=nullptr) const
asg::AcceptData	accept (const xAOD::TruthParticle *p, const xAOD::TrackParticleContainer *trackParticles, bool(*trackSelectionTool)(const xAOD::TrackParticle *)=nullptr) const
float	dRmin () const
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
void	checkCacheTrackParticles (const xAOD::TrackParticleContainer *trackParticles, CacheEntry *ent, bool(*trackSelectionTool)(const xAOD::TrackParticle *)=nullptr) const
	Internal method(s).
void	checkCacheTruthParticles (const xAOD::TruthParticleContainer *truthParticles, CacheEntry *ent, bool(*truthSelectionTool)(const xAOD::TruthParticle *)=nullptr) const
void	clearTrackParticles (CacheEntry *ent) const
void	clearTruthParticles (CacheEntry *ent) const
template<class T, class U>
void	sortVectors (const T *container, std::vector< const U * > &vec_pt, std::vector< const U * > &vec_eta, std::vector< const U * > &vec_phi, bool(*selectionTool)(const U *)) const
template<class U, class V>
bool	sortedMatch (const U *p, std::vector< const V * > &vec_pt, std::vector< const V * > &vec_eta, std::vector< const V * > &vec_phi, float &dRmin) const
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	ASG_TOOL_CLASS1 (dRMatchingTool, IAsgSelectionTool)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
asg::AcceptInfo	m_accept {"dRMatching"}
	Data member(s).
std::vector< std::pair< std::string, std::string > >	m_cuts
std::atomic< ULong64_t >	m_numProcessed {0}
std::atomic< ULong64_t >	m_numPassed {0}
std::vector< ULong64_t > m_numPassedCuts	ATLAS_THREAD_SAFE
std::mutex	m_mutex
FloatProperty	m_dRmax {this, "dRmax", -1.}
	Cut vales.
FloatProperty	m_pTResMax {this, "pTResMax", -1.}
SG::SlotSpecificObj< CacheEntry > m_cache	ATLAS_THREAD_SAFE
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Tool to perform dR-based matching of tracks and truth particles.

The tool can match both a single track to a set of truth particles, and vice versa. As the tool derives from the general IAsgSelectionTool interface, the actual 'accept' methods has to be invoked using (dynamic) type casting, e.g.

bool dRMatched = (bool) dynamic_cast<dRMatchingTool&>(*m_dRMatchingTool) \ .accept(track, truthParticles, &truthSelectionTool);

to match a track to a subset of truth particle, or

bool dRMatched = (bool) dynamic_cast<dRMatchingTool&>(*m_dRMatchingTool) \ .accept(truth, trackParticles);

to match a truth particle to all tracks. The standard accept(const xAOD::IParticle*) method is disabled.

Optional track- and truth particle selection functions are allowed, to perform the matching to only a subset of the respective containers. If these functions are omitted as arguments, the matching is performed to the all particles in the specified container.

The tool is able to perform matching wrt. dR as well relative pT-resolution, i.e. \Delta p_{T}/p_{T} = \frac{|p_{T,this} - p_{T,other}|}{p_{T,this}} The tool is configured such that a successful match means that all set cuts were passed. That means that if only the dR-cut is set, no pT-resoution cut is imposed, and conversely. In particular, if neither cut is set, no particles pass the matching. The cut values are set in the job option as e.g.

from InDetPhysValMonitoring.InDetPhysValMonitoringConf import \ dRMatchingTool dRMatcher = dRMatchingTool() dRMatcher.dRmax = 0.1 # Disabled: -1 dRMatcher.pTResMax = 0.1 # Disabled: -1 ToolSvc += dRMatcher

The main 'accept' methods are implemented using caching and sorting to avoid O(N^2) complexity from what is essentially nested loops. This speeds up performance drastically, at the cost of transparency. To this end, and for validation purposes, 'acceptLegacy' methods are kept in, which are conceptually simpler and more intuitive, but much slower, than the main methods. However, these legacy methods ought not to be used for actual, even just moderately large runs.

Definition at line 84 of file dRMatchingTool.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

dRMatchingTool()

dRMatchingTool::dRMatchingTool

(

const std::string &

name

)

Constructor(s).

Definition at line 94 of file dRMatchingTool.cxx.

                                                    :
  asg::AsgTool(name) {
  declareInterface<IAsgSelectionTool>(this);
}

~dRMatchingTool()

dRMatchingTool::~dRMatchingTool ( )

virtualdefault

Destructor.

Member Function Documentation

accept() [1/3]

asg::AcceptData dRMatchingTool::accept ( const xAOD::IParticle * ) const

overridevirtual

The main accept method: the actual cuts are applied here.

Implements IAsgSelectionTool.

Definition at line 150 of file dRMatchingTool.cxx.

                                                   {
 
  ATH_MSG_ERROR(
    "accept(...) function called without needed Truth- or TrackParticleContainer. Please use one of the dRMatchingTool-specific accept methods.");
 
  return asg::AcceptData (&m_accept);
}

accept() [2/3]

asg::AcceptData dRMatchingTool::accept	(	const xAOD::TrackParticle *	p,
		const xAOD::TruthParticleContainer *	truthParticles,
		bool(*	truthSelectionTool )(const xAOD::TruthParticle *) = nullptr ) const

Definition at line 364 of file dRMatchingTool.cxx.

                                                                                    {
  asg::AcceptData acceptData (&m_accept);
 
  std::lock_guard<std::mutex> lock{m_mutex}; // To guard m_numPassedCuts and m_cache
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  CacheEntry* ent{m_cache.get(ctx)};
  ent->check(ctx.evt());
 
  // Determine whether to cache current truth particle container
  checkCacheTruthParticles(truthParticles, ent, truthSelectionTool);
 
  bool passes = sortedMatch<xAOD::TrackParticle,
                            xAOD::TruthParticle>(track,
                                                 ent->m_truthParticlesSortedPt,
                                                 ent->m_truthParticlesSortedEta,
                                                 ent->m_truthParticlesSortedPhi,
                                                 ent->m_dRmin);
 
  // Set cut values.
  if (m_dRmax > -1) {
    acceptData.setCutResult("dRmax", passes);
  }
  if (m_pTResMax > -1) {
    acceptData.setCutResult("pTResMax", passes);
  }
 
  // Book keep cuts
  for (const auto& cut : m_cuts) {
    unsigned int pos = acceptData.getCutPosition(cut.first);
    if (acceptData.getCutResult(pos)) {
      m_numPassedCuts[pos]++;
    }
  }
 
  m_numProcessed++;
  if (acceptData) {
    m_numPassed++;
  }
 
  return acceptData;
}

accept() [3/3]

asg::AcceptData dRMatchingTool::accept	(	const xAOD::TruthParticle *	p,
		const xAOD::TrackParticleContainer *	trackParticles,
		bool(*	trackSelectionTool )(const xAOD::TrackParticle *) = nullptr ) const

Definition at line 409 of file dRMatchingTool.cxx.

                                                                                    {
  asg::AcceptData acceptData (&m_accept);
 
  std::lock_guard<std::mutex> lock{m_mutex}; // To guard m_numPassedCuts and m_cache
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  CacheEntry* ent{m_cache.get(ctx)};
  ent->check(ctx.evt());
 
  // Determine whether to cache current track particle container
  checkCacheTrackParticles(trackParticles, ent, trackSelectionTool);
 
  bool passes = sortedMatch<xAOD::TruthParticle,
                            xAOD::TrackParticle>(truth,
                                                 ent->m_trackParticlesSortedPt,
                                                 ent->m_trackParticlesSortedEta,
                                                 ent->m_trackParticlesSortedPhi,
                                                 ent->m_dRmin);
 
  // Set cut values.
  if (m_dRmax > -1) {
    acceptData.setCutResult("dRmax", passes);
  }
  if (m_pTResMax > -1) {
    acceptData.setCutResult("pTResMax", passes);
  }
 
  // Book keep cuts
  for (const auto& cut : m_cuts) {
    unsigned int pos = acceptData.getCutPosition(cut.first);
    if (acceptData.getCutResult(pos)) {
      m_numPassedCuts[pos]++;
    }
  }
 
  m_numProcessed++;
  if (acceptData) {
    m_numPassed++;
  }
 
  return acceptData;
}

acceptLegacy() [1/2]

asg::AcceptData dRMatchingTool::acceptLegacy ( const xAOD::TrackParticle * p, const xAOD::TruthParticleContainer * truthParticles, bool(* truthSelectionTool )(const xAOD::TruthParticle *) = nullptr ) const

virtual

dR-matching specific method(s).

Definition at line 454 of file dRMatchingTool.cxx.

                                                                                          {
  asg::AcceptData acceptData (&m_accept);
 
  std::lock_guard<std::mutex> lock{m_mutex}; // To guard m_numPassedCuts and m_cache
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  CacheEntry* ent{m_cache.get(ctx)};
  ent->check(ctx.evt());
 
  ent->m_dRmin = 9999.;
 
  // Define variables.
  const unsigned int Ncuts(m_cuts.size());
  bool passes(false), passesThis(false);
 
  // Loop all truth particles.
  for (const xAOD::TruthParticle* truth : *truthParticles) {
    // Ignore all truth particles failing the selection.
    if (truthSelectionTool and !(*truthSelectionTool)(truth)) {
      continue;
    }
 
    // Compute cut variable values.
    float dR = comp_deltaR(p, truth);
    float pTRes = std::fabs(pt(truth) / pt(p) - 1.);
 
    // Initialise cut monitoring objects.
    std::vector<bool> vecPassesThis(Ncuts, false);
 
    // Check whether each individual cut passed.
    unsigned int icut = 0;
    if (m_dRmax > -1) {
      vecPassesThis[icut++] = dR < m_dRmax;
    }
    if (m_pTResMax > -1) {
      vecPassesThis[icut++] = pTRes < m_pTResMax;
    }
 
    // Check whether all cuts passed.
    passesThis = std::all_of(vecPassesThis.begin(),
                             vecPassesThis.end(),
                             [](const bool& v) {
      return v;
    });
    passes |= passesThis;
 
    // If the current truth particle was matched, check minimal dR.
    if (passesThis) {
      ent->m_dRmin = (dR < ent->m_dRmin ? dR : ent->m_dRmin);
    }
  }
 
  // Set cut values.
  if (m_dRmax > -1) {
    acceptData.setCutResult("dRmax", passes);
  }
  if (m_pTResMax > -1) {
    acceptData.setCutResult("pTResMax", passes);
  }
 
  // Book keep cuts
  for (const auto& cut : m_cuts) {
    unsigned int pos = acceptData.getCutPosition(cut.first);
    if (acceptData.getCutResult(pos)) {
      m_numPassedCuts[pos]++;
    }
  }
 
  m_numProcessed++;
  if (acceptData) {
    m_numPassed++;
  }
 
  return acceptData;
}

acceptLegacy() [2/2]

asg::AcceptData dRMatchingTool::acceptLegacy ( const xAOD::TruthParticle * p, const xAOD::TrackParticleContainer * trackParticles, bool(* trackSelectionTool )(const xAOD::TrackParticle *) = nullptr ) const

virtual

Definition at line 532 of file dRMatchingTool.cxx.

                                                                                          {
  // Reset the results.
  asg::AcceptData acceptData (&m_accept);
 
  std::lock_guard<std::mutex> lock{m_mutex}; // To guard m_numPassedCuts and m_cache
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  CacheEntry* ent{m_cache.get(ctx)};
  ent->check(ctx.evt());
 
  ent->m_dRmin = 9999.;
 
  // Define variables.
  const unsigned int Ncuts(m_cuts.size());
  bool passes(false), passesThis(false);
 
  // Loop all track particles.
  for (const xAOD::TrackParticle* track : *trackParticles) {
    // Ignore all tracks failing the selection.
    if (trackSelectionTool and !(*trackSelectionTool)(track)) {
      continue;
    }
 
    // Compute cut variable values.
    float dR = comp_deltaR(p, track);
    float pTRes = std::fabs(pt(track) / pt(p) - 1.);
 
    // Initialise cut monitoring objects.
    std::vector<bool> vecPassesThis(Ncuts, false);
 
    // Check whether each individual cut passed.
    unsigned int icut = 0;
    if (m_dRmax > -1) {
      vecPassesThis[icut++] = dR < m_dRmax;
    }
    if (m_pTResMax > -1) {
      vecPassesThis[icut++] = pTRes < m_pTResMax;
    }
 
    // Check whether all cuts passed.
    passesThis = std::all_of(vecPassesThis.begin(),
                             vecPassesThis.end(),
                             [](const bool& v) {
      return v;
    });
    passes |= passesThis;
 
    // If the current track particle was matched, check minimal dR.
    if (passesThis) {
      ent->m_dRmin = (dR < ent->m_dRmin ? dR : ent->m_dRmin);
    }
  }
 
  // Set cut values.
  if (m_dRmax > -1) {
    acceptData.setCutResult("dRmax", passes);
  }
  if (m_pTResMax > -1) {
    acceptData.setCutResult("pTResMax", passes);
  }
 
  // Book keep cuts
  for (const auto& cut : m_cuts) {
    unsigned int pos = acceptData.getCutPosition(cut.first);
    if (acceptData.getCutResult(pos)) {
      m_numPassedCuts[pos]++;
    }
  }
 
  m_numProcessed++;
  if (acceptData) {
    m_numPassed++;
  }
 
  return acceptData;
}

ASG_TOOL_CLASS1()

dRMatchingTool::ASG_TOOL_CLASS1 ( dRMatchingTool , IAsgSelectionTool  )

private

checkCacheTrackParticles()

void dRMatchingTool::checkCacheTrackParticles ( const xAOD::TrackParticleContainer * trackParticles, CacheEntry * ent, bool(* trackSelectionTool )(const xAOD::TrackParticle *) = nullptr ) const

protected

Internal method(s).

Definition at line 185 of file dRMatchingTool.cxx.

                                                                                                      {
  // Check whether to cache.
  if (*trackParticles == ent->m_baseTrackContainer) {
    return;
  }
 
  // Clear existing cache.
  clearTrackParticles(ent);
 
  // Cache track particles.
  sortVectors<xAOD::TrackParticleContainer,
              xAOD::TrackParticle>(trackParticles,
                                   ent->m_trackParticlesSortedPt,
                                   ent->m_trackParticlesSortedEta,
                                   ent->m_trackParticlesSortedPhi,
                                   trackSelectionTool);
 
  // Store copy of base track container.
  ent->m_baseTrackContainer = *trackParticles;
}

checkCacheTruthParticles()

void dRMatchingTool::checkCacheTruthParticles ( const xAOD::TruthParticleContainer * truthParticles, CacheEntry * ent, bool(* truthSelectionTool )(const xAOD::TruthParticle *) = nullptr ) const

protected

Definition at line 209 of file dRMatchingTool.cxx.

                                                                                                      {
  // Check whether to cache.
  if (*truthParticles == ent->m_baseTruthContainer) {
    return;
  }
 
  // Clear existing cache.
  clearTruthParticles(ent);
 
  // Cache truth particles.
  sortVectors<xAOD::TruthParticleContainer,
              xAOD::TruthParticle>(truthParticles,
                                   ent->m_truthParticlesSortedPt,
                                   ent->m_truthParticlesSortedEta,
                                   ent->m_truthParticlesSortedPhi,
                                   truthSelectionTool);
 
  // Store copy of base truth container.
  ent->m_baseTruthContainer = *truthParticles;
}

clearTrackParticles()

void dRMatchingTool::clearTrackParticles ( CacheEntry * ent ) const

inlineprotected

Definition at line 180 of file dRMatchingTool.h.

                                             {
    ent->m_trackParticlesSortedPt.clear();
    ent->m_trackParticlesSortedEta.clear();
    ent->m_trackParticlesSortedPhi.clear();
    return;
  }

clearTruthParticles()

void dRMatchingTool::clearTruthParticles ( CacheEntry * ent ) const

inlineprotected

Definition at line 189 of file dRMatchingTool.h.

                                             {
    ent->m_truthParticlesSortedPt.clear();
    ent->m_truthParticlesSortedEta.clear();
    ent->m_truthParticlesSortedPhi.clear();
    return;
  }

declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

dRmin()

float dRMatchingTool::dRmin

(

)

const

Definition at line 631 of file dRMatchingTool.cxx.

                            {
  std::lock_guard<std::mutex> lock{m_mutex}; // To guard m_cache
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  CacheEntry* ent{m_cache.get(ctx)};
  ent->check(ctx.evt());
 
  return ent->m_dRmin;
}

evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ 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

finalize()

StatusCode dRMatchingTool::finalize ( )

overridevirtual

Definition at line 611 of file dRMatchingTool.cxx.

                         {
  ATH_MSG_INFO("Finalizing " << name() << "...");
 
  if (m_numProcessed == 0) {
    ATH_MSG_INFO("No tracks processed in selection tool.");
    return StatusCode::SUCCESS;
  }
  ATH_MSG_INFO(m_numPassed << " / " << m_numProcessed << " = "
                           << m_numPassed * 100. / m_numProcessed
                           << "% passed all cuts.");
  for (const auto& cut : m_cuts) {
    ULong64_t numPassed = m_numPassedCuts.at(m_accept.getCutPosition(cut.first));
    ATH_MSG_INFO(numPassed << " = " << numPassed * 100. / m_numProcessed
                           << "% passed " << cut.first << " cut.");
  }
 
  return StatusCode::SUCCESS;
}

getAcceptInfo()

const asg::AcceptInfo & dRMatchingTool::getAcceptInfo ( ) const

overridevirtual

Declare the interface ID for this pure-virtual interface class to the Athena framework.

Method to get the AcceptInfo to query what cuts are defined.

Implements IAsgSelectionTool.

Definition at line 145 of file dRMatchingTool.cxx.

                                     {
  return m_accept;
}

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 dRMatchingTool::initialize ( void )

overridevirtual

SelectionTool method(s).

If no cuts are enabled, force to have length one, such that it will always return 'false'. This is because we want the dRMatchingTool to be ineffecitive in this case, and not select all tracks.

Reimplemented from asg::AsgTool.

Definition at line 102 of file dRMatchingTool.cxx.

                           {
  if (asg::AsgTool::initialize().isFailure()) {
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_INFO("Initializing " << name() << "...");
 
  // Clear cuts container.
  m_cuts.clear();
 
  // Define cut names and descriptions.
  if (m_dRmax > -1) {
    m_cuts.emplace_back("dRmax", "Cut on maximal dR between track and truth particle.");
  }
  if (m_pTResMax > -1) {
    m_cuts.emplace_back("pTResMax",
                                    "Cut on maximal, relativ pT difference between track and truth particle.");
  }
 
  // Add cuts to the AcceptOmfp.
  for (const auto& cut : m_cuts) {
    if (m_accept.addCut(cut.first, cut.second) < 0) {
      ATH_MSG_ERROR("Failed to add cut " << cut.first << " because the AcceptInfo object is full.");
      return StatusCode::FAILURE;
    }
  }
 
  // Initialise counters.
  m_numPassedCuts.resize(m_accept.getNCuts(), 0);

  if (m_accept.getNCuts() == 0) {
    m_accept.addCut("nop", "Forcing to have length 1.");
  }
 
  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()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

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

inherited

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

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

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

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

Returns

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

Definition at line 101 of file AsgTool.cxx.

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

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sortedMatch()

template<class U, class V>

bool dRMatchingTool::sortedMatch ( const U * p, std::vector< const V * > & vec_pt, std::vector< const V * > & vec_eta, std::vector< const V * > & vec_phi, float & dRmin ) const

protected

Definition at line 234 of file dRMatchingTool.cxx.

                                                {
  // (Re-)set variables.
  dRmin = 9999.;
 
  // Perform search in cached vectors.
  auto it_pt_lower = m_pTResMax < 0 ? vec_pt.begin() :
                     std::lower_bound(vec_pt.begin(), vec_pt.end(),
                                      pt(p) * (1. - m_pTResMax),
                                      [](const V* o, const float& val) -> bool {
    return pt(o) < val;
  });
 
  auto it_pt_upper = m_pTResMax < 0 ? vec_pt.end() :
                     std::upper_bound(vec_pt.begin(), vec_pt.end(),
                                      pt(p) * (1. + m_pTResMax),
                                      [](const float& val, const V* o) -> bool {
    return val < pt(o);
  });
 
  auto it_eta_lower = m_dRmax < 0 ? vec_eta.begin() :
                      std::lower_bound(vec_eta.begin(), vec_eta.end(),
                                       eta(p) - m_dRmax,
                                       [](const V* o, const float& val) -> bool {
    return eta(o) < val;
  });
 
  auto it_eta_upper = m_dRmax < 0 ? vec_eta.end() :
                      std::upper_bound(vec_eta.begin(), vec_eta.end(),
                                       eta(p) + m_dRmax,
                                       [](const float& val, const V* o) -> bool {
    return val < eta(o);
  });
 
  // Dealing with cyclic nature of phi: Determining whether phi range wraps
  // around +-pi.
  bool wrapLow = phi(p) - m_dRmax < -M_PI;
  bool wrapHigh = phi(p) + m_dRmax > M_PI;
  bool wrap = wrapLow or wrapHigh;
 
  auto it_phi_lower = m_dRmax < 0 ? vec_phi.begin() :
                      std::lower_bound(vec_phi.begin(), vec_phi.end(),
                                       phi(p) - m_dRmax + (wrapLow ? 2.*M_PI : 0),
                                       [](const V* o, const float& val) -> bool {
    return phi(o) < val;
  });
 
  auto it_phi_upper = m_dRmax < 0 ? vec_phi.end() :
                      std::upper_bound(vec_phi.begin(), vec_phi.end(),
                                       phi(p) + m_dRmax + (wrapHigh ? -2.*M_PI : 0),
                                       [](const float& val, const V* o) -> bool {
    return val < phi(o);
  });
 
  // Break early if no truth particles passed selection.
  if (m_pTResMax > 0 and it_pt_upper < it_pt_lower) {
    return false;
  } else if (m_dRmax > 0 and it_eta_upper < it_eta_lower) {
    return false;
  } else if (m_dRmax > 0 and((!wrap and it_phi_upper < it_phi_lower)or
                               (wrap and it_phi_upper > it_phi_lower))) {
    return false;
  }
 
  // Initialise base set.
  std::vector< const V* > set(vec_pt);
 
  // -- Sort, pointer-based; necessary for set_intersection.
  std::sort(set.begin(), set.end());
 
  // Compute subset of selected truth particles.
  std::vector< const V* > subset_pt(it_pt_lower, it_pt_upper);
  std::vector< const V* > subset_eta(it_eta_lower, it_eta_upper);
  std::vector< const V* > subset_phi;
  if (!wrap) {
    subset_phi = std::vector< const V* >(it_phi_lower, it_phi_upper);
  } else {
    subset_phi = std::vector< const V* >(vec_phi.begin(), it_phi_upper);
    subset_phi.insert(subset_phi.end(), it_phi_lower, vec_phi.end());
  }
 
  // Add subsets according to specified cut values.
  std::vector< std::vector< const V* > > subsets;
  if (m_pTResMax > 0) {
    subsets.push_back(subset_pt);
  }
  if (m_dRmax > 0) {
    subsets.push_back(subset_eta);
    subsets.push_back(subset_phi);
  }
 
  // Compute successive intersections between base set and subset.
  for (std::vector< const V* > subset : subsets) {
    // -- Sort, pointer-based; necessary for set::set_intersection.
    std::sort(subset.begin(), subset.end());
 
    // -- Set intersection.
    std::vector< const V* > intersection;
    std::set_intersection(set.begin(), set.end(),
                          subset.begin(), subset.end(),
                          std::back_inserter(intersection));
 
    // -- Break early if intersection is empty.
    if (intersection.size() == 0) {
      return false;
    }
 
    set = intersection;
  }
 
  // If only pT-matching, we're done.
  if (m_dRmax < 0) {
    return set.size() > 0;
  }
 
  // Otherwise, compute dR for all remaining particles.
  bool passes = false;
  for (const V* other : set) {
    float dR = comp_deltaR(p, other);
    dRmin = (dR < dRmin ? dR : dRmin);
    passes |= dRmin < m_dRmax;
  }
 
  return passes;
}

sortVectors()

template<class T, class U>

void dRMatchingTool::sortVectors ( const T * container, std::vector< const U * > & vec_pt, std::vector< const U * > & vec_eta, std::vector< const U * > & vec_phi, bool(* selectionTool )(const U *) ) const

protected

Definition at line 160 of file dRMatchingTool.cxx.

                                                                    {
  // Look all particles in container.
  for (const U* p : *container) {
    // Ignore particles not passing the selection, if applicable.
    if (selectionTool and !(*selectionTool)(p)) {
      continue;
    }
 
    // Append passing particles to cached vectors.
    vec_pt.push_back(p);
    vec_eta.push_back(p);
    vec_phi.push_back(p);
  }
 
  // Sort vectors.
  std::sort(vec_pt.begin(), vec_pt.end(), sort_pt <U>);
  std::sort(vec_eta.begin(), vec_eta.end(), sort_eta<U>);
  std::sort(vec_phi.begin(), vec_phi.end(), sort_phi<U>);
}

sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

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

sysStart()

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

overridevirtualinherited

Handle START transition.

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

updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

ATLAS_THREAD_SAFE [1/2]

std::vector<ULong64_t> m_numPassedCuts dRMatchingTool::ATLAS_THREAD_SAFE

mutableprivate

Definition at line 223 of file dRMatchingTool.h.

ATLAS_THREAD_SAFE [2/2]

SG::SlotSpecificObj<CacheEntry> m_cache dRMatchingTool::ATLAS_THREAD_SAFE

mutableprivate

Definition at line 233 of file dRMatchingTool.h.

m_accept

asg::AcceptInfo dRMatchingTool::m_accept {"dRMatching"}

private

Data member(s).

Definition at line 216 of file dRMatchingTool.h.

{"dRMatching"};

m_cuts

std::vector<std::pair<std::string, std::string> > dRMatchingTool::m_cuts

private

Definition at line 218 of file dRMatchingTool.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_dRmax

FloatProperty dRMatchingTool::m_dRmax {this, "dRmax", -1.}

private

Cut vales.

Definition at line 228 of file dRMatchingTool.h.

{this, "dRmax", -1.};

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_mutex

std::mutex dRMatchingTool::m_mutex

mutableprivate

Definition at line 224 of file dRMatchingTool.h.

m_numPassed

std::atomic<ULong64_t> dRMatchingTool::m_numPassed {0}

mutableprivate

Definition at line 222 of file dRMatchingTool.h.

{0}; // !< a counter of the number of tracks that passed all cuts

m_numProcessed

std::atomic<ULong64_t> dRMatchingTool::m_numProcessed {0}

mutableprivate

Definition at line 221 of file dRMatchingTool.h.

{0}; // !< a counter of the number of tracks proccessed

m_pTResMax

FloatProperty dRMatchingTool::m_pTResMax {this, "pTResMax", -1.}

private

Definition at line 230 of file dRMatchingTool.h.

{this, "pTResMax", -1.};

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:

• dRMatchingTool.h
• dRMatchingTool.cxx