ATLAS Offline Software
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
InDet::InDetTrackTruthOriginTool Class Referenceabstract

#include <InDetTrackTruthOriginTool.h>

Inheritance diagram for InDet::InDetTrackTruthOriginTool:
Collaboration diagram for InDet::InDetTrackTruthOriginTool:

Public Member Functions

virtual void print () const =0
 Print the state of the tool. More...
 
virtual void print () const
 Print the state of the tool. More...
 
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 sysInitialize () override
 Perform system initialization for an algorithm. 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 > &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< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

virtual StatusCode initialize () override
 Dummy implementation of the initialisation function. More...
 
virtual const xAOD::TruthParticlegetTruth (const xAOD::TrackParticle *track) const override
 Safely access a track's linked truth particle, if available. More...
 
virtual int getTruthOrigin (const xAOD::TruthParticle *truth) const override
 Computes the truth particle origin. More...
 
virtual int getTrackOrigin (const xAOD::TrackParticle *track) const override
 Computes the track origin. More...
 
virtual bool isFrom (const xAOD::TruthParticle *truth, int flav) const override
 Check if a truth particle is from the specified origin (from B or D hadron, or tau) More...
 
virtual bool isFromRec (const xAOD::TruthParticle *truth, int flav, int depth=0) const
 recursion-safe(r) version of isFrom More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
 specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
 specialization for handling Gaudi::Property<SG::VarHandleBase> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
 specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...
 

Private Attributes

float m_matchingProbabilityCut
 
std::string m_truthParticleLinkName
 
std::string m_truthMatchProbabilityAuxName
 
bool m_isFullPileupTruth
 
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

This class determines the truth origin of a track

Author
Remi Zaidan (remi..nosp@m.zaid.nosp@m.an@ce.nosp@m.rn.c.nosp@m.h)
Felix Clark (micha.nosp@m.el.r.nosp@m.yan.c.nosp@m.lark.nosp@m.@cern.nosp@m..ch)

Definition at line 24 of file InDetTrackTruthOriginTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyArrayType  
)
inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

◆ declareGaudiProperty() [2/4]

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

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

Definition at line 156 of file AthCommonDataStore.h.

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleType  
)
inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  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.

200  {
201  return PBASE::declareProperty(t);
202  }

◆ declareProperty() [1/6]

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

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ declareProperty() [2/6]

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

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

◆ declareProperty() [3/6]

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

Definition at line 259 of file AthCommonDataStore.h.

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ declareProperty() [4/6]

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

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

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

◆ declareProperty() [5/6]

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

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

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

◆ declareProperty() [6/6]

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

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

◆ detStore()

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

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

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )
inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::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; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase &  ExtraDeps)
protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getKey()

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

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

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

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

See also
asg::AsgTool::getName
Parameters
ptrThe bare pointer to the object that the event store should know about
Returns
The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

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

◆ getName()

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

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

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

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

See also
asg::AsgTool::getKey
Parameters
ptrThe bare pointer to the object that the event store should know about
Returns
The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

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

◆ getProperty()

template<class T >
const T* asg::AsgTool::getProperty ( const std::string &  name) const
inherited

Get one of the tool's properties.

◆ getTrackOrigin()

int InDet::InDetTrackTruthOriginTool::getTrackOrigin ( const xAOD::TrackParticle track) const
overrideprivatevirtual

Computes the track origin.

Implements InDet::IInDetTrackTruthOriginTool.

Definition at line 163 of file InDetTrackTruthOriginTool.cxx.

