ORUtils::FEAssociationTool Class Reference

#include <FEAssociationTool.h>

Inheritance diagram for ORUtils::FEAssociationTool:

Classes
struct	ObjView
struct	PairKey
struct	PairKeyHash
struct	SharedAcc

Public Member Functions
	FEAssociationTool (const std::string &name)
virtual	~FEAssociationTool () override=default
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual StatusCode	buildAssociations (const EventContext &ctx) const override
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	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
virtual StatusCode	collectObjects (const EventContext &ctx, std::vector< ObjView > &objects) const
void	collectFEsFromIndex (const EventContext &ctx, const ObjView::Type type, const xAOD::IParticleContainer *cont, std::size_t idx, ObjView &view) const
virtual StatusCode	buildMapFromPairs (const EventContext &ctx, const std::vector< ObjView > &objects) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< xAOD::ElectronContainer >	m_elKey
SG::ReadHandleKey< xAOD::MuonContainer >	m_muKey
SG::ReadHandleKey< xAOD::PhotonContainer >	m_phKey
SG::ReadHandleKey< xAOD::TauJetContainer >	m_tauKey
SG::ReadHandleKey< xAOD::JetContainer >	m_srjKey
SG::ReadHandleKey< xAOD::JetContainer >	m_lrjKey
SG::ReadDecorHandleKey< xAOD::ElectronContainer >	m_elChargedFELinksKey
SG::ReadDecorHandleKey< xAOD::ElectronContainer >	m_elNeutralFELinksKey
SG::ReadDecorHandleKey< xAOD::MuonContainer >	m_muChargedFELinksKey
SG::ReadDecorHandleKey< xAOD::MuonContainer >	m_muNeutralFELinksKey
SG::ReadDecorHandleKey< xAOD::PhotonContainer >	m_phChargedFELinksKey
SG::ReadDecorHandleKey< xAOD::PhotonContainer >	m_phNeutralFELinksKey
SG::ReadDecorHandleKey< xAOD::TauJetContainer >	m_tauChargedFELinksKey
SG::ReadDecorHandleKey< xAOD::TauJetContainer >	m_tauNeutralFELinksKey
SG::ReadDecorHandleKey< xAOD::JetContainer >	m_srjChargedFELinksKey
SG::ReadDecorHandleKey< xAOD::JetContainer >	m_srjNeutralFELinksKey
SG::ReadDecorHandleKey< xAOD::JetContainer >	m_lrjChargedFELinksKey
SG::ReadDecorHandleKey< xAOD::JetContainer >	m_lrjNeutralFELinksKey
SG::ReadDecorHandleKey< xAOD::FlowElementContainer >	m_originalObjectLinkKey
SG::WriteHandleKey< xAOD::MissingETAssociationMap >	m_outputMapKey
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

Definition at line 38 of file FEAssociationTool.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

FEAssociationTool()

ORUtils::FEAssociationTool::FEAssociationTool

(

const std::string &

name

)

Definition at line 90 of file FEAssociationTool.cxx.

  : asg::AsgTool(name)
{}

~FEAssociationTool()

virtual ORUtils::FEAssociationTool::~FEAssociationTool ( )

overridevirtualdefault

Member Function Documentation

buildAssociations()

StatusCode ORUtils::FEAssociationTool::buildAssociations ( const EventContext & ctx ) const

overridevirtual

Implements ORUtils::IFEAssociationTool.

Definition at line 138 of file FEAssociationTool.cxx.

{
  ANA_CHECK_SET_TYPE(StatusCode);
 
  std::vector<ObjView> objects;
#ifndef XAOD_STANDALONE
  ANA_CHECK(collectObjects(ctx, objects));
#else
  ANA_CHECK(collectObjects(objects));
#endif
 
  ANA_MSG_DEBUG("Collected " << objects.size() << " objects");
 
#ifndef XAOD_STANDALONE
  ANA_CHECK(buildMapFromPairs(ctx, objects));
#else
  ANA_CHECK(buildMapFromPairs(objects));
#endif
 
  return StatusCode::SUCCESS;
}

buildMapFromPairs()

