FtagLargeRJetTruthLabelTool Class Reference

Simplified FTAG large-R jet truth labelling tool. More...

#include <FtagLargeRJetTruthLabelTool.h>

Inheritance diagram for FtagLargeRJetTruthLabelTool:

Collaboration diagram for FtagLargeRJetTruthLabelTool:

Public Member Functions
	FtagLargeRJetTruthLabelTool (const std::string &name)
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual StatusCode	decorate (const xAOD::JetContainer &jets) const override
	Decorate a jet collection without otherwise modifying it.
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
virtual StatusCode	modify (xAOD::JetContainer &jets) const override final
	Concrete implementation of the function inherited from IJetModifier.
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
FtagLargeRLabel::TypeEnum	classifyDecay (const xAOD::TruthParticle *parent, int originPdgId, int nB, int nC, int nTau, int extLabel) const
FtagLargeRLabel::TypeEnum	classifyHiggsDecay (const std::set< int > &ids, const std::vector< const xAOD::TruthParticle * > &children, int nB, int nC, int nTau, int extLabel) const
FtagLargeRLabel::TypeEnum	classifyTopDecay (const std::vector< const xAOD::TruthParticle * > &children, int nB, int nC) const
FtagLargeRLabel::TypeEnum	classifyWDecay (const std::vector< const xAOD::TruthParticle * > &children, int nC) const
FtagLargeRLabel::TypeEnum	classifyZDecay (const std::set< int > &ids, int nB, int nC, int nTau, int extLabel) const
FtagLargeRLabel::TypeEnum	classifyQCD (int nB, int nC) const
std::vector< const xAOD::TruthParticle * >	getDecayProducts (const xAOD::TruthParticle *parent) const
std::vector< const xAOD::TruthParticle * >	getDecayProducts (const xAOD::TruthParticle *parent, std::set< const xAOD::TruthParticle * > &visited) 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::JetContainer >	m_jetsKey {this, "JetContainer", "", "Input jet container"}
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_decLabel {this, "DecLabel", m_jetsKey, "FtagLargeRTruthLabel", "Decoration name for the truth label"}
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

Simplified FTAG large-R jet truth labelling tool.

Labels jets with a factorized Origin x Decay x Containment scheme using ghost associations only (no kinematic cuts). Origin is the ghost-matched parent; Decay is from its truth decay chain; Containment is checked via ghost hadron counting on the jet.

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

FtagLargeRJetTruthLabelTool()

FtagLargeRJetTruthLabelTool::FtagLargeRJetTruthLabelTool

(

const std::string &

name

)

Definition at line 17 of file FtagLargeRJetTruthLabelTool.cxx.

    : asg::AsgTool(name) {}

Member Function Documentation

classifyDecay()

FtagLargeRLabel::TypeEnum FtagLargeRJetTruthLabelTool::classifyDecay ( const xAOD::TruthParticle * parent, int originPdgId, int nB, int nC, int nTau, int extLabel ) const

private

Definition at line 86 of file FtagLargeRJetTruthLabelTool.cxx.

                                                                                                    {
 
  std::vector<const xAOD::TruthParticle*> children = getDecayProducts(parent);
  if (children.empty()) return FtagLargeRLabel::UNKNOWN;
 
  std::set<int> ids;
  for (const auto* c : children) ids.insert(std::abs(c->pdgId()));
 
  switch (originPdgId) {
    case 25: return classifyHiggsDecay(ids, children, nB, nC, nTau, extLabel);
    case 6:  return classifyTopDecay(children, nB, nC);
    case 24: return classifyWDecay(children, nC);
    case 23: return classifyZDecay(ids, nB, nC, nTau, extLabel);
    default: return FtagLargeRLabel::UNKNOWN;
  }
}

classifyHiggsDecay()

FtagLargeRLabel::TypeEnum FtagLargeRJetTruthLabelTool::classifyHiggsDecay ( const std::set< int > & ids, const std::vector< const xAOD::TruthParticle * > & children, int nB, int nC, int nTau, int extLabel ) const

private

