TruthParentDecoratorAlg Class Reference

#include <TruthParentDecoratorAlg.h>

Inheritance diagram for TruthParentDecoratorAlg:

Collaboration diagram for TruthParentDecoratorAlg:

Public Types
using	Barcodex = std::map<int, std::set<int>>
using	IPMap = std::map<int, std::set<const xAOD::TruthParticle*>>
using	JC = xAOD::IParticleContainer
using	J = xAOD::IParticle
using	TPC = xAOD::TruthParticleContainer
using	JL = ElementLink<JC>

Public Member Functions
	TruthParentDecoratorAlg (const std::string &name, ISvcLocator *loc)
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &) const override
virtual StatusCode	finalize () override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
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	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

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
using	cascade_counter_property_t = std::map<std::string,std::vector<int>>
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	addTruthContainer (Barcodex &, IPMap &, const TPC &) 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< JC >	m_target_container_key
Gaudi::Property< std::string >	m_prefix
Gaudi::Property< std::vector< int > >	m_parent_pdgids
Gaudi::Property< std::vector< int > >	m_cascade_pdgids
Gaudi::Property< bool >	m_add_b
Gaudi::Property< bool >	m_add_c
Gaudi::Property< bool >	m_veto_soft_lepton
Gaudi::Property< bool >	m_veto_soft_charm
Gaudi::Property< float >	m_match_delta_r
SG::ReadHandleKey< TPC >	m_parents_key
SG::ReadHandleKeyArray< TPC >	m_cascades_key
SG::WriteDecorHandleKey< JC >	m_target_pdgid_key
SG::WriteDecorHandleKey< JC >	m_target_dr_truth_key
SG::WriteDecorHandleKey< JC >	m_target_link_key
SG::WriteDecorHandleKey< JC >	m_target_index_key
SG::WriteDecorHandleKey< JC >	m_target_n_matched_key
SG::WriteDecorHandleKey< JC >	m_target_match_mask_key
SG::WriteDecorHandleKey< JC >	m_match_pdgid_key
SG::WriteDecorHandleKey< JC >	m_match_children_key
SG::WriteDecorHandleKey< JC >	m_match_link_key
SG::WriteDecorHandleKey< JC >	m_target_mass_key
SG::WriteDecorHandleKey< JC >	m_target_pt_key
SG::WriteDecorHandleKey< JC >	m_target_energy_key
SG::WriteDecorHandleKey< JC >	m_target_eta_key
SG::WriteDecorHandleKey< JC >	m_target_phi_key
Gaudi::Property< cascade_counter_property_t >	m_counts_matching_cascade
SG::WriteDecorHandleKeyArray< JC >	m_cascade_count_writer_keys
std::vector< CascadeCountDecorator >	m_cascade_count_decorators
Gaudi::Property< std::unordered_set< int > >	m_allow_missing_children_pdgids
Gaudi::Property< float >	m_missing_children_fraction_warning_threshold
Gaudi::Property< std::unordered_set< int > >	m_warn_missing_children_pdgids
std::atomic< unsigned long long >	m_missing_n_ignored
std::atomic< unsigned long long >	m_missing_n_warned
std::atomic< unsigned long long >	m_total_children
Gaudi::Property< bool >	m_use_barcode
SG::ConstAccessor< int >	m_uid {"uid"}
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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 35 of file TruthParentDecoratorAlg.h.

Member Typedef Documentation

Barcodex

using TruthParentDecoratorAlg::Barcodex = std::map<int, std::set<int>>

Definition at line 38 of file TruthParentDecoratorAlg.h.

cascade_counter_property_t

using TruthParentDecoratorAlg::cascade_counter_property_t = std::map<std::string,std::vector<int>>

private

Definition at line 49 of file TruthParentDecoratorAlg.h.

IPMap

using TruthParentDecoratorAlg::IPMap = std::map<int, std::set<const xAOD::TruthParticle*>>

Definition at line 39 of file TruthParentDecoratorAlg.h.

J

using TruthParentDecoratorAlg::J = xAOD::IParticle

Definition at line 41 of file TruthParentDecoratorAlg.h.

JC

using TruthParentDecoratorAlg::JC = xAOD::IParticleContainer

Definition at line 40 of file TruthParentDecoratorAlg.h.