StatusCode ORUtils::FEAssociationTool::buildMapFromPairs ( const EventContext & ctx, const std::vector< ObjView > & objects ) const

privatevirtual

Definition at line 472 of file FEAssociationTool.cxx.

{
  ANA_CHECK_SET_TYPE(StatusCode);
 
  std::unordered_map<PairKey, SharedAcc, PairKeyHash> shared;
  shared.reserve(objects.size() * 2);
 
  for (std::size_t i = 0; i < objects.size(); ++i)
  {
    const auto& A = objects[i];
 
    for (std::size_t j = i + 1; j < objects.size(); ++j)
    {
      const auto& B = objects[j];
 
      float Ec = 0.f;
      float En = 0.f;
 
      if (!A.cSet.empty() && !B.cSet.empty())
      {
        const auto& small = (A.cSet.size() < B.cSet.size()) ? A.cSet : B.cSet;
        const auto& large = (A.cSet.size() < B.cSet.size()) ? B.cSet : A.cSet;
        for (const auto* fe : small) {
          if (large.count(fe)) Ec += fe->e() * INV_GEV;
        }
      }
 
      if (!A.nSet.empty() && !B.nSet.empty())
      {
        const auto& small = (A.nSet.size() < B.nSet.size()) ? A.nSet : B.nSet;
        const auto& large = (A.nSet.size() < B.nSet.size()) ? B.nSet : A.nSet;
        for (const auto* fe : small) {
          if (large.count(fe)) En += fe->e() * INV_GEV;
        }
      }
 
      if (Ec <= 0.f && En <= 0.f) continue;
 
      auto key = PairKey::make(A.cont, A.idx, B.cont, B.idx);
      auto& s = shared[key];
 
      s.Ec += Ec;
      s.En += En;
 
      s.AcTot = A.EcTot;
      s.AnTot = A.EnTot;
      s.BcTot = B.EcTot;
      s.BnTot = B.EnTot;
 
      s.typeA = static_cast<int>(A.type);
      s.typeB = static_cast<int>(B.type);
    }
  }
 
  auto assocMap = std::make_unique<xAOD::MissingETAssociationMap>();
  auto assocAux = std::make_unique<xAOD::AuxContainerBase>();
  assocMap->setStore(assocAux.get());
 
  for (const auto& [key, sh] : shared)
  {
    auto* assoc = new xAOD::MissingETAssociation();
    assocMap->push_back(assoc);
 
    ElementLink<xAOD::IParticleContainer> linkA(*key.c1, key.i1);
    ElementLink<xAOD::IParticleContainer> linkB(*key.c2, key.i2);
 
    if (!linkA.isValid() || !linkB.isValid())
    {
      assocMap->pop_back();
      delete assoc;
      continue;
    }
 
    ACC_partA(*assoc) = linkA;
    ACC_partB(*assoc) = linkB;
    ACC_typeA(*assoc) = sh.typeA;
    ACC_typeB(*assoc) = sh.typeB;
 
    ACC_sharedEc(*assoc) = sh.Ec;
    ACC_sharedEn(*assoc) = sh.En;
 
    ACC_fracAc(*assoc) = (sh.AcTot > 0.f ? sh.Ec / sh.AcTot : 0.f);
    ACC_fracAn(*assoc) = (sh.AnTot > 0.f ? sh.En / sh.AnTot : 0.f);
    ACC_fracBc(*assoc) = (sh.BcTot > 0.f ? sh.Ec / sh.BcTot : 0.f);
    ACC_fracBn(*assoc) = (sh.BnTot > 0.f ? sh.En / sh.BnTot : 0.f);
  }
 
#ifndef XAOD_STANDALONE
  SG::WriteHandle<xAOD::MissingETAssociationMap> mapH(m_outputMapKey, ctx);
  ATH_CHECK(mapH.record(std::move(assocMap), std::move(assocAux)));
#else
  ATH_CHECK(evtStore()->record(assocMap.release(), m_outputMapKey.key()));
  ATH_CHECK(evtStore()->record(assocAux.release(), m_outputMapKey.key() + "Aux."));
#endif
 
  return StatusCode::SUCCESS;
}

