ATLAS Offline Software
Loading...
Searching...
No Matches
TrackParticleTruthAlg Class Reference

#include <TrackParticleTruthAlg.h>

Inheritance diagram for TrackParticleTruthAlg:
Collaboration diagram for TrackParticleTruthAlg:

Public Member Functions

virtual StatusCode initialize () override
virtual StatusCode execute (const EventContext &ctx) const 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

typedef ServiceHandle< StoreGateSvcStoreGateSvc_t

Private Member Functions

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::TrackParticleContainerm_trkKey
SG::WriteDecorHandleKey< xAOD::TrackParticleContainerm_particlesLinkKey {this, "ParticleLinkKey", m_trkKey,"truthParticleLink"}
SG::WriteDecorHandleKey< xAOD::TrackParticleContainerm_particlesTypeKey {this, "ParticleTypeKey" ,m_trkKey, "truthType"}
SG::WriteDecorHandleKey< xAOD::TrackParticleContainerm_particlesOriginKey {this, "ParticleOriginKey", m_trkKey, "truthOrigin"}
SG::ReadHandleKey< xAODTruthParticleLinkVectorm_truthParticleLinkVecKey
SG::ReadHandleKey< TrackTruthCollectionm_truthTracksKey
ToolHandle< IMCTruthClassifierm_truthClassifier
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 17 of file TrackParticleTruthAlg.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

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

64{
65 return 0;
66}

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

158 {
160 hndl.value(),
161 hndl.documentation());
162
163 }
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)

◆ declareProperty()

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

Definition at line 145 of file AthCommonDataStore.h.

145 {
146 typedef typename SG::HandleClassifier<T>::type htype;
148 }
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>

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

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

◆ execute()

StatusCode TrackParticleTruthAlg::execute ( const EventContext & ctx) const
overridevirtual

STACO combined tracks are just added to the muon for completeness They're not expected to have a valid track link

Definition at line 29 of file TrackParticleTruthAlg.cxx.

29 {
30
31 SG::ReadHandle<TrackTruthCollection> truthTracks{m_truthTracksKey, ctx};
32 SG::ReadHandle<xAODTruthParticleLinkVector> truthParticleLinkVec{ m_truthParticleLinkVecKey, ctx};
33 SG::WriteDecorHandle<xAOD::TrackParticleContainer,ElementLink<xAOD::TruthParticleContainer> > particlesLink{m_particlesLinkKey, ctx};
34 SG::WriteDecorHandle<xAOD::TrackParticleContainer,int> particlesType{m_particlesTypeKey, ctx};
35 SG::WriteDecorHandle<xAOD::TrackParticleContainer,int> particlesOrigin{m_particlesOriginKey, ctx};
36
37 ATH_CHECK(particlesLink.isValid());
38 ATH_CHECK(truthParticleLinkVec.isValid());
39 ATH_CHECK(truthTracks.isValid());
40
41
42 const TrackTruthCollection truthTrackColl=*truthTracks;
43 const xAODTruthParticleLinkVector truthParticleLinks=*truthParticleLinkVec;
44
45 int partInd=0;
46 for( const xAOD::TrackParticle* particle : *particlesLink ){
47
48 ATH_MSG_DEBUG("Looking up truth for pt " << particle->pt() << " eta " << particle->eta() << " phi " << particle->phi());
51 if( !particle->trackLink().isValid()){
52 if (!particle->patternRecoInfo()[xAOD::STACO]) {
53 ATH_MSG_WARNING("Found TrackParticle with Invalid element link, skipping");
54 }
55 //add dummy truth link
56 particlesLink(*particle)=ElementLink<xAOD::TruthParticleContainer>();
57 particlesType(*particle) = 0;
58 particlesOrigin(*particle)= 0;
59 continue;
60 }
61
64 ElementLink<xAOD::TruthParticleContainer> link;
65 // look-up associated truth particle
66
67 Trk::TrackTruthKey key(particle->trackLink());
68 auto result = truthTrackColl.find(key);
69
70 // if we found a match use it
71 if( result != truthTrackColl.end() ){
72 ATH_MSG_VERBOSE("Found track Truth: uniqueID " << HepMC::uniqueID(&(result->second.particleLink())) << " evt " << result->second.particleLink().eventIndex());
73 link = truthParticleLinks.find(result->second.particleLink());
74
75 // if configured also get truth classification
76
77 if( link.isValid()&& !m_truthClassifier.empty() ){
78 auto truthClass = m_truthClassifier->particleTruthClassifier(*link);
79 type = truthClass.first;
80 origin = truthClass.second;
81 ATH_MSG_VERBOSE("Got truth type " << static_cast<int>(type) << " origin " << static_cast<int>(origin));
82 }
83 }
84
85 if( link.isValid() ){
86 ATH_MSG_DEBUG("Found matching xAOD Truth: uniqueID " << HepMC::uniqueID(*link) << " pt " << (*link)->pt() << " eta " << (*link)->eta() << " phi " << (*link)->phi());
87 // set element link
88 link.toPersistent();
89 particlesLink(*particle)=link;
90
91 }
92 else{ //no truth link, add a dummy
93 particlesLink(*particle)=ElementLink<xAOD::TruthParticleContainer>();
94 }
95
96 if( !m_truthClassifier.empty() ){
97 //use index for these since it's the same particle
98 particlesType(partInd)=static_cast<int>(type);
99 particlesOrigin(partInd)=static_cast<int>(origin);
100 }
101 partInd++;
102 }
103 return StatusCode::SUCCESS;
104}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_VERBOSE(x)
#define ATH_MSG_WARNING(x)
#define ATH_MSG_DEBUG(x)
virtual bool isValid() override final
Can the handle be successfully dereferenced?
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer > m_particlesOriginKey
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer > m_particlesTypeKey
ToolHandle< IMCTruthClassifier > m_truthClassifier
SG::ReadHandleKey< TrackTruthCollection > m_truthTracksKey
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer > m_particlesLinkKey
SG::ReadHandleKey< xAODTruthParticleLinkVector > m_truthParticleLinkVecKey
ElementLink< xAOD::TruthParticleContainer > find(const HepMcParticleLink &hepMCLink) const
int uniqueID(const T &p)
constexpr ParticleHypothesis particle[PARTICLEHYPOTHESES]
the array of masses
TrackParticle_v1 TrackParticle
Reference the current persistent version:
@ STACO
Tracks produced by STACO.

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