JL

using TruthParentDecoratorAlg::JL = ElementLink<JC>

Definition at line 43 of file TruthParentDecoratorAlg.h.

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

TPC

using TruthParentDecoratorAlg::TPC = xAOD::TruthParticleContainer

Definition at line 42 of file TruthParentDecoratorAlg.h.

Constructor & Destructor Documentation

TruthParentDecoratorAlg()

TruthParentDecoratorAlg::TruthParentDecoratorAlg	(	const std::string &	name,
		ISvcLocator *	loc )

Definition at line 228 of file TruthParentDecoratorAlg.cxx.

                                                                                       :
  AthReentrantAlgorithm(name, loc)
{
  // these aren't user configurable
  declare(m_target_pdgid_key);
  declare(m_target_dr_truth_key);
  declare(m_target_link_key);
  declare(m_target_index_key);
  declare(m_target_n_matched_key);
  declare(m_target_match_mask_key);
  declare(m_match_pdgid_key);
  declare(m_match_children_key);
  declare(m_match_link_key);
  declare(m_target_mass_key);
  declare(m_target_pt_key);
  declare(m_target_energy_key);
  declare(m_target_eta_key);
  declare(m_target_phi_key);
}

Member Function Documentation

addTruthContainer()

void TruthParentDecoratorAlg::addTruthContainer ( Barcodex & barcodex, IPMap & ipmap, const TPC & container ) const

private

Definition at line 492 of file TruthParentDecoratorAlg.cxx.

                                                                                                                                 {
 
  std::set<int> targid(m_cascade_pdgids.begin(), m_cascade_pdgids.end());
  // we allow decays through any of the parent pdgids
  targid.insert(m_parent_pdgids.begin(), m_parent_pdgids.end());
 
  // this determines if a cascade vertex should be saved or not
  auto cascadeWants = [
    &targid,
    &b=m_add_b,
    &c=m_add_c,
    &vsl=m_veto_soft_lepton,
    &vsc=m_veto_soft_charm
    ] (const xAOD::TruthParticle* p) {
    if (int n_parents = p->nParents(); n_parents == 1) {
      if (vsl && isSoftLepton(p)) return false;
      if (vsc && isSoftCharm(p)) return false;
    }
    if (targid.contains(p->pdgId())) return true;
    if (b && p->hasBottom()) return true;
    if (c && p->hasCharm()) return true;
    return false;
  };
 
  // insert a particle into the record, return the child set
  // ATLASRECTS-8290: this should be replaced with ->uid()
  auto insert = [this, &barcodex, &ipmap](const auto* p) -> auto& {
    ipmap[m_uid(*p)].insert(p);
    return barcodex[m_uid(*p)];
  };
 
  for (const xAOD::TruthParticle* p: container) {
    if (cascadeWants(p)) {
      auto& child_set = insert(p);
      for (unsigned int child_n = 0; child_n < p->nChildren(); child_n++) {
        const xAOD::TruthParticle* c = p->child(child_n);
 
        // Unfortunately the truth record is often broken in various
        // ways. There are a few configurable ways to deal with
        // this. We keep track of the total number and how often we
        // use these workarounds to make sure things don't go too
        // crazy.
        m_total_children++;
        const auto& ok_missing = m_allow_missing_children_pdgids.value();
        if (!c) {
          if(ok_missing.contains(p->pdgId())) {
            m_missing_n_ignored++;
          } else {
            auto problem = std::format(
              "null truth child [barcode={},pdg_id={},child={}of{}]",
             // ATLASRECTS-8290: m_uid should be replaced with ->uid()
              m_uid(*p), p->pdgId(), child_n, p->nChildren());
            const auto& warn_missing = m_warn_missing_children_pdgids.value();
            if (warn_missing.contains(p->pdgId())) {
              m_missing_n_warned++;
              ATH_MSG_WARNING(problem);
            } else {
              throw std::runtime_error(problem);
            }
          }
        } else if (cascadeWants(c)) {
          insert(c);
          // ATLASRECTS-8290: m_uid should be replaced with ->uid()
          child_set.insert(m_uid(*c));
        }
      };
    }
  }
}

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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; }

execute()

StatusCode TruthParentDecoratorAlg::execute ( const EventContext & cxt ) const