Definition at line 104 of file FtagLargeRJetTruthLabelTool.cxx.

                                                  {
  if (ids.count(5)) {
    if (nB >= 2) return FtagLargeRLabel::Hbb;
    if (nB == 1) return FtagLargeRLabel::Hb;
    return FtagLargeRLabel::Hother;
  }
  if (ids.count(4)) {
    if (nC >= 2) return FtagLargeRLabel::Hcc;
    if (nC == 1) return FtagLargeRLabel::Hc;
    return FtagLargeRLabel::Hother;
  }
  if (ids.count(15)) {
    if (nTau == 0) return FtagLargeRLabel::Hother;
    if (nTau == 1) return FtagLargeRLabel::Htau;
    switch (extLabel) {
      case 1515:   return FtagLargeRLabel::Htautau;
      case 151511: return FtagLargeRLabel::HtautauEl;
      case 151513: return FtagLargeRLabel::HtautauMu;
      default:     return FtagLargeRLabel::Hother;
    }
  }
  // H -> VV: navigate each boson's decay to count hadronic vs leptonic legs.
  // Bosons with no decay vertex are skipped, which demotes the event to Hother.
  if (ids.count(24)) {
    int nHadW = 0, nLepW = 0;
    for (const auto* child : children) {
      if (std::abs(child->pdgId()) != 24 || !child->hasDecayVtx()) continue;
      bool lep = false;
      for (const auto* wc : getDecayProducts(child)) {
        int id = std::abs(wc->pdgId());
        if (id == 11 || id == 13 || id == 15) { lep = true; break; }
      }
      if (lep) ++nLepW; else ++nHadW;
    }
    if (nHadW == 2)              return FtagLargeRLabel::HWWhad;
    if (nHadW == 1 && nLepW == 1) return FtagLargeRLabel::HWWlep;
    return FtagLargeRLabel::Hother;
  }
  if (ids.count(23)) {
    int nHadZ = 0;
    for (const auto* child : children) {
      if (std::abs(child->pdgId()) != 23 || !child->hasDecayVtx()) continue;
      for (const auto* zc : getDecayProducts(child)) {
        int id = std::abs(zc->pdgId());
        if (id >= 1 && id <= 6) { ++nHadZ; break; }
      }
    }
    if (nHadZ == 2) return FtagLargeRLabel::HZZhad;
    return FtagLargeRLabel::Hother;
  }
  return FtagLargeRLabel::Hother;
}

classifyQCD()

FtagLargeRLabel::TypeEnum FtagLargeRJetTruthLabelTool::classifyQCD ( int nB, int nC ) const

private

Definition at line 231 of file FtagLargeRJetTruthLabelTool.cxx.

                          {
  if (nB >= 2)             return FtagLargeRLabel::QCDbb;
  if (nB == 1 && nC >= 1)  return FtagLargeRLabel::QCDbc;
  if (nB == 0 && nC >= 2)  return FtagLargeRLabel::QCDcc;
  if (nB == 1)             return FtagLargeRLabel::QCDbq;
  if (nC == 1)             return FtagLargeRLabel::QCDcq;
  return FtagLargeRLabel::QCDqq;
}

classifyTopDecay()

FtagLargeRLabel::TypeEnum FtagLargeRJetTruthLabelTool::classifyTopDecay ( const std::vector< const xAOD::TruthParticle * > & children, int nB, int nC ) const

private

Definition at line 159 of file FtagLargeRJetTruthLabelTool.cxx.

                                                                               {
  for (const auto* child : children) {
    if (std::abs(child->pdgId()) != 24) continue;
    if (!child->hasDecayVtx()) return FtagLargeRLabel::Wother;
 
    std::vector<const xAOD::TruthParticle*> wProducts = getDecayProducts(child);
    if (wProducts.empty()) return FtagLargeRLabel::Wother;
 
    bool hasCharm = false, hasQuark = false;
    for (const auto* wc : wProducts) {
      int id = std::abs(wc->pdgId());
      if (id >= 1 && id <= 5) hasQuark = true;
      if (id == 4)            hasCharm = true;
    }
 
    if (hasCharm) {
      if (nB >= 1 && nC >= 1) return FtagLargeRLabel::TopBcs;
      if (nB >= 1)            return FtagLargeRLabel::TopBx;
      if (nC >= 1)            return FtagLargeRLabel::Wcs;
      return FtagLargeRLabel::Wother;
    }
    if (hasQuark) {
      if (nB >= 1) return FtagLargeRLabel::TopBqq;
      return FtagLargeRLabel::Wqq;
    }
    if (nB >= 1) return FtagLargeRLabel::TopBlv;
    return FtagLargeRLabel::Wother;
  }
  return FtagLargeRLabel::Wother;
}

classifyWDecay()

FtagLargeRLabel::TypeEnum FtagLargeRJetTruthLabelTool::classifyWDecay ( const std::vector< const xAOD::TruthParticle * > & children, int nC ) const

private