collectFEsFromIndex()

void ORUtils::FEAssociationTool::collectFEsFromIndex ( const EventContext & ctx, const ObjView::Type type, const xAOD::IParticleContainer * cont, std::size_t idx, ObjView & view ) const

private

Definition at line 279 of file FEAssociationTool.cxx.

{
  view.cSet.clear();
  view.nSet.clear();
  view.EcTot = 0.f;
  view.EnTot = 0.f;
 
  static std::atomic<unsigned> s_warn{0};
 
  if (!cont)
  {
    warnLimited(s_warn, [&]{ ANA_MSG_WARNING("collectFEsFromIndex called with null container"); });
    return;
  }
  if (idx >= cont->size())
  {
    warnLimited(s_warn, [&]{
      ANA_MSG_WARNING("collectFEsFromIndex index out of range: idx=" << idx
                        << " size=" << cont->size());
    });
    return;
  }
 
  const xAOD::IParticle* p = (*cont)[idx];
  if (!p)
  {
    warnLimited(s_warn, [&]{ ANA_MSG_WARNING("Null IParticle at idx=" << idx); });
    return;
  }
 
  auto loop_links =
    [&](const std::vector<ElementLink<xAOD::FlowElementContainer>>& links, bool charged)
  {
    for (const auto& el : links)
    {
      if (!el.isValid()) continue;
 
      const xAOD::FlowElement* fe = *el;
      if (!fe) continue;
 
      if (charged) {
        view.cSet.insert(fe);
        view.EcTot += fe->e() * INV_GEV;
      } else {
        view.nSet.insert(fe);
        view.EnTot += fe->e() * INV_GEV;
      }
    }
  };
 
  bool usedGlobal = false;
 
#ifndef XAOD_STANDALONE
  switch (type)
  {
  case ObjView::Type::Electron:
  {
    SG::ReadDecorHandle<xAOD::ElectronContainer, FELinks_t> chargedFEs(m_elChargedFELinksKey, ctx);
    SG::ReadDecorHandle<xAOD::ElectronContainer, FELinks_t> neutralFEs(m_elNeutralFELinksKey, ctx);
    if (chargedFEs.isAvailable()) { usedGlobal = true; loop_links(chargedFEs(*p), true); }
    if (neutralFEs.isAvailable()) { usedGlobal = true; loop_links(neutralFEs(*p), false); }
    break;
  }
  case ObjView::Type::Muon:
  {
    SG::ReadDecorHandle<xAOD::MuonContainer, FELinks_t> chargedFEs(m_muChargedFELinksKey, ctx);
    SG::ReadDecorHandle<xAOD::MuonContainer, FELinks_t> neutralFEs(m_muNeutralFELinksKey, ctx);
    if (chargedFEs.isAvailable()) { usedGlobal = true; loop_links(chargedFEs(*p), true); }
    if (neutralFEs.isAvailable()) { usedGlobal = true; loop_links(neutralFEs(*p), false); }
    break;
  }
  case ObjView::Type::Photon:
  {
    SG::ReadDecorHandle<xAOD::PhotonContainer, FELinks_t> chargedFEs(m_phChargedFELinksKey, ctx);
    SG::ReadDecorHandle<xAOD::PhotonContainer, FELinks_t> neutralFEs(m_phNeutralFELinksKey, ctx);
    if (chargedFEs.isAvailable()) { usedGlobal = true; loop_links(chargedFEs(*p), true); }
    if (neutralFEs.isAvailable()) { usedGlobal = true; loop_links(neutralFEs(*p), false); }
    break;
  }
  case ObjView::Type::Tau:
  {
    SG::ReadDecorHandle<xAOD::TauJetContainer, FELinks_t> chargedFEs(m_tauChargedFELinksKey, ctx);
    SG::ReadDecorHandle<xAOD::TauJetContainer, FELinks_t> neutralFEs(m_tauNeutralFELinksKey, ctx);
    if (chargedFEs.isAvailable()) { usedGlobal = true; loop_links(chargedFEs(*p), true); }
    if (neutralFEs.isAvailable()) { usedGlobal = true; loop_links(neutralFEs(*p), false); }
    break;
  }
  case ObjView::Type::SmallRJet:
  {
    // we can only create the handle if the key is non-empty
    if (!m_srjChargedFELinksKey.empty()) {
      SG::ReadDecorHandle<xAOD::JetContainer, FELinks_t> chargedFEs(m_srjChargedFELinksKey, ctx);
      if (chargedFEs.isAvailable()) { usedGlobal = true; loop_links(chargedFEs(*p), true); }
    }
    if (!m_srjNeutralFELinksKey.empty()) {
      SG::ReadDecorHandle<xAOD::JetContainer, FELinks_t> neutralFEs(m_srjNeutralFELinksKey, ctx);
      if (neutralFEs.isAvailable()) { usedGlobal = true; loop_links(neutralFEs(*p), false); }
    }
    break;
  }
  case ObjView::Type::LargeRJet:
  {
    // we can only create the handle if the key is non-empty
    if (!m_lrjChargedFELinksKey.empty()) {
      SG::ReadDecorHandle<xAOD::JetContainer, FELinks_t> chargedFEs(m_lrjChargedFELinksKey, ctx);
      if (chargedFEs.isAvailable()) { usedGlobal = true; loop_links(chargedFEs(*p), true); }
    }
    if (!m_lrjNeutralFELinksKey.empty()) {
      SG::ReadDecorHandle<xAOD::JetContainer, FELinks_t> neutralFEs(m_lrjNeutralFELinksKey, ctx);
      if (neutralFEs.isAvailable()) { usedGlobal = true; loop_links(neutralFEs(*p), false); }
    }
    break;
  }
  }
#else
  if (ACC_cFEs.isAvailable(*p)) {
    usedGlobal = true;
    loop_links(ACC_cFEs(*p), true);
  }
  if (ACC_nFEs.isAvailable(*p)) {
    usedGlobal = true;
    loop_links(ACC_nFEs(*p), false);
  }
#endif
 
  if (!usedGlobal && p->type() == xAOD::Type::Jet)
  {
    const auto* jet = static_cast<const xAOD::Jet*>(p);
 
    for (const auto& cl : jet->constituentLinks())
    {
      if (!cl.isValid()) continue;
 
      const xAOD::IParticle* cpart = *cl;
      if (!cpart) continue;
      if (cpart->type() != xAOD::Type::FlowElement) continue;
 
      const auto* constit = static_cast<const xAOD::FlowElement*>(cpart);
 
#ifndef XAOD_STANDALONE
      SG::ReadDecorHandle<xAOD::FlowElementContainer, OrigObjLink_t> origObj(m_originalObjectLinkKey, ctx);
 
      if (origObj.isAvailable())
      {
        const auto& feLink = origObj(*constit);
#else
      if (ACC_origObj.isAvailable(*constit))
      {
        const auto& feLink = ACC_origObj(*constit);
#endif
        if (!feLink.isValid()) continue;
 
        const xAOD::IParticle* opart = *feLink;
        if (!opart) continue;
        if (opart->type() != xAOD::Type::FlowElement) continue;
 
        const auto* fe = static_cast<const xAOD::FlowElement*>(opart);
 
        if (fe->isCharged()) {
          view.cSet.insert(fe);
          view.EcTot += fe->e() * INV_GEV;
        } else {
          view.nSet.insert(fe);
          view.EnTot += fe->e() * INV_GEV;
        }
      }
      else
      {
        const auto* fe = constit;
 
        if (fe->isCharged()) {
          view.cSet.insert(fe);
          view.EcTot += fe->e() * INV_GEV;
        } else {
          view.nSet.insert(fe);
          view.EnTot += fe->e() * INV_GEV;
        }
      }
    }
  }
}

collectObjects()

StatusCode ORUtils::FEAssociationTool::collectObjects ( const EventContext & ctx, std::vector< ObjView > & objects ) const

privatevirtual

Definition at line 164 of file FEAssociationTool.cxx.

{
  ANA_CHECK_SET_TYPE(StatusCode);
 
  auto collect_one = [&](ObjView::Type type, const xAOD::IParticleContainer* base)
  {
    if (!base) return;
    for (std::size_t idx = 0; idx < base->size(); ++idx)
    {
      ObjView view(type, base, idx);
#ifndef XAOD_STANDALONE
      collectFEsFromIndex(ctx, type, base, idx, view);
#else
      collectFEsFromIndex(type, base, idx, view);
#endif
      objects.emplace_back(std::move(view));
    }
  };
 
#ifndef XAOD_STANDALONE
  {
    SG::ReadHandle<xAOD::ElectronContainer> h(m_elKey, ctx);
    if (h.isValid()) {
      collect_one(ObjView::Type::Electron,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
  {
    SG::ReadHandle<xAOD::MuonContainer> h(m_muKey, ctx);
    if (h.isValid()) {
      collect_one(ObjView::Type::Muon,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
  {
    SG::ReadHandle<xAOD::PhotonContainer> h(m_phKey, ctx);
    if (h.isValid()) {
      collect_one(ObjView::Type::Photon,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
  {
    SG::ReadHandle<xAOD::TauJetContainer> h(m_tauKey, ctx);
    if (h.isValid()) {
      collect_one(ObjView::Type::Tau,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
  {
    SG::ReadHandle<xAOD::JetContainer> h(m_srjKey, ctx);
    if (h.isValid()) {
      collect_one(ObjView::Type::SmallRJet,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
  {
    SG::ReadHandle<xAOD::JetContainer> h(m_lrjKey, ctx);
    if (h.isValid()) {
      collect_one(ObjView::Type::LargeRJet,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
#else
  {
    SG::ReadHandle<xAOD::ElectronContainer> h(m_elKey);
    if (h.isValid()) {
      collect_one(ObjView::Type::Electron,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
  {
    SG::ReadHandle<xAOD::MuonContainer> h(m_muKey);
    if (h.isValid()) {
      collect_one(ObjView::Type::Muon,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
  {
    SG::ReadHandle<xAOD::PhotonContainer> h(m_phKey);
    if (h.isValid()) {
      collect_one(ObjView::Type::Photon,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
  {
    SG::ReadHandle<xAOD::TauJetContainer> h(m_tauKey);
    if (h.isValid()) {
      collect_one(ObjView::Type::Tau,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
  {
    SG::ReadHandle<xAOD::JetContainer> h(m_srjKey);
    if (h.isValid()) {
      collect_one(ObjView::Type::SmallRJet,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
  {
    SG::ReadHandle<xAOD::JetContainer> h(m_lrjKey);
    if (h.isValid()) {
      collect_one(ObjView::Type::LargeRJet,
                  static_cast<const xAOD::IParticleContainer*>(h.cptr()));
    }
  }
#endif
 
  return StatusCode::SUCCESS;
}

declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

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

getKey()

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

inherited

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

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

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

See also

asg::AsgTool::getName

Parameters

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

Returns

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

Definition at line 119 of file AsgTool.cxx.

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

getName()

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

inherited

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

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

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

See also

asg::AsgTool::getKey

Parameters

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

Returns

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

Definition at line 106 of file AsgTool.cxx.

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

getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

initialize()

StatusCode ORUtils::FEAssociationTool::initialize ( void )

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 94 of file FEAssociationTool.cxx.

{
  ANA_CHECK_SET_TYPE(StatusCode);
 
#ifndef XAOD_STANDALONE
  ATH_CHECK(m_elKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_muKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_phKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_tauKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_srjKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_lrjKey.initialize(SG::AllowEmpty));
 
  ATH_CHECK(m_elChargedFELinksKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_elNeutralFELinksKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_muChargedFELinksKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_muNeutralFELinksKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_phChargedFELinksKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_phNeutralFELinksKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_tauChargedFELinksKey.initialize(SG::AllowEmpty));
  ATH_CHECK(m_tauNeutralFELinksKey.initialize(SG::AllowEmpty));
  // You'd think we could use SG::AllowEmpty here, but
  // `ReadDecorHandleKey` has a custom `initialize(bool)` override that
  // hides the `initialize(AllowEmptyEnum)` method.
  ATH_CHECK(m_srjChargedFELinksKey.initialize(!m_srjChargedFELinksKey.empty()));
  ATH_CHECK(m_srjNeutralFELinksKey.initialize(!m_srjNeutralFELinksKey.empty()));
  ATH_CHECK(m_lrjChargedFELinksKey.initialize(!m_lrjChargedFELinksKey.empty()));
  ATH_CHECK(m_lrjNeutralFELinksKey.initialize(!m_lrjNeutralFELinksKey.empty()));
  ATH_CHECK(m_originalObjectLinkKey.initialize(SG::AllowEmpty));
#else
  ATH_CHECK(m_elKey.initialize());
  ATH_CHECK(m_muKey.initialize());
  ATH_CHECK(m_phKey.initialize());
  ATH_CHECK(m_tauKey.initialize());
  ATH_CHECK(m_srjKey.initialize());
  ATH_CHECK(m_lrjKey.initialize());
#endif
 
  ATH_CHECK(m_outputMapKey.initialize());
 
  ANA_MSG_INFO("Initializing FEAssociationTool; OutputMap=" << m_outputMapKey.key());
  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, 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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

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

overridevirtualinherited

Handle START transition.

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

updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

m_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_elChargedFELinksKey

SG::ReadDecorHandleKey<xAOD::ElectronContainer> ORUtils::FEAssociationTool::m_elChargedFELinksKey

private

Initial value:

{
    this, "ElectronChargedFELinksDecorKey",
    "Electrons.chargedGlobalFELinks",
    "Electron charged global FE links decoration"
  }

Definition at line 160 of file FEAssociationTool.h.

                                                                   {
    this, "ElectronChargedFELinksDecorKey",
    "Electrons.chargedGlobalFELinks",
    "Electron charged global FE links decoration"
  };

m_elKey

SG::ReadHandleKey<xAOD::ElectronContainer> ORUtils::FEAssociationTool::m_elKey

private

Initial value:

{
    this, "ElectronContainer", "Electrons", "Input electron container"
  }

Definition at line 140 of file FEAssociationTool.h.

                                                {
    this, "ElectronContainer", "Electrons", "Input electron container"
  };

m_elNeutralFELinksKey

SG::ReadDecorHandleKey<xAOD::ElectronContainer> ORUtils::FEAssociationTool::m_elNeutralFELinksKey

private

Initial value:

{
    this, "ElectronNeutralFELinksDecorKey",
    "Electrons.neutralGlobalFELinks",
    "Electron neutral global FE links decoration"
  }

Definition at line 165 of file FEAssociationTool.h.

                                                                   {
    this, "ElectronNeutralFELinksDecorKey",
    "Electrons.neutralGlobalFELinks",
    "Electron neutral global FE links decoration"
  };

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_lrjChargedFELinksKey

SG::ReadDecorHandleKey<xAOD::JetContainer> ORUtils::FEAssociationTool::m_lrjChargedFELinksKey

private

Initial value:

{
    this, "LargeRJetChargedFELinksDecorKey",
    "AntiKt10UFOCSSKSoftDropBeta100Zcut10Jets.chargedGlobalFELinks",
    "Large-R jet charged global FE links decoration"
  }

Definition at line 215 of file FEAssociationTool.h.

                                                               {
    this, "LargeRJetChargedFELinksDecorKey",
    "AntiKt10UFOCSSKSoftDropBeta100Zcut10Jets.chargedGlobalFELinks",
    "Large-R jet charged global FE links decoration"
  };

m_lrjKey

SG::ReadHandleKey<xAOD::JetContainer> ORUtils::FEAssociationTool::m_lrjKey

private

Initial value:

{
    this, "LargeRJetContainer", "AntiKt10UFOCSSKSoftDropBeta100Zcut10Jets", "Input large-R jet container"
  }

Definition at line 155 of file FEAssociationTool.h.

                                            {
    this, "LargeRJetContainer", "AntiKt10UFOCSSKSoftDropBeta100Zcut10Jets", "Input large-R jet container"
  };

m_lrjNeutralFELinksKey

SG::ReadDecorHandleKey<xAOD::JetContainer> ORUtils::FEAssociationTool::m_lrjNeutralFELinksKey

private

Initial value:

{
    this, "LargeRJetNeutralFELinksDecorKey",
    "AntiKt10UFOCSSKSoftDropBeta100Zcut10Jets.neutralGlobalFELinks",
    "Large-R jet neutral global FE links decoration"
  }

Definition at line 220 of file FEAssociationTool.h.

                                                               {
    this, "LargeRJetNeutralFELinksDecorKey",
    "AntiKt10UFOCSSKSoftDropBeta100Zcut10Jets.neutralGlobalFELinks",
    "Large-R jet neutral global FE links decoration"
  };

m_muChargedFELinksKey

SG::ReadDecorHandleKey<xAOD::MuonContainer> ORUtils::FEAssociationTool::m_muChargedFELinksKey

private

Initial value:

{
    this, "MuonChargedFELinksDecorKey",
    "Muons.chargedGlobalFELinks",
    "Muon charged global FE links decoration"
  }

Definition at line 171 of file FEAssociationTool.h.

                                                               {
    this, "MuonChargedFELinksDecorKey",
    "Muons.chargedGlobalFELinks",
    "Muon charged global FE links decoration"
  };

m_muKey

SG::ReadHandleKey<xAOD::MuonContainer> ORUtils::FEAssociationTool::m_muKey

private

Initial value:

{
    this, "MuonContainer", "Muons", "Input muon container"
  }

Definition at line 143 of file FEAssociationTool.h.

                                            {
    this, "MuonContainer", "Muons", "Input muon container"
  };

m_muNeutralFELinksKey

SG::ReadDecorHandleKey<xAOD::MuonContainer> ORUtils::FEAssociationTool::m_muNeutralFELinksKey

private

Initial value:

{
    this, "MuonNeutralFELinksDecorKey",
    "Muons.neutralGlobalFELinks",
    "Muon neutral global FE links decoration"
  }

Definition at line 176 of file FEAssociationTool.h.

                                                               {
    this, "MuonNeutralFELinksDecorKey",
    "Muons.neutralGlobalFELinks",
    "Muon neutral global FE links decoration"
  };

m_originalObjectLinkKey

SG::ReadDecorHandleKey<xAOD::FlowElementContainer> ORUtils::FEAssociationTool::m_originalObjectLinkKey

private

Initial value:

{
    this, "OriginalObjectLinkDecorKey",
    "JetETMissChargedParticleFlowObjects.originalObjectLink",
    "FlowElement originalObjectLink decoration"
  }

Definition at line 226 of file FEAssociationTool.h.

                                                                        {
    this, "OriginalObjectLinkDecorKey",
    "JetETMissChargedParticleFlowObjects.originalObjectLink",
    "FlowElement originalObjectLink decoration"
  };

m_outputMapKey

SG::WriteHandleKey<xAOD::MissingETAssociationMap> ORUtils::FEAssociationTool::m_outputMapKey

private

Initial value:

{
    this, "OutputMap", "FEAssociationMap", "Output MissingETAssociationMap"
  }

Definition at line 233 of file FEAssociationTool.h.

                                                              {
    this, "OutputMap", "FEAssociationMap", "Output MissingETAssociationMap"
  };

m_phChargedFELinksKey

SG::ReadDecorHandleKey<xAOD::PhotonContainer> ORUtils::FEAssociationTool::m_phChargedFELinksKey

private

Initial value:

{
    this, "PhotonChargedFELinksDecorKey",
    "Photons.chargedGlobalFELinks",
    "Photon charged global FE links decoration"
  }

Definition at line 182 of file FEAssociationTool.h.

                                                                 {
    this, "PhotonChargedFELinksDecorKey",
    "Photons.chargedGlobalFELinks",
    "Photon charged global FE links decoration"
  };

m_phKey

SG::ReadHandleKey<xAOD::PhotonContainer> ORUtils::FEAssociationTool::m_phKey

private

Initial value:

{
    this, "PhotonContainer", "Photons", "Input photon container"
  }

Definition at line 146 of file FEAssociationTool.h.

                                              {
    this, "PhotonContainer", "Photons", "Input photon container"
  };

m_phNeutralFELinksKey

SG::ReadDecorHandleKey<xAOD::PhotonContainer> ORUtils::FEAssociationTool::m_phNeutralFELinksKey

private

Initial value:

{
    this, "PhotonNeutralFELinksDecorKey",
    "Photons.neutralGlobalFELinks",
    "Photon neutral global FE links decoration"
  }

Definition at line 187 of file FEAssociationTool.h.

                                                                 {
    this, "PhotonNeutralFELinksDecorKey",
    "Photons.neutralGlobalFELinks",
    "Photon neutral global FE links decoration"
  };

m_srjChargedFELinksKey

SG::ReadDecorHandleKey<xAOD::JetContainer> ORUtils::FEAssociationTool::m_srjChargedFELinksKey

private

Initial value:

{
    this, "SmallRJetChargedFELinksDecorKey",
    "AntiKt4EMPFlowJets.chargedGlobalFELinks",
    "Small-R jet charged global FE links decoration"
  }

Definition at line 204 of file FEAssociationTool.h.

                                                               {
    this, "SmallRJetChargedFELinksDecorKey",
    "AntiKt4EMPFlowJets.chargedGlobalFELinks",
    "Small-R jet charged global FE links decoration"
  };

m_srjKey

SG::ReadHandleKey<xAOD::JetContainer> ORUtils::FEAssociationTool::m_srjKey

private

Initial value:

{
    this, "SmallRJetContainer", "AntiKt4EMPFlowJets", "Input small-R jet container"
  }

Definition at line 152 of file FEAssociationTool.h.

                                            {
    this, "SmallRJetContainer", "AntiKt4EMPFlowJets", "Input small-R jet container"
  };

m_srjNeutralFELinksKey

SG::ReadDecorHandleKey<xAOD::JetContainer> ORUtils::FEAssociationTool::m_srjNeutralFELinksKey

private

Initial value:

{
    this, "SmallRJetNeutralFELinksDecorKey",
    "AntiKt4EMPFlowJets.neutralGlobalFELinks",
    "Small-R jet neutral global FE links decoration"
  }

Definition at line 209 of file FEAssociationTool.h.

                                                               {
    this, "SmallRJetNeutralFELinksDecorKey",
    "AntiKt4EMPFlowJets.neutralGlobalFELinks",
    "Small-R jet neutral global FE links decoration"
  };

m_tauChargedFELinksKey

SG::ReadDecorHandleKey<xAOD::TauJetContainer> ORUtils::FEAssociationTool::m_tauChargedFELinksKey

private

Initial value:

{
    this, "TauChargedFELinksDecorKey",
    "TauJets.chargedGlobalFELinks",
    "Tau charged global FE links decoration"
  }

Definition at line 193 of file FEAssociationTool.h.

                                                                  {
    this, "TauChargedFELinksDecorKey",
    "TauJets.chargedGlobalFELinks",
    "Tau charged global FE links decoration"
  };

m_tauKey

SG::ReadHandleKey<xAOD::TauJetContainer> ORUtils::FEAssociationTool::m_tauKey

private

Initial value:

{
    this, "TauContainer", "TauJets", "Input tau container"
  }

Definition at line 149 of file FEAssociationTool.h.

                                               {
    this, "TauContainer", "TauJets", "Input tau container"
  };

m_tauNeutralFELinksKey

SG::ReadDecorHandleKey<xAOD::TauJetContainer> ORUtils::FEAssociationTool::m_tauNeutralFELinksKey

private

Initial value:

{
    this, "TauNeutralFELinksDecorKey",
    "TauJets.neutralGlobalFELinks",
    "Tau neutral global FE links decoration"
  }

Definition at line 198 of file FEAssociationTool.h.

                                                                  {
    this, "TauNeutralFELinksDecorKey",
    "TauJets.neutralGlobalFELinks",
    "Tau neutral global FE links decoration"
  };

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:

• FEAssociationTool.h
• FEAssociationTool.cxx