overridevirtual

Definition at line 300 of file TruthParentDecoratorAlg.cxx.

{
  ATH_MSG_DEBUG("Executing");

  // part 1: read in the particles
  SG::ReadHandle<JC> targets(m_target_container_key, cxt);
 
  using uc_t = unsigned char;
  SG::WriteDecorHandle<JC,int> pdgid(m_target_pdgid_key, cxt);
  SG::WriteDecorHandle<JC,float> deltaR(m_target_dr_truth_key, cxt);
  SG::WriteDecorHandle<JC,JL> link(m_target_link_key, cxt);
  SG::WriteDecorHandle<JC,char> index(m_target_index_key, cxt);
  SG::WriteDecorHandle<JC,uc_t> nMatched(m_target_n_matched_key, cxt);
  SG::WriteDecorHandle<JC,parent_mask_t> mask(m_target_match_mask_key, cxt);
  SG::WriteDecorHandle<JC,int> matchPdgId(m_match_pdgid_key, cxt);
  SG::WriteDecorHandle<JC,int> matchChildCount(m_match_children_key, cxt);
  SG::WriteDecorHandle<JC,JL> matchLink(m_match_link_key, cxt);
  SG::WriteDecorHandle<JC,float> dec_mass(m_target_mass_key, cxt);
  SG::WriteDecorHandle<JC,float> dec_pt(m_target_pt_key, cxt);
  SG::WriteDecorHandle<JC,float> dec_energy(m_target_energy_key, cxt);
  SG::WriteDecorHandle<JC,float> dec_eta(m_target_eta_key, cxt);
  SG::WriteDecorHandle<JC,float> dec_phi(m_target_phi_key, cxt);
 
  if (targets->empty()) return StatusCode::SUCCESS;
 
  // read in and sort the parent collection
  SG::ReadHandle<TPC> phandle(m_parents_key, cxt);
  std::set<int> parentids(m_parent_pdgids.begin(), m_parent_pdgids.end());
  std::vector<const xAOD::TruthParticle*> psort;
  for (const xAOD::TruthParticle* p: *phandle) {
    if (!parentids.contains(p->pdgId())) continue;
    if (!isOriginal(p)) continue;
    psort.push_back(p);
  }
  // for lack of a better idea, store truth parents sorted by mass
  std::sort(psort.begin(), psort.end(),[](const auto* p1, const auto* p2) {return p1->m() > p2->m();});
  // check to make sure we don't overflow the match mask
  constexpr size_t max_idx = std::numeric_limits<parent_mask_t>::digits;
  if (psort.size() > max_idx) {
    ATH_MSG_WARNING(
      "Found too many parent particles to store in parent match mask "
      "truncating the parent collection [max: " << max_idx << ", "
      "n: " << psort.size() << "]");
    psort.resize(max_idx);
  }
 
 
  std::vector<SG::ReadHandle<TPC>> cascades_raw;
  for (const auto& key: m_cascades_key) {
    cascades_raw.emplace_back(key, cxt);
  }
  logInputs(msgStream(), targets, phandle, cascades_raw);

  // part 2: build the barcodex
  Barcodex barcodex;
  IPMap ipmap;
  addTruthContainer(barcodex, ipmap, *phandle);
  for (auto& cascade: cascades_raw) {
    addTruthContainer(barcodex, ipmap, *cascade);
  }
  logIPMap(msg(), ipmap);
 
  ATH_MSG_DEBUG("merged cascade contains " << barcodex.size() << " particles");

  // Part 3: build map from targets to parents
  std::unordered_map<const J*, std::vector<MatchedParent>> labeled_targets;
  unsigned int n_parents = 0;
  for (const auto* p: psort) {
    unsigned int parent_index = n_parents++;
    // ATLASRECTS-8290: this should be replaced with ->uid()
    ATH_MSG_VERBOSE("pdgid: " << p->pdgId() << ", barcode: " << m_uid(*p));
    for (auto& [cbar, histbars]: findAllDescendants(m_uid(*p), barcodex)) {
      IPMap::mapped_type& barkids = ipmap.at(cbar);
      const xAOD::TruthParticle* child = selectChild(barkids);
      std::vector<std::pair<float, const J*>> drs;
      float drsMinDR=9999;
      const J* drsMinMatch = 0;
      for (const auto* j: *targets) {
        if(j->p4().DeltaR(child->p4()) < drsMinDR) {
          drsMinDR=j->p4().DeltaR(child->p4());
          drsMinMatch=j;
        }
      }
      if(drsMinMatch){
        MatchedParent match;
        match.parent = p;
        match.child = child;
        match.deltaR = drsMinDR;
        match.parent_index = parent_index;
        match.cascade_pids.insert(child->pdgId());
        for (auto& histbar: histbars) {
          match.cascade_pids.insert(selectChild(ipmap.at(histbar))->pdgId());
        }
        if (match.deltaR < m_match_delta_r) {
          labeled_targets[drsMinMatch].push_back(std::move(match));
        }
      }
    }
  }

  // Part 4: decorate!
 
  for (const J* j: *targets) {
    if (labeled_targets.contains(j)) {
      const std::vector<MatchedParent>& matches = labeled_targets.at(j);
      auto min_dr = [](auto& p1, auto& p2) {
        return p1.deltaR < p2.deltaR;
      };
      const MatchedParent& nearest = *std::min_element(
        matches.begin(), matches.end(), min_dr);
      const xAOD::TruthParticle* p = nearest.parent;
      pdgid(*j) = p->pdgId();
      deltaR(*j) = nearest.deltaR;
      auto* container = dynamic_cast<const TPC*>(p->container());
      link(*j) = JL(*container, p->index());
      index(*j) = nearest.parent_index;
      nMatched(*j) = matches.size();
      mask(*j) = matchMask(matches);
      const xAOD::TruthParticle* child = nearest.child;
      matchPdgId(*j) = child->pdgId();
      matchChildCount(*j) = child->nChildren();
      auto* matchedContainer = dynamic_cast<const TPC*>(child->container());
      matchLink(*j) = JL(*matchedContainer, child->index());
      dec_mass(*j) = p->m();
      dec_pt(*j) = p->pt();
      dec_energy(*j) = p->e();
      dec_eta(*j) = p->eta();
      dec_phi(*j) = p->phi();
      for (const auto& cascadeCount: m_cascade_count_decorators) {
        cascadeCount.decorate(*j, matches);
      }
    } else {
      pdgid(*j) = 0;
      deltaR(*j) = NAN;
      link(*j) = JL();
      index(*j) = -1;
      nMatched(*j) = -1;
      mask(*j) = 0x0;
      matchPdgId(*j) = 0;
      matchChildCount(*j) = 0;
      matchLink(*j) = JL();
      dec_mass(*j) = NAN;
      dec_pt(*j) = NAN;
      dec_energy(*j) = NAN;
      dec_eta(*j) = NAN;
      dec_phi(*j) = NAN;
      for (const auto& cascadeCount: m_cascade_count_decorators) {
        cascadeCount.decorateDefault(*j);
      }
    }
  }

  // Part 5: lock decorations
 
  for (const auto& dec: m_cascade_count_decorators) {
    dec.lock(targets.get());
  }
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

extraOutputDeps()

const DataObjIDColl & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

finalize()

StatusCode TruthParentDecoratorAlg::finalize ( )

overridevirtual

Definition at line 471 of file TruthParentDecoratorAlg.cxx.

                                             {
  if (!m_allow_missing_children_pdgids.empty()) {
    float missing_fraction = double(m_missing_n_ignored) / m_total_children;
    auto msg = std::format("ignored {} missing children out of {} ({:.2}%)",m_missing_n_ignored.load(),m_total_children.load(),missing_fraction * 100);
    if (missing_fraction > m_missing_children_fraction_warning_threshold) {
      ATH_MSG_WARNING(msg);
    } else {
      ATH_MSG_INFO(msg);
    }
  }
  if (!m_warn_missing_children_pdgids.empty()) {
    auto msg = std::format("warned of {} missing children out of {}", m_missing_n_warned.load(), m_total_children.load());
    if (m_missing_n_warned > 0) {
      ATH_MSG_WARNING(msg);
    } else {
      ATH_MSG_INFO(msg);
    }
  }
  return StatusCode::SUCCESS;
}

initialize()

StatusCode TruthParentDecoratorAlg::initialize ( )

overridevirtual

Definition at line 248 of file TruthParentDecoratorAlg.cxx.

                                               {
  // initialize inputs
  ATH_CHECK(m_parents_key.initialize());
  ATH_CHECK(m_target_container_key.initialize());
  ATH_CHECK(m_cascades_key.initialize());
  // weird hack because Gaudi can't handle an infinite default
  if (m_match_delta_r.value() <= 0) m_match_delta_r.value() = INFINITY;
  // initialize outputs
  std::string jc = m_target_container_key.key();
  std::string pfx = jc + "." + m_prefix.value();
  m_target_pdgid_key = pfx + "PdgId";
  m_target_dr_truth_key = pfx + "DRTruthParticle";
  m_target_link_key = pfx + "Link";
  m_target_index_key = pfx + "Index";
  m_target_n_matched_key = pfx + "NMatchedChildren";
  m_target_match_mask_key = pfx + "ParentsMask";
  m_match_pdgid_key = pfx + "MatchingParticlePdgId";
  m_match_children_key = pfx + "MatchingParticleNChildren";
  m_match_link_key = pfx + "MatchingParticleLink";
  m_target_mass_key = pfx + "Mass";
  m_target_pt_key = pfx + "PT";
  m_target_energy_key = pfx + "Energy";
  m_target_eta_key = pfx + "Eta";
  m_target_phi_key = pfx + "Phi";
  ATH_CHECK(m_target_pdgid_key.initialize());
  ATH_CHECK(m_target_dr_truth_key.initialize());
  ATH_CHECK(m_target_link_key.initialize());
  ATH_CHECK(m_target_index_key.initialize());
  ATH_CHECK(m_target_n_matched_key.initialize());
  ATH_CHECK(m_target_match_mask_key.initialize());
  ATH_CHECK(m_match_pdgid_key.initialize());
  ATH_CHECK(m_match_children_key.initialize());
  ATH_CHECK(m_match_link_key.initialize());
  ATH_CHECK(m_target_mass_key.initialize());
  ATH_CHECK(m_target_pt_key.initialize());
  ATH_CHECK(m_target_energy_key.initialize());
  ATH_CHECK(m_target_eta_key.initialize());
  ATH_CHECK(m_target_phi_key.initialize());
 
  for (auto& [key, pids]: m_counts_matching_cascade) {
    m_cascade_count_writer_keys.emplace_back(jc + "." + key);
    m_cascade_count_decorators.emplace_back(key, pids);
  }
  for (auto& key: m_cascade_count_writer_keys) declare(key);
  ATH_CHECK(m_cascade_count_writer_keys.initialize());
 
  // ATLASRECTS-8290: this should be removed eventually
  if (m_use_barcode) m_uid = SG::ConstAccessor<int>("barcode");
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ITkPixelCablingAlg, ITkStripCablingAlg, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, and Simulation::BeamEffectsAlg.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::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< Gaudi::Algorithm > >::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.

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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in HypoBase, and InputMakerBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                               {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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_add_b

Gaudi::Property<bool> TruthParentDecoratorAlg::m_add_b

private

Initial value:

{
    this, "addBsToCascade", false, "add all bhadrons to cascade"
  }

Definition at line 63 of file TruthParentDecoratorAlg.h.

                             {
    this, "addBsToCascade", false, "add all bhadrons to cascade"
  };

m_add_c

Gaudi::Property<bool> TruthParentDecoratorAlg::m_add_c

private

Initial value:

{
    this, "addCsToCascade", false, "add all chadrons to cascade"
  }

Definition at line 66 of file TruthParentDecoratorAlg.h.

                             {
    this, "addCsToCascade", false, "add all chadrons to cascade"
  };

m_allow_missing_children_pdgids

Gaudi::Property<std::unordered_set<int> > TruthParentDecoratorAlg::m_allow_missing_children_pdgids

private

Initial value:

{
    this, "allowMissingChildrenPdgIds", {},
    "Allow particles matching these PDG IDs to have missing children"
  }

Definition at line 110 of file TruthParentDecoratorAlg.h.

                                                                       {
    this, "allowMissingChildrenPdgIds", {},
    "Allow particles matching these PDG IDs to have missing children"
  };

m_cascade_count_decorators

std::vector<CascadeCountDecorator> TruthParentDecoratorAlg::m_cascade_count_decorators

private

Definition at line 108 of file TruthParentDecoratorAlg.h.

m_cascade_count_writer_keys

SG::WriteDecorHandleKeyArray<JC> TruthParentDecoratorAlg::m_cascade_count_writer_keys

private

Definition at line 107 of file TruthParentDecoratorAlg.h.

m_cascade_pdgids

Gaudi::Property<std::vector<int> > TruthParentDecoratorAlg::m_cascade_pdgids

private

Initial value:

{
    this, "cascadePdgIds", {}, "PDGIDs of particles in the decay chain"
  }

Definition at line 60 of file TruthParentDecoratorAlg.h.

                                                {
    this, "cascadePdgIds", {}, "PDGIDs of particles in the decay chain"
  };

m_cascades_key

SG::ReadHandleKeyArray<TPC> TruthParentDecoratorAlg::m_cascades_key

private

Initial value:

{
    this, "cascades", {}, "truth hadron container"
  }

Definition at line 84 of file TruthParentDecoratorAlg.h.

                                          {
    this, "cascades", {}, "truth hadron container"
  };

m_counts_matching_cascade

Gaudi::Property<cascade_counter_property_t> TruthParentDecoratorAlg::m_counts_matching_cascade

private

Initial value:

{
    this, "countChildrenInCascadeWithPdgIds", {},
    "Create one counter for each entry, named by key. Counts children "
    "with at least one overlapping value in the cascade."
  }

Definition at line 102 of file TruthParentDecoratorAlg.h.

                                                                      {
    this, "countChildrenInCascadeWithPdgIds", {},
    "Create one counter for each entry, named by key. Counts children "
    "with at least one overlapping value in the cascade."
  };

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

m_match_children_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_match_children_key

private

Definition at line 94 of file TruthParentDecoratorAlg.h.

m_match_delta_r

Gaudi::Property<float> TruthParentDecoratorAlg::m_match_delta_r

private

Initial value:

{
    this, "matchDeltaR", -1,
    "width of delta R cone for matching (zero or less -> infinite)"
  }

Definition at line 77 of file TruthParentDecoratorAlg.h.

                                      {
    this, "matchDeltaR", -1,
    "width of delta R cone for matching (zero or less -> infinite)"
  };

m_match_link_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_match_link_key

private

Definition at line 95 of file TruthParentDecoratorAlg.h.

m_match_pdgid_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_match_pdgid_key

private

Definition at line 93 of file TruthParentDecoratorAlg.h.

m_missing_children_fraction_warning_threshold

Gaudi::Property<float> TruthParentDecoratorAlg::m_missing_children_fraction_warning_threshold

private

Initial value:

{
    this, "missingChildrenFractionWarningThreshold", 0.01,
    "Turn the missing children info into a warning above this"
  }

Definition at line 114 of file TruthParentDecoratorAlg.h.

                                                                     {
    this, "missingChildrenFractionWarningThreshold", 0.01,
    "Turn the missing children info into a warning above this"
  };

m_missing_n_ignored

std::atomic<unsigned long long> TruthParentDecoratorAlg::m_missing_n_ignored

mutableprivate

Definition at line 122 of file TruthParentDecoratorAlg.h.

m_missing_n_warned

std::atomic<unsigned long long> TruthParentDecoratorAlg::m_missing_n_warned

mutableprivate

Definition at line 123 of file TruthParentDecoratorAlg.h.

m_parent_pdgids

Gaudi::Property<std::vector<int> > TruthParentDecoratorAlg::m_parent_pdgids

private

Initial value:

{
    this, "parentPdgIds", {}, "PDGIDs of allowed parent particles"
  }

Definition at line 57 of file TruthParentDecoratorAlg.h.

                                               {
    this, "parentPdgIds", {}, "PDGIDs of allowed parent particles"
  };

m_parents_key

SG::ReadHandleKey<TPC> TruthParentDecoratorAlg::m_parents_key

private

Initial value:

{
    this, "parents", "", "truth parent container"
  }

Definition at line 81 of file TruthParentDecoratorAlg.h.

                                    {
    this, "parents", "", "truth parent container"
  };

m_prefix

Gaudi::Property<std::string> TruthParentDecoratorAlg::m_prefix

private

Initial value:

{
    this, "decoratorPrefix", "parentBoson", "prefix for decorations"
  }

Definition at line 54 of file TruthParentDecoratorAlg.h.

                                   {
    this, "decoratorPrefix", "parentBoson", "prefix for decorations"
  };

m_target_container_key

SG::ReadHandleKey<JC> TruthParentDecoratorAlg::m_target_container_key

private

Initial value:

{
    this, "targetContainer", "", "target container to decorate"
  }

Definition at line 51 of file TruthParentDecoratorAlg.h.

                                            {
    this, "targetContainer", "", "target container to decorate"
  };

m_target_dr_truth_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_target_dr_truth_key

private

Definition at line 88 of file TruthParentDecoratorAlg.h.

m_target_energy_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_target_energy_key

private

Definition at line 98 of file TruthParentDecoratorAlg.h.

m_target_eta_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_target_eta_key

private

Definition at line 99 of file TruthParentDecoratorAlg.h.

m_target_index_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_target_index_key

private

Definition at line 90 of file TruthParentDecoratorAlg.h.

m_target_link_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_target_link_key

private

Definition at line 89 of file TruthParentDecoratorAlg.h.

m_target_mass_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_target_mass_key

private

Definition at line 96 of file TruthParentDecoratorAlg.h.

m_target_match_mask_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_target_match_mask_key

private

Definition at line 92 of file TruthParentDecoratorAlg.h.

m_target_n_matched_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_target_n_matched_key

private

Definition at line 91 of file TruthParentDecoratorAlg.h.

m_target_pdgid_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_target_pdgid_key

private

Definition at line 87 of file TruthParentDecoratorAlg.h.

m_target_phi_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_target_phi_key

private

Definition at line 100 of file TruthParentDecoratorAlg.h.

m_target_pt_key

SG::WriteDecorHandleKey<JC> TruthParentDecoratorAlg::m_target_pt_key

private

Definition at line 97 of file TruthParentDecoratorAlg.h.

m_total_children

std::atomic<unsigned long long> TruthParentDecoratorAlg::m_total_children

mutableprivate

Definition at line 124 of file TruthParentDecoratorAlg.h.

m_uid

SG::ConstAccessor<int> TruthParentDecoratorAlg::m_uid {"uid"}

private

Definition at line 130 of file TruthParentDecoratorAlg.h.

{"uid"};

m_use_barcode

Gaudi::Property<bool> TruthParentDecoratorAlg::m_use_barcode

private

Initial value:

{
    this, "useBarcode", false, "use barcode rather than UID"
  }

Definition at line 127 of file TruthParentDecoratorAlg.h.

                                    {
    this, "useBarcode", false, "use barcode rather than UID"
  };

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_veto_soft_charm

Gaudi::Property<bool> TruthParentDecoratorAlg::m_veto_soft_charm

private

Initial value:

{
    this, "vetoSoftCharmCascade", false,
    "veto soft charm decays from cascade"
  }

Definition at line 73 of file TruthParentDecoratorAlg.h.

                                       {
    this, "vetoSoftCharmCascade", false,
    "veto soft charm decays from cascade"
  };

m_veto_soft_lepton

Gaudi::Property<bool> TruthParentDecoratorAlg::m_veto_soft_lepton

private

Initial value:

{
    this, "vetoSoftLeptonCascade", false,
    "veto soft lepton decays from cascade"
  }

Definition at line 69 of file TruthParentDecoratorAlg.h.

                                        {
    this, "vetoSoftLeptonCascade", false,
    "veto soft lepton decays from cascade"
  };

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_warn_missing_children_pdgids

Gaudi::Property<std::unordered_set<int> > TruthParentDecoratorAlg::m_warn_missing_children_pdgids

private

Initial value:

{
    this, "warnMissingChildrenPdgIds", {},
    "Warn if particles matching these PDF IDs have missing children"
  }

Definition at line 118 of file TruthParentDecoratorAlg.h.

                                                                      {
    this, "warnMissingChildrenPdgIds", {},
    "Warn if particles matching these PDF IDs have missing children"
  };

---

The documentation for this class was generated from the following files:

• TruthParentDecoratorAlg.h
• TruthParentDecoratorAlg.cxx