Definition at line 191 of file FtagLargeRJetTruthLabelTool.cxx.

                                                                       {
  bool hasCharm = false, hasQuark = false;
  for (const auto* child : children) {
    int id = std::abs(child->pdgId());
    if (id >= 1 && id <= 5) hasQuark = true;
    if (id == 4)            hasCharm = true;
  }
  if (hasCharm && nC >= 1) return FtagLargeRLabel::Wcs;
  if (hasQuark) return FtagLargeRLabel::Wqq;
  return FtagLargeRLabel::Wother;
}

classifyZDecay()

FtagLargeRLabel::TypeEnum FtagLargeRJetTruthLabelTool::classifyZDecay ( const std::set< int > & ids, int nB, int nC, int nTau, int extLabel ) const

private

Definition at line 204 of file FtagLargeRJetTruthLabelTool.cxx.

                                                                          {
  if (ids.count(5)) {
    if (nB >= 2) return FtagLargeRLabel::Zbb;
    if (nB == 1) return FtagLargeRLabel::Zb;
    return FtagLargeRLabel::Zother;
  }
  if (ids.count(4)) {
    if (nC >= 2) return FtagLargeRLabel::Zcc;
    if (nC == 1) return FtagLargeRLabel::Zc;
    return FtagLargeRLabel::Zother;
  }
  if (ids.count(3))  return FtagLargeRLabel::Zss;
  if (ids.count(15)) {
    if (nTau == 0) return FtagLargeRLabel::Zother;
    if (nTau == 1) return FtagLargeRLabel::Ztau;
    switch (extLabel) {
      case 1515:   return FtagLargeRLabel::Ztautau;
      case 151511: return FtagLargeRLabel::ZtautauEl;
      case 151513: return FtagLargeRLabel::ZtautauMu;
      default:     return FtagLargeRLabel::Zother;
    }
  }
  if (ids.count(1) || ids.count(2)) return FtagLargeRLabel::Zqq;
  return FtagLargeRLabel::Zother;
}

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

decorate()

StatusCode FtagLargeRJetTruthLabelTool::decorate ( const xAOD::JetContainer & jets ) const

overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 33 of file FtagLargeRJetTruthLabelTool.cxx.

                                                                                   {
 
  // IJetDecorator::decorate() has no EventContext parameter; retrieve from Gaudi TLS.
  const EventContext& ctx = Gaudi::Hive::currentContext();
  SG::WriteDecorHandle<xAOD::JetContainer, int> dec_label(m_decLabel, ctx);
 
  auto ptComp = [](const xAOD::TruthParticle* a, const xAOD::TruthParticle* b) {
    return a->pt() < b->pt();
  };
 
  for (const xAOD::Jet* jet : jets) {
    std::vector<const xAOD::TruthParticle*> ghostH   = jet->getAssociatedObjects<xAOD::TruthParticle>("GhostHBosons");
    std::vector<const xAOD::TruthParticle*> ghostTop = jet->getAssociatedObjects<xAOD::TruthParticle>("GhostTQuarksFinal");
    std::vector<const xAOD::TruthParticle*> ghostZ   = jet->getAssociatedObjects<xAOD::TruthParticle>("GhostZBosons");
    std::vector<const xAOD::TruthParticle*> ghostW   = jet->getAssociatedObjects<xAOD::TruthParticle>("GhostWBosons");
    std::vector<const xAOD::TruthParticle*> ghostB   = jet->getAssociatedObjects<xAOD::TruthParticle>("GhostBHadronsFinal");
    std::vector<const xAOD::TruthParticle*> ghostC   = jet->getAssociatedObjects<xAOD::TruthParticle>("GhostCHadronsFinal");
    std::vector<const xAOD::TruthParticle*> ghostTau = jet->getAssociatedObjects<xAOD::TruthParticle>("GhostTausFinal");
 
    // Origin priority: H > top > Z > W > QCD
    int originPdgId = 0;
    const xAOD::TruthParticle* parent = nullptr;
    if      (!ghostH.empty())   { originPdgId = 25; parent = *std::max_element(ghostH.begin(), ghostH.end(), ptComp);     }
    else if (!ghostTop.empty()) { originPdgId = 6;  parent = *std::max_element(ghostTop.begin(), ghostTop.end(), ptComp); }
    else if (!ghostZ.empty())   { originPdgId = 23; parent = *std::max_element(ghostZ.begin(), ghostZ.end(), ptComp);     }
    else if (!ghostW.empty())   { originPdgId = 24; parent = *std::max_element(ghostW.begin(), ghostW.end(), ptComp);     }
 
    // C-hadron count after removing B->C cascade descendants
    std::vector<const xAOD::TruthParticle*> deduplicatedC = std::move(ghostC);
    ParticleJetTools::childrenRemoved(ghostB, deduplicatedC);
    int nB   = static_cast<int>(ghostB.size());
    int nC   = static_cast<int>(deduplicatedC.size());
    int nTau = static_cast<int>(ghostTau.size());
 
    // Extended truth label encodes tau-pair decay mode:
    // 1515 = had-had, 151511 = had + tau->e, 151513 = had + tau->mu
    static const SG::AuxElement::ConstAccessor<int> accExtLabel("HadronGhostExtendedTruthLabelID");
    int extLabel = accExtLabel.isAvailable(*jet) ? accExtLabel(*jet) : 0;
 
    FtagLargeRLabel::TypeEnum label = FtagLargeRLabel::UNKNOWN;
    if (originPdgId != 0 && parent && parent->hasDecayVtx())
      label = classifyDecay(parent, originPdgId, nB, nC, nTau, extLabel);
    else
      label = classifyQCD(nB, nC);
 
    dec_label(*jet) = static_cast<int>(label);
  }
 
  return StatusCode::SUCCESS;
}

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