163  {
164 
165  // get truth particle
166  const xAOD::TruthParticle* truth = getTruth( track );
167 
168  // get track TMP
170  float truthProb = tmpAcc( *track );
171 
172  int origin = 0;
173 
174  // truth link is broken: call it from pileup (not true for < 100 MeV and some specialised samples!)
175  if (!truth){
176  origin = origin | (0x1 << InDet::TrkOrigin::Pileup);
177  }
178 
179  // For full pile-up truth samples, check explicitly if truth record is present among hard-scatter collection to assign Pileup origin
180  else if(m_isFullPileupTruth){
181  const xAOD::TruthEventContainer* truthEventContainer(nullptr);
182  if(evtStore()->retrieve(truthEventContainer, "TruthEvents").isFailure()){
183  ATH_MSG_ERROR("InDetTrackTruthOriginTool configured for full pile-up truth but could not retrieve TruthEvents container");
184  }
185  const xAOD::TruthEvent* event = truthEventContainer ? truthEventContainer->at(0) : nullptr;
186 
187  if(event){
188  const auto& links = event->truthParticleLinks();
189 
190  bool isFromHSProdVtx = false;
191  for (const auto& link : links){
192  if(link.isValid() && truth == *link){
193  isFromHSProdVtx = true;
194  break;
195  }
196  }
197 
198  if(!isFromHSProdVtx) origin = origin | (0x1 << InDet::TrkOrigin::Pileup);
199  }
200  }
201 
202  // low TruthMatchProbability: call it fake (also includes poorly reconstructed tracks)
203  if(truthProb < m_matchingProbabilityCut) {
204  origin = origin | (0x1 << InDet::TrkOrigin::Fake);
205  }
206 
207  // truth link is present: find truth origin
208  if (truth) {
209  origin = origin | getTruthOrigin(truth);
210  }
211 
212  return origin;
213  }

◆ getTruth()

const xAOD::TruthParticle * InDet::InDetTrackTruthOriginTool::getTruth ( const xAOD::TrackParticle track) const
overrideprivatevirtual

Safely access a track's linked truth particle, if available.

Implements InDet::IInDetTrackTruthOriginTool.

Definition at line 40 of file InDetTrackTruthOriginTool.cxx.

40  {
41 
42  // if the track doesnt't have a valid truth link, skip to the next track
43  // in practice, all tracks seem to have a truth link, but we need to also
44  // check whether it's valid
46  static const SG::ConstAccessor<TruthLink>
47  truthParticleLinkAcc ("truthParticleLink");
48  if ( !truthParticleLinkAcc.isAvailable(*track) ) {
49  return nullptr;
50  }
51 
52  // retrieve the link and check its validity
53  const TruthLink &link = truthParticleLinkAcc(*track);
54 
55  // a missing or invalid link implies truth particle has been dropped from
56  // the truth record at some stage - probably it was from pilup which by
57  // default we don't store truth information for
58  if(!link or !link.isValid()) {
59  return nullptr;
60  }
61 
62  // seems safe to access and return the linked truth particle
63  return *link;
64  }

◆ getTruthOrigin()

int InDet::InDetTrackTruthOriginTool::getTruthOrigin ( const xAOD::TruthParticle truth) const
overrideprivatevirtual

Computes the truth particle origin.

Implements InDet::IInDetTrackTruthOriginTool.

Definition at line 66 of file InDetTrackTruthOriginTool.cxx.