90{
91 // If we didn't find any symlinks to add, just return the collection
92 // from the base class. Otherwise, return the extended collection.
93 if (!m_extendedExtraObjects.empty()) {
95 }
97}
An algorithm that can be simultaneously executed in multiple threads.

◆ filterPassed()

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

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

96 {
97 return execState( ctx ).filterPassed();
98 }
virtual bool filterPassed(const EventContext &ctx) const

◆ initialize()

StatusCode TrackParticleTruthAlg::initialize ( )
overridevirtual

Definition at line 15 of file TrackParticleTruthAlg.cxx.

15 {
16
17 ATH_CHECK(m_trkKey.initialize());
18 ATH_CHECK(m_particlesLinkKey.initialize());
19 ATH_CHECK(m_particlesTypeKey.initialize());
20 ATH_CHECK(m_particlesOriginKey.initialize());
22 ATH_CHECK(m_truthTracksKey.initialize());
23 ATH_CHECK(m_truthClassifier.retrieve());
24 return StatusCode::SUCCESS;
25}
SG::ReadHandleKey< xAOD::TrackParticleContainer > m_trkKey

◆ 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()

◆ msg()

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

Definition at line 24 of file AthCommonMsg.h.

24 {
25 return this->msgStream();
26 }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

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

381 {
382 h.renounce();
384 }
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)

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

364 {
366 }

◆ setFilterPassed()

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

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

100 {
102 }
virtual void setFilterPassed(bool state, const EventContext &ctx) const

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

77{
78 return BaseAlg::sysExecute (ctx);
79}

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

107 {
109
110 if (sc.isFailure()) {
111 return sc;
112 }
113
114 ServiceHandle<ICondSvc> cs("CondSvc",name());
115 for (auto h : outputHandles()) {
116 if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
117 // do this inside the loop so we don't create the CondSvc until needed
118 if ( cs.retrieve().isFailure() ) {
119 ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
120 return StatusCode::SUCCESS;
121 }
122 if (cs->regHandle(this,*h).isFailure()) {
124 ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
125 << " with CondSvc");
126 }
127 }
128 }
129 return sc;
130}
#define ATH_MSG_ERROR(x)
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override

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

308 {
309 // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310 // << " size: " << m_vhka.size() << endmsg;
311 for (auto &a : m_vhka) {
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }

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

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> TrackParticleTruthAlg::m_particlesLinkKey {this, "ParticleLinkKey", m_trkKey,"truthParticleLink"}
private

Definition at line 28 of file TrackParticleTruthAlg.h.

29{this, "ParticleLinkKey", m_trkKey,"truthParticleLink"};

◆ m_particlesOriginKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> TrackParticleTruthAlg::m_particlesOriginKey {this, "ParticleOriginKey", m_trkKey, "truthOrigin"}
private

Definition at line 32 of file TrackParticleTruthAlg.h.

33{this, "ParticleOriginKey", m_trkKey, "truthOrigin"};

◆ m_particlesTypeKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> TrackParticleTruthAlg::m_particlesTypeKey {this, "ParticleTypeKey" ,m_trkKey, "truthType"}
private

Definition at line 30 of file TrackParticleTruthAlg.h.

31{this, "ParticleTypeKey" ,m_trkKey, "truthType"};

◆ m_trkKey

SG::ReadHandleKey<xAOD::TrackParticleContainer> TrackParticleTruthAlg::m_trkKey
private
Initial value:
{this, "TrackParticleName", "InDetTrackParticles",
"TrackParticle input name"}

Definition at line 26 of file TrackParticleTruthAlg.h.

26 {this, "TrackParticleName", "InDetTrackParticles",
27 "TrackParticle input name"};

◆ m_truthClassifier

ToolHandle<IMCTruthClassifier> TrackParticleTruthAlg::m_truthClassifier
private
Initial value:
{this, "MCTruthClassifier",
"MCTruthClassifier/MCTruthClassifier"}

Definition at line 42 of file TrackParticleTruthAlg.h.

42 {this, "MCTruthClassifier",
43 "MCTruthClassifier/MCTruthClassifier"};

◆ m_truthParticleLinkVecKey

SG::ReadHandleKey<xAODTruthParticleLinkVector> TrackParticleTruthAlg::m_truthParticleLinkVecKey
private
Initial value:
{this, "xAODTruthLinkVector", "xAODTruthLinks",
"link vector to map HepMC onto xAOD truth"}

Definition at line 35 of file TrackParticleTruthAlg.h.

36 {this, "xAODTruthLinkVector", "xAODTruthLinks",
37 "link vector to map HepMC onto xAOD truth"};

◆ m_truthTracksKey

SG::ReadHandleKey<TrackTruthCollection> TrackParticleTruthAlg::m_truthTracksKey
private
Initial value:
{this, "TrackTruthName", "TrackTruthCollection",
"Track(Particle)TruthCollection input name"}

Definition at line 38 of file TrackParticleTruthAlg.h.

39 {this, "TrackTruthName", "TrackTruthCollection",
40 "Track(Particle)TruthCollection input name"};

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