#include <ThinGeantTruthAlg.h>

Inheritance diagram for ThinGeantTruthAlg:

Collaboration diagram for ThinGeantTruthAlg:

Public Member Functions
virtual StatusCode	initialize () override

virtual StatusCode	finalize () override

virtual StatusCode	execute (const EventContext &ctx) const override final

void	ancestors (const xAOD::TruthParticle *, std::vector< bool > &, std::unordered_set< int > &) const
	Inline method. More...

void	descendants (const xAOD::TruthParticle *, std::vector< bool > &, std::unordered_set< int > &) const

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...

virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...

virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

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`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

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

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
StringProperty	m_streamName

Gaudi::Property< float >	m_etaMaxEgTruth

Gaudi::Property< bool >	m_keepMuons { this, "keepMuons", true }

Gaudi::Property< bool >	m_keepEGamma { this, "keepEGamma", true }

Gaudi::Property< std::string >	m_truthLinkDecor {this, "TruthLinkDecor", "truthParticleLink"}
	Truth particle link decorations. More...

SG::ReadDecorHandleKeyArray< xAOD::IParticleContainer >	m_readDecorKeys {this, "DecorKeys", {}}
	Schedule the algorithm's dependency on the truth particle link. More...

Gaudi::Property< std::vector< int > >	m_longlived

SG::ThinningHandleKey< xAOD::TruthParticleContainer >	m_truthParticlesKey

SG::ThinningHandleKey< xAOD::TruthVertexContainer >	m_truthVerticesKey

SG::ReadHandleKey< xAOD::ElectronContainer >	m_electronsKey

SG::ReadHandleKey< xAOD::ElectronContainer >	m_fwdElectronsKey

SG::ReadHandleKey< xAOD::PhotonContainer >	m_photonsKey

SG::ReadHandleKey< xAOD::MuonContainer >	m_muonsKey { this, "MuonsKey", "Muons", "Name of the input muon container" }

SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_egammaTruthKey

std::atomic< unsigned long >	m_nEventsProcessed {}
	Counters. More...

std::atomic< unsigned long >	m_nParticlesProcessed {}

std::atomic< unsigned long >	m_nVerticesProcessed {}

std::atomic< unsigned long >	m_nParticlesThinned {}

std::atomic< unsigned long >	m_nVerticesThinned {}

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

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 30 of file ThinGeantTruthAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ ancestors()

void ThinGeantTruthAlg::ancestors	(	const xAOD::TruthParticle *	pHead,
		std::vector< bool > &	particleMask,
		std::unordered_set< int > &	encounteredUniqueIDs
	)		const

Inline method.

Definition at line 324 of file ThinGeantTruthAlg.cxx.

 {
  
   // Check that this uniqueID hasn't been seen before (e.g. we are in a loop)
   std::unordered_set<int>::const_iterator found =
     encounteredUniqueIDs.find(HepMC::uniqueID(pHead));
   if (found != encounteredUniqueIDs.end())
     return;
   encounteredUniqueIDs.insert(HepMC::uniqueID(pHead));
  
   // Save particle position in the mask
   int headIndex = pHead->index();
   particleMask[headIndex] = true;
  
   // Get the production vertex
   const xAOD::TruthVertex* prodVtx(nullptr);
   if (pHead->hasProdVtx()) {
     prodVtx = pHead->prodVtx();
   } else {
     return;
   }
  
   // Get children particles and self-call
   int nParents = prodVtx->nIncomingParticles();
   for (int i = 0; i < nParents; ++i)
     ancestors(prodVtx->incomingParticle(i), particleMask, encounteredUniqueIDs);
 }

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality

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() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

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

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

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

◆ descendants()

void ThinGeantTruthAlg::descendants	(	const xAOD::TruthParticle *	pHead,
		std::vector< bool > &	particleMask,
		std::unordered_set< int > &	encounteredUniqueIDs
	)		const

Definition at line 359 of file ThinGeantTruthAlg.cxx.

 {
   // Check that this unique ID hasn't been seen before (e.g. we are in a loop)
   std::unordered_set<int>::const_iterator found =
     encounteredUniqueIDs.find(HepMC::uniqueID(pHead));
   if (found != encounteredUniqueIDs.end())
     return;
   encounteredUniqueIDs.insert(HepMC::uniqueID(pHead));
  
   // Save the particle position in the mask
   int headIndex = pHead->index();
   particleMask[headIndex] = true;
  
   // Get the decay vertex
   const xAOD::TruthVertex* decayVtx(nullptr);
   if (pHead->hasDecayVtx()) {
     decayVtx = pHead->decayVtx();
   } else {
     return;
   }
  
   // Get children particles and self-call
   int nChildren = decayVtx->nOutgoingParticles();
   for (int i = 0; i < nChildren; ++i) {
     descendants(
       decayVtx->outgoingParticle(i), particleMask, encounteredUniqueIDs);
   }
  
   }

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

95 { return m_detStore; }

◆ evtStore() [1/2]

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.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( ) const

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode ThinGeantTruthAlg::execute ( const EventContext & ctx ) const

finaloverridevirtual

Definition at line 85 of file ThinGeantTruthAlg.cxx.

 {
   // Increase the event counter
   ++m_nEventsProcessed;
  
   // Retrieve truth and vertex containers
   SG::ThinningHandle truthParticles{m_truthParticlesKey, ctx};
   SG::ThinningHandle truthVertices{m_truthVerticesKey, ctx};
   if (!truthParticles.isValid()) {
     ATH_MSG_FATAL("No TruthParticleContainer with key " << m_truthParticlesKey.key() << " found.");
     return StatusCode::FAILURE;
   }
   if (!truthVertices.isValid()) {
     ATH_MSG_FATAL("No TruthVertexContainer with key " << m_truthVerticesKey.key() << " found.");
     return StatusCode::FAILURE;
   }
  
   // Loop over photons, electrons and muons and get the associated truth
   // particles Retain the associated index number
   std::vector<int> recoParticleTruthIndices;
   std::vector<int> egammaTruthIndices{};
  
   // Muons
   if (m_keepMuons) {
     const xAOD::MuonContainer* muons{nullptr};
     ATH_CHECK(SG::get(muons, m_muonsKey, ctx));
     for (const xAOD::Muon* muon : *muons) {
       const xAOD::TruthParticle* truthMuon = xAOD::TruthHelpers::getTruthParticle(*muon);
       if (truthMuon) {
         truthMuon = xAOD::TruthHelpers::getTruthParticle(*truthMuon);
         if (truthMuon) {
           recoParticleTruthIndices.push_back(truthMuon->index());
         }
       }
     }
   }
  
   // Electrons and photons
   if (m_keepEGamma) {
  
     // Electrons
     const xAOD::ElectronContainer* electrons{nullptr};
     ATH_CHECK(SG::get(electrons, m_electronsKey, ctx));
    
     for (const xAOD::Electron* electron : *electrons) {
       const xAOD::TruthParticle* truthElectron =
         xAOD::TruthHelpers::getTruthParticle(*electron);
       if (truthElectron) {
         recoParticleTruthIndices.push_back(truthElectron->index());
       }
     }
  
     // Forward Electrons
     const xAOD::ElectronContainer* fwdElectrons{nullptr};
     ATH_CHECK(SG::get(fwdElectrons, m_fwdElectronsKey, ctx));
     if (fwdElectrons) {
       
       for (const xAOD::Electron* electron : *fwdElectrons) {
         const xAOD::TruthParticle* truthElectron =
           xAOD::TruthHelpers::getTruthParticle(*electron);
         if (truthElectron) {
           recoParticleTruthIndices.push_back(truthElectron->index());
         }
       }
     }
  
     // Photons
     const xAOD::PhotonContainer* photons{nullptr};
     ATH_CHECK(SG::get(photons, m_photonsKey, ctx));
     for (const xAOD::Photon* photon : *photons) {
       const xAOD::TruthParticle* truthPhoton =
         xAOD::TruthHelpers::getTruthParticle(*photon);
       if (truthPhoton) {
         recoParticleTruthIndices.push_back(truthPhoton->index());
       }
     }
  
     // egamma Truth Particles
     const xAOD::TruthParticleContainer* egammaTruthParticles{nullptr};
     ATH_CHECK(SG::get(egammaTruthParticles, m_egammaTruthKey, ctx));
  
     for (const xAOD::TruthParticle* egTruthParticle : *egammaTruthParticles) {
  
       static const SG::AuxElement::ConstAccessor<int> accType("truthType");
  
       if (!accType.isAvailable(*egTruthParticle) ||
           accType(*egTruthParticle) != MCTruthPartClassifier::IsoElectron ||
           std::abs(egTruthParticle->eta()) > m_etaMaxEgTruth) {
         continue;
       }
       // Only isolated true electrons
       using TruthLink_t = ElementLink<xAOD::TruthParticleContainer>;
       static const SG::AuxElement::ConstAccessor<TruthLink_t> linkToTruth(
         "truthParticleLink");
       if (!linkToTruth.isAvailable(*egTruthParticle)) {
         continue;
       }
  
       const TruthLink_t& truthegamma = linkToTruth(*egTruthParticle);
       if (!truthegamma.isValid()) {
         continue;
       }
       egammaTruthIndices.push_back((*truthegamma)->index());
     }
   }
  
   // Set up masks
   std::vector<bool> particleMask, vertexMask;
   int nTruthParticles = truthParticles->size();
   int nTruthVertices = truthVertices->size();
   m_nParticlesProcessed.fetch_add(nTruthParticles, std::memory_order_relaxed);
   m_nVerticesProcessed.fetch_add(nTruthVertices, std::memory_order_relaxed);
   particleMask.assign(nTruthParticles, false);
   vertexMask.assign(nTruthVertices, false);
  
   // Vector of pairs keeping track of how many incoming/outgoing particles each
   // vertex has
   std::vector<std::pair<int, int>> vertexLinksCounts;
   for (const auto *vertex : *truthVertices) {
     std::pair<int, int> tmpPair;
     tmpPair.first = vertex->nIncomingParticles();
     tmpPair.second = vertex->nOutgoingParticles();
     vertexLinksCounts.push_back(tmpPair);
   }
  
   // Loop over truth particles and update mask
   std::unordered_set<int> encounteredUniqueIDs; // for loop protection
   for (int i = 0; i < nTruthParticles; ++i) {
     encounteredUniqueIDs.clear();
     const xAOD::TruthParticle* particle = (*truthParticles)[i];
     // Retain status 1 BSM particles and descendants
     if (MC::isBSM(particle) && MC::isStable(particle)) {
       descendants(particle, particleMask, encounteredUniqueIDs);
       encounteredUniqueIDs.clear();
     }
     // Retain children of longer-lived generator particles
     if (MC::isStable(particle)) {
       int pdgId = abs(particle->pdgId());
       if (std::find(m_longlived.begin(), m_longlived.end(), pdgId) !=
           m_longlived.end()) {
         const xAOD::TruthVertex* decayVtx(nullptr);
         if (particle->hasDecayVtx()) {
           decayVtx = particle->decayVtx();
         }
         int nChildren = 0;
         if (decayVtx)
           nChildren = decayVtx->nOutgoingParticles();
         for (int i = 0; i < nChildren; ++i) {
           particleMask[decayVtx->outgoingParticle(i)->index()] = true;
         }
       }
     }
  
     // Retain particles and their descendants/ancestors associated with the
     // reconstructed objects
     if (std::find(recoParticleTruthIndices.begin(),
                   recoParticleTruthIndices.end(),
                   i) != recoParticleTruthIndices.end()) {
       if (HepMC::is_simulation_particle(particle)) { // only need to do this for Geant particles since
                            // non-Geant are kept anyway
         ancestors(particle, particleMask, encounteredUniqueIDs);
         encounteredUniqueIDs.clear();
         descendants(particle, particleMask, encounteredUniqueIDs);
         encounteredUniqueIDs.clear();
       }
     }
  
     // Retain particles and their descendants  associated with the egamma Truth
     // Particles
     if (std::find(egammaTruthIndices.begin(), egammaTruthIndices.end(), i) !=
         egammaTruthIndices.end()) {
       descendants(particle, particleMask, encounteredUniqueIDs);
       encounteredUniqueIDs.clear();
     }
  
     if (!HepMC::is_simulation_particle(particle)) {
       particleMask[i] = true;
     }
     else {
       // deal with the products of interactions of quasi-stable
       // particles
       if (particle->hasProdVtx()) {
         const xAOD::TruthVertex* prodVtx = particle->prodVtx();
         const int nParents = prodVtx->nIncomingParticles();
         for (int parent = 0; parent < nParents; ++parent) {
           if (MC::isDecayed(prodVtx->incomingParticle(parent))) {
             // "simulation particle" with a parent with status==2 was
             // produced via the interaction of a quasi-stable particle
             // with the detector material. Such particles should be kept.
             particleMask[i] = true;
             break;
           }
         }
       }
     }
   }
  
   // Loop over the mask and update vertex association counters
   for (int i = 0; i < nTruthParticles; ++i) {
     if (!particleMask[i]) {
       ++m_nParticlesThinned;
       const xAOD::TruthParticle* particle = (*truthParticles)[i];
       if (particle->hasProdVtx()) {
         const auto *prodVertex = particle->prodVtx();
         --vertexLinksCounts[prodVertex->index()].second;
       }
       if (particle->hasDecayVtx()) {
         const auto *decayVertex = particle->decayVtx();
         --vertexLinksCounts[decayVertex->index()].first;
       }
     }
   }
  
   // Loop over truth vertices and update mask
   // Those for which all incoming and outgoing particles are to be thinned, will
   // be thinned as well
   unsigned int nVerticesThinned = 0;
   for (int i = 0; i < nTruthVertices; ++i) {
     if (vertexLinksCounts[i].first != 0 || vertexLinksCounts[i].second != 0) {
       vertexMask[i] = true;
     } else {
       ++nVerticesThinned;
     }
   }
   m_nVerticesThinned.fetch_add(nVerticesThinned, std::memory_order_relaxed);
   // Apply masks to thinning
   truthParticles.keep(particleMask);
   truthVertices.keep(vertexMask);
  
   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

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 ThinGeantTruthAlg::finalize ( )

overridevirtual

Definition at line 73 of file ThinGeantTruthAlg.cxx.

 {
   ATH_MSG_INFO("Processed " << m_nEventsProcessed << " events containing "
                             << m_nParticlesProcessed << " truth particles and "
                             << m_nVerticesProcessed << " truth vertices ");
   ATH_MSG_INFO("Removed " << m_nParticlesThinned
                           << " Geant truth particles and " << m_nVerticesThinned
                           << " corresponding truth vertices ");
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode ThinGeantTruthAlg::initialize ( )

overridevirtual

Definition at line 41 of file ThinGeantTruthAlg.cxx.

 {
   if (m_streamName.empty()) {
     ATH_MSG_ERROR("StreamName property was not initialized.");
     return StatusCode::FAILURE;
   }
  
   ATH_CHECK(m_truthParticlesKey.initialize(m_streamName));
   ATH_CHECK(m_truthVerticesKey.initialize(m_streamName));
   ATH_CHECK(m_electronsKey.initialize(m_keepEGamma));
   ATH_CHECK(m_fwdElectronsKey.initialize(m_keepEGamma && !m_fwdElectronsKey.empty()));
   ATH_CHECK(m_photonsKey.initialize(m_keepEGamma));
   ATH_CHECK(m_muonsKey.initialize(m_keepMuons));
   ATH_CHECK(m_egammaTruthKey.initialize(m_keepEGamma));
   if (m_keepEGamma) {
     m_readDecorKeys.emplace_back(m_electronsKey, m_truthLinkDecor);
     m_readDecorKeys.emplace_back(m_photonsKey, m_truthLinkDecor);
     if (!m_fwdElectronsKey.empty()){
       m_readDecorKeys.emplace_back(m_fwdElectronsKey, m_truthLinkDecor);
     }
   }
   if (!m_muonsKey.empty()){
     m_readDecorKeys.emplace_back(m_muonsKey, m_truthLinkDecor);
   }
   
   ATH_CHECK(m_readDecorKeys.initialize());
  
  
   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

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

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

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ 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 InputMakerBase, and HypoBase.

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_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_egammaTruthKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> ThinGeantTruthAlg::m_egammaTruthKey

private

Initial value:

{
    this,
    "EGammaTruthKey",
    "egammaTruthParticles",
    "Name of the input egammaTruth container"
  }

Definition at line 111 of file ThinGeantTruthAlg.h.

◆ m_electronsKey

SG::ReadHandleKey<xAOD::ElectronContainer> ThinGeantTruthAlg::m_electronsKey

private

Initial value:

{
    this,
    "ElectronsKey",
    "Electrons",
    "Name of the input electron container"
  }

Definition at line 87 of file ThinGeantTruthAlg.h.

◆ m_etaMaxEgTruth

Gaudi::Property<float> ThinGeantTruthAlg::m_etaMaxEgTruth

private

Initial value:

{ this,
                                          "EtaMaxEGammaTruth",
                                          2.525,
                                          "Max eta value for e-gamma truth particles" }

Definition at line 52 of file ThinGeantTruthAlg.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_fwdElectronsKey

SG::ReadHandleKey<xAOD::ElectronContainer> ThinGeantTruthAlg::m_fwdElectronsKey

private

Initial value:

{
    this,
    "FwdElectronsKey",
    "",
    "Name of the input forward electron container"
  }

Definition at line 94 of file ThinGeantTruthAlg.h.

◆ m_keepEGamma

Gaudi::Property<bool> ThinGeantTruthAlg::m_keepEGamma { this, "keepEGamma", true }

private

Definition at line 58 of file ThinGeantTruthAlg.h.

◆ m_keepMuons

Gaudi::Property<bool> ThinGeantTruthAlg::m_keepMuons { this, "keepMuons", true }

private

Definition at line 57 of file ThinGeantTruthAlg.h.

◆ m_longlived

Gaudi::Property<std::vector<int> > ThinGeantTruthAlg::m_longlived

private

Initial value:

{
    this,
    "LongLivedParticleList",
    { 310, 3122, 3222, 3112, 3322, 3312 },
    "List of long lifetime particles which are likely to be decayed by "
    "Geant but whose children must be kept"
  }

Definition at line 65 of file ThinGeantTruthAlg.h.

◆ m_muonsKey

SG::ReadHandleKey<xAOD::MuonContainer> ThinGeantTruthAlg::m_muonsKey { this, "MuonsKey", "Muons", "Name of the input muon container" }

private

Definition at line 109 of file ThinGeantTruthAlg.h.

◆ m_nEventsProcessed

std::atomic<unsigned long> ThinGeantTruthAlg::m_nEventsProcessed {}

mutableprivate

Counters.

Definition at line 119 of file ThinGeantTruthAlg.h.

◆ m_nParticlesProcessed

std::atomic<unsigned long> ThinGeantTruthAlg::m_nParticlesProcessed {}

mutableprivate

Definition at line 120 of file ThinGeantTruthAlg.h.

◆ m_nParticlesThinned

std::atomic<unsigned long> ThinGeantTruthAlg::m_nParticlesThinned {}

mutableprivate

Definition at line 122 of file ThinGeantTruthAlg.h.

◆ m_nVerticesProcessed

std::atomic<unsigned long> ThinGeantTruthAlg::m_nVerticesProcessed {}

mutableprivate

Definition at line 121 of file ThinGeantTruthAlg.h.

◆ m_nVerticesThinned

std::atomic<unsigned long> ThinGeantTruthAlg::m_nVerticesThinned {}

mutableprivate

Definition at line 123 of file ThinGeantTruthAlg.h.

◆ m_photonsKey

SG::ReadHandleKey<xAOD::PhotonContainer> ThinGeantTruthAlg::m_photonsKey

private

Initial value:

{
    this,
    "PhotonsKey",
    "Photons",
    "Name of the input photon container"
  }

Definition at line 101 of file ThinGeantTruthAlg.h.

◆ m_readDecorKeys

SG::ReadDecorHandleKeyArray<xAOD::IParticleContainer> ThinGeantTruthAlg::m_readDecorKeys {this, "DecorKeys", {}}

private

Schedule the algorithm's dependency on the truth particle link.

Definition at line 63 of file ThinGeantTruthAlg.h.

◆ m_streamName

StringProperty ThinGeantTruthAlg::m_streamName

private

Initial value:

{ this,
                               "StreamName",
                               "",
                               "Stream for which thinning is to be done." }

Definition at line 47 of file ThinGeantTruthAlg.h.

◆ m_truthLinkDecor

Gaudi::Property<std::string> ThinGeantTruthAlg::m_truthLinkDecor {this, "TruthLinkDecor", "truthParticleLink"}

private

Truth particle link decorations.

Definition at line 61 of file ThinGeantTruthAlg.h.

◆ m_truthParticlesKey

SG::ThinningHandleKey<xAOD::TruthParticleContainer> ThinGeantTruthAlg::m_truthParticlesKey

private

Initial value:

{
    this,
    "TruthParticlesKey",
    "TruthParticles",
    "Name of the input Truth Particle container"
  }

Definition at line 73 of file ThinGeantTruthAlg.h.

◆ m_truthVerticesKey

SG::ThinningHandleKey<xAOD::TruthVertexContainer> ThinGeantTruthAlg::m_truthVerticesKey

private

Initial value:

{
    this,
    "TruthVerticesKey",
    "TruthVertices",
    "Name of the input Truth Vertices container"
  }

Definition at line 80 of file ThinGeantTruthAlg.h.

◆ m_varHandleArraysDeclared

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

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ ancestors()

◆ cardinality()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ descendants()

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_egammaTruthKey

◆ m_electronsKey

◆ m_etaMaxEgTruth

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_fwdElectronsKey

◆ m_keepEGamma

◆ m_keepMuons

◆ m_longlived

◆ m_muonsKey

◆ m_nEventsProcessed

◆ m_nParticlesProcessed

◆ m_nParticlesThinned

◆ m_nVerticesProcessed

◆ m_nVerticesThinned

◆ m_photonsKey

◆ m_readDecorKeys

◆ m_streamName

◆ m_truthLinkDecor

◆ m_truthParticlesKey

◆ m_truthVerticesKey

◆ m_varHandleArraysDeclared

◆ m_vhka