66  {
67 
68  int origin = 0;
69 
70  // is it fragmentation? yes until proven otherwise
71  bool isFragmentation = true;
72 
73  // from B decay chain?
74  if(isFrom(truth, 5)) {
75  origin = origin | (0x1 << InDet::TrkOrigin::BHadronDecay);
76  isFragmentation = false;
77  }
78 
79  // from D decay chain?
80  if(isFrom(truth, 4)) {
81  origin = origin | (0x1 << InDet::TrkOrigin::DHadronDecay);
82  isFragmentation = false;
83  }
84 
85  // from tau decay chain?
86  if(isFrom(truth, 15)) {
87  origin = origin | (0x1 << InDet::TrkOrigin::TauDecay);
88  isFragmentation = false;
89  }
90 
91  // Secondary?
92  if (HepMC::is_simulation_particle(truth)) {
93 
94  // unknown origin (e.g. parent not in the record)
95  if(truth->nParents() != 1) {
96  origin = origin | (0x1 << InDet::TrkOrigin::OtherOrigin);
97  }
98 
99  else {
100  const xAOD::TruthParticle *parent = truth->parent(0);
101 
102  if(parent == nullptr) {
103  origin = origin | (0x1 << InDet::TrkOrigin::OtherOrigin);
104  }
105 
106  // sub-categorize secondaries which have one valid parent
107  else {
108 
109  int pdgId = truth->pdgId();
110  int parentId = parent->pdgId();
111 
112  // photon conversion
113  if(parent->isPhoton() && truth->isElectron()) {
114  origin = origin | (0x1 << InDet::TrkOrigin::GammaConversion);
115  }
116 
117  // Strange Mesons
118  else if(parent->isStrangeMeson() && parent->nChildren() == 2) {
119  origin = origin | (0x1 << InDet::TrkOrigin::StrangeMesonDecay);
120  // specifically Kshort
121  if (abs(pdgId) == 211 && parentId == 310) {
122  origin = origin | (0x1 << InDet::TrkOrigin::KshortDecay);
123  }
124  }
125 
126  // Strange Baryons
127  else if(parent->isStrangeBaryon() && parent->nChildren() == 2) {
128  origin = origin | (0x1 << InDet::TrkOrigin::StrangeBaryonDecay);
129  // specifically Lambdas
130  if ((abs(pdgId) == 211 || abs(pdgId) == 2212) && abs(parentId) == 3122) {
131  origin = origin | (0x1 << InDet::TrkOrigin::LambdaDecay);
132  }
133  }
134 
135  // other long living particle decays
136  else if(parent->isHadron() && parent->nChildren() == 2) {
137  origin = origin | (0x1 << InDet::TrkOrigin::OtherDecay);
138  }
139 
140  // hadronic interactions
141  else if(parent->nChildren() > 2) {
142  origin = origin | (0x1 << InDet::TrkOrigin::HadronicInteraction);
143  }
144 
145  // other secondaries
146  else {
147  origin = origin | (0x1 << InDet::TrkOrigin::OtherSecondary);
148  }
149  }
150  }
151 
152  isFragmentation = false;
153  }
154 
155  // uncategorized: call it fragmentation
156  if(isFragmentation) {
157  origin = origin | (0x1 << InDet::TrkOrigin::Fragmentation);
158  }
159 
160  return origin;
161  }

◆ initialize()

StatusCode InDet::InDetTrackTruthOriginTool::initialize ( )
overrideprivatevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 35 of file InDetTrackTruthOriginTool.cxx.

35  {
36  if(m_isFullPileupTruth) ATH_MSG_INFO("InDetTrackTruthOriginTool configured for full pile-up truth sample");
37  return StatusCode::SUCCESS;
38  }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const
overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ isFrom()

bool InDet::InDetTrackTruthOriginTool::isFrom ( const xAOD::TruthParticle truth,
int  flav 
) const
overrideprivatevirtual

Check if a truth particle is from the specified origin (from B or D hadron, or tau)

Implements InDet::IInDetTrackTruthOriginTool.

Definition at line 215 of file InDetTrackTruthOriginTool.cxx.

215  {
216  return isFromRec( truth, flav, 0 );
217  }

◆ isFromRec()

bool InDet::InDetTrackTruthOriginTool::isFromRec ( const xAOD::TruthParticle truth,
int  flav,
int  depth = 0 
) const
privatevirtual

recursion-safe(r) version of isFrom

Definition at line 219 of file InDetTrackTruthOriginTool.cxx.

219  {
220 
221  if ( truth == nullptr ) return false;
222 
223  if ( depth > 30 ) return false;
224 
225  if( flav != 5 && flav != 4 && flav != 15 ) return false;
226 
227  if( flav == 5 && truth->isBottomHadron() ) return true;
228 
229  if( flav == 4 && truth->isCharmHadron() ) return true;
230 
231  if( flav == 15 && abs(truth->pdgId()) == 15 ) return true;
232 
233 
234  for(unsigned int p=0; p<truth->nParents(); p++) {
235  const xAOD::TruthParticle* parent = truth->parent(p);
236  if(parent == truth ) continue ; // avoid infinite recursion
237  if( isFromRec(parent, flav, depth+1) ) return true;
238  }
239 
240  return false;
241  }

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

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

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl) const
inlineinherited

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const
inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns
The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