getDecayProducts() [1/2]

std::vector< const xAOD::TruthParticle * > FtagLargeRJetTruthLabelTool::getDecayProducts ( const xAOD::TruthParticle * parent ) const

private

Definition at line 245 of file FtagLargeRJetTruthLabelTool.cxx.

                                           {
  std::set<const xAOD::TruthParticle*> visited;
  return getDecayProducts(parent, visited);
}

getDecayProducts() [2/2]

std::vector< const xAOD::TruthParticle * > FtagLargeRJetTruthLabelTool::getDecayProducts ( const xAOD::TruthParticle * parent, std::set< const xAOD::TruthParticle * > & visited ) const

private

Definition at line 252 of file FtagLargeRJetTruthLabelTool.cxx.

                                                     {
  std::vector<const xAOD::TruthParticle*> products;
  if (!parent || !parent->hasDecayVtx()) return products;
  if (!visited.insert(parent).second) return products;  // cycle detected
  const xAOD::TruthVertex* vtx = parent->decayVtx();
  if (!vtx) return products;
 
  for (size_t i = 0; i < vtx->nOutgoingParticles(); ++i) {
    const xAOD::TruthParticle* child = vtx->outgoingParticle(i);
    if (!child || child == parent) continue;
    int childAbsId = std::abs(child->pdgId());
 
    // Follow through self-copies (same pdgId -> generator intermediate)
    if (child->pdgId() == parent->pdgId() && child->hasDecayVtx()) {
      std::vector<const xAOD::TruthParticle*> gc = getDecayProducts(child, visited);
      products.insert(products.end(), gc.begin(), gc.end());
      continue;
    }
    // Skip FSR photons and gluons
    if (childAbsId == 22 || childAbsId == 21) continue;
 
    products.push_back(child);
  }
  return products;
}

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 FtagLargeRJetTruthLabelTool::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 20 of file FtagLargeRJetTruthLabelTool.cxx.

                                                   {
  if (m_jetsKey.key().empty()) {
    ATH_MSG_ERROR("JetContainer property must be set");
    return StatusCode::FAILURE;
  }
  ATH_CHECK(m_jetsKey.initialize());
  ATH_CHECK(m_decLabel.initialize());
  ATH_MSG_INFO("Initializing FtagLargeRJetTruthLabelTool: container=" << m_jetsKey.key()
               << "  decoration=" << m_decLabel.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.

modify()

virtual StatusCode IJetDecorator::modify ( xAOD::JetContainer & jets ) const

inlinefinaloverridevirtualinherited

Concrete implementation of the function inherited from IJetModifier.

Implements IJetModifier.

Definition at line 32 of file IJetDecorator.h.

{return decorate(jets);};

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_decLabel

SG::WriteDecorHandleKey<xAOD::JetContainer> FtagLargeRJetTruthLabelTool::m_decLabel {this, "DecLabel", m_jetsKey, "FtagLargeRTruthLabel", "Decoration name for the truth label"}

private

Definition at line 53 of file FtagLargeRJetTruthLabelTool.h.

{this, "DecLabel", m_jetsKey, "FtagLargeRTruthLabel", "Decoration name for the truth label"};

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_jetsKey

SG::ReadHandleKey<xAOD::JetContainer> FtagLargeRJetTruthLabelTool::m_jetsKey {this, "JetContainer", "", "Input jet container"}

private

Definition at line 52 of file FtagLargeRJetTruthLabelTool.h.

{this, "JetContainer", "", "Input jet container"};

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:

• FtagLargeRJetTruthLabelTool.h
• FtagLargeRJetTruthLabelTool.cxx