101  {
102 
103  return MSG::name( msg().level() );
104  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::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< AlgTool > >::outputHandles ( ) const
overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ print() [1/2]

void asg::AsgTool::print ( ) const
virtualinherited

◆ print() [2/2]

virtual void asg::IAsgTool::print ( ) const
pure virtualinherited

◆ renounce()

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

Definition at line 380 of file AthCommonDataStore.h.

381  {
382  h.renounce();
383  PBASE::renounce (h);
384  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364  {
365  handlesArray.renounce();
366  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )
overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

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

Handle START transition.

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

◆ updateVHKA()

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

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_isFullPileupTruth

bool InDet::InDetTrackTruthOriginTool::m_isFullPileupTruth
private

Definition at line 59 of file InDetTrackTruthOriginTool.h.

◆ m_matchingProbabilityCut

float InDet::InDetTrackTruthOriginTool::m_matchingProbabilityCut
private

Definition at line 54 of file InDetTrackTruthOriginTool.h.

◆ m_truthMatchProbabilityAuxName

std::string InDet::InDetTrackTruthOriginTool::m_truthMatchProbabilityAuxName
private

Definition at line 57 of file InDetTrackTruthOriginTool.h.

◆ m_truthParticleLinkName

std::string InDet::InDetTrackTruthOriginTool::m_truthParticleLinkName
private

Definition at line 56 of file InDetTrackTruthOriginTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
privateinherited

Definition at line 398 of file AthCommonDataStore.h.


The documentation for this class was generated from the following files:
InDet::TrkOrigin::StrangeMesonDecay
@ StrangeMesonDecay
Definition: InDetTrackTruthOriginDefs.h:23
python.PyKernel.retrieve
def retrieve(aClass, aKey=None)
Definition: PyKernel.py:110
xAOD::TruthParticle_v1::parent
const TruthParticle_v1 * parent(size_t i=0) const
Retrieve the i-th mother (TruthParticle) of this TruthParticle.
Definition: TruthParticle_v1.cxx:131
egammaParameters::depth
@ depth
pointing depth of the shower as calculated in egammaqgcld
Definition: egammaParamDefs.h:276
InDet::InDetTrackTruthOriginTool::m_truthMatchProbabilityAuxName
std::string m_truthMatchProbabilityAuxName
Definition: InDetTrackTruthOriginTool.h:57
xAOD::TruthParticle_v1::isElectron
bool isElectron() const
Whether the particle is an electron (or positron)
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:392
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
InDet::TrkOrigin::Pileup
@ Pileup
Definition: InDetTrackTruthOriginDefs.h:20
xAOD::TruthParticle_v1::isCharmHadron
bool isCharmHadron() const
Determine if the PID is that of a c-hadron.
InDet::InDetTrackTruthOriginTool::isFromRec
virtual bool isFromRec(const xAOD::TruthParticle *truth, int flav, int depth=0) const
recursion-safe(r) version of isFrom
Definition: InDetTrackTruthOriginTool.cxx:219
AthCommonDataStore::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
InDet::TrkOrigin::Fake
@ Fake
Definition: InDetTrackTruthOriginDefs.h:18
InDet::InDetTrackTruthOriginTool::m_matchingProbabilityCut
float m_matchingProbabilityCut
Definition: InDetTrackTruthOriginTool.h:54
TruthLink
ElementLink< xAOD::TruthParticleContainer > TruthLink
Definition: TruthRelatedMuonPlotOrganizer.cxx:12
InDet::TrkOrigin::TauDecay
@ TauDecay
Definition: InDetTrackTruthOriginDefs.h:26
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
InDet::TrkOrigin::KshortDecay
@ KshortDecay
Definition: InDetTrackTruthOriginDefs.h:22
InDet::TrkOrigin::DHadronDecay
@ DHadronDecay
Definition: InDetTrackTruthOriginDefs.h:33
SG::ConstAccessor
Helper class to provide constant type-safe access to aux data.
Definition: ConstAccessor.h:55
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
dbg::ptr
void * ptr(T *p)
Definition: SGImplSvc.cxx:74
InDet::TrkOrigin::OtherOrigin
@ OtherOrigin
Definition: InDetTrackTruthOriginDefs.h:37
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
IDTPMcnv.htype
htype
Definition: IDTPMcnv.py:29
AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
xAOD::TruthParticle_v1::nParents
size_t nParents() const
Number of parents of this particle.
Definition: TruthParticle_v1.cxx:122
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:210
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
event
POOL::TEvent event(POOL::TEvent::kClassAccess)
HepMC::is_simulation_particle
bool is_simulation_particle(const T &p)
Method to establish if a particle (or barcode) was created during the simulation (TODO update to be s...
Definition: MagicNumbers.h:355
InDet::InDetTrackTruthOriginTool::m_isFullPileupTruth
bool m_isFullPileupTruth
Definition: InDetTrackTruthOriginTool.h:59
InDet::TrkOrigin::BHadronDecay
@ BHadronDecay
Definition: InDetTrackTruthOriginDefs.h:32
DMTest::links
links
Definition: CLinks_v1.cxx:22
xAOD::TruthParticle_v1
Class describing a truth particle in the MC record.
Definition: TruthParticle_v1.h:37
InDet::TrkOrigin::StrangeBaryonDecay
@ StrangeBaryonDecay
Definition: InDetTrackTruthOriginDefs.h:25
test_pyathena.parent
parent
Definition: test_pyathena.py:15
xAOD::TruthEvent_v1
Class describing a signal truth event in the MC record.
Definition: TruthEvent_v1.h:35
python.xAODType.dummy
dummy
Definition: xAODType.py:4
MSG::name
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition: MsgLevel.cxx:19
InDet::TrkOrigin::GammaConversion
@ GammaConversion
Definition: InDetTrackTruthOriginDefs.h:27
InDet::InDetTrackTruthOriginTool::isFrom
virtual bool isFrom(const xAOD::TruthParticle *truth, int flav) const override
Check if a truth particle is from the specified origin (from B or D hadron, or tau)
Definition: InDetTrackTruthOriginTool.cxx:215
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
InDet::TrkOrigin::LambdaDecay
@ LambdaDecay
Definition: InDetTrackTruthOriginDefs.h:24
InDet::TrkOrigin::OtherDecay
@ OtherDecay
Definition: InDetTrackTruthOriginDefs.h:28
DataVector
Derived DataVector<T>.
Definition: DataVector.h:794
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
xAOD::TruthParticle_v1::isBottomHadron
bool isBottomHadron() const
Determine if the PID is that of a b-hadron.
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
InDet::TrkOrigin::Fragmentation
@ Fragmentation
Definition: InDetTrackTruthOriginDefs.h:35
InDet::TrkOrigin::isFragmentation
bool isFragmentation(int origin)
not from B, D, or any secondary
Definition: InDetTrackTruthOriginDefs.h:143
InDet::InDetTrackTruthOriginTool::getTruth
virtual const xAOD::TruthParticle * getTruth(const xAOD::TrackParticle *track) const override
Safely access a track's linked truth particle, if available.
Definition: InDetTrackTruthOriginTool.cxx:40
InDet::TrkOrigin::OtherSecondary
@ OtherSecondary
Definition: InDetTrackTruthOriginDefs.h:30
a
TList * a
Definition: liststreamerinfos.cxx:10
h
xAOD::parentId
@ parentId
Definition: TrackingPrimitives.h:516
AthCommonMsg< AlgTool >::msg
MsgStream & msg() const
Definition: AthCommonMsg.h:24
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:623
InDet::TrkOrigin::HadronicInteraction
@ HadronicInteraction
Definition: InDetTrackTruthOriginDefs.h:29
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:798
xAOD::track
@ track
Definition: TrackingPrimitives.h:512
xAOD::TruthParticle_v1::pdgId
int pdgId() const
PDG ID code.
SG::DataProxy
Definition: DataProxy.h:45
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
fitman.k
k
Definition: fitman.py:528
InDet::InDetTrackTruthOriginTool::getTruthOrigin
virtual int getTruthOrigin(const xAOD::TruthParticle *truth) const override
Computes the truth particle origin.
Definition: InDetTrackTruthOriginTool.cxx:66