InDet::InDetTrackTruthOriginTool Class Reference

This class determines the truth origin of a track. More...

#include <InDetTrackTruthOriginTool.h>

Inheritance diagram for InDet::InDetTrackTruthOriginTool:

Collaboration diagram for InDet::InDetTrackTruthOriginTool:

Public Member Functions
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
virtual ASG_TOOL_CLASS2(InDetTrackTruthOriginTool, asg::IAsgTool, InDet::IInDetTrackTruthOriginTool) public	~InDetTrackTruthOriginTool ()
virtual StatusCode	initialize () override
virtual const xAOD::TruthParticle *	getTruth (const xAOD::TrackParticle *track) const override
	Safely access a track's linked truth particle, if available.
virtual int	getTruthOrigin (const xAOD::TruthParticle *truth) const override
	Computes the truth particle origin.
virtual int	getTrackOrigin (const xAOD::TrackParticle *track) const override
	Computes the track origin.
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)
virtual bool	isFromRec (const xAOD::TruthParticle *truth, int flav, int depth=0) const
	recursion-safe(r) version of isFrom
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

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)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
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()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

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

getKey()

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

inherited

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

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

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

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

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

getName()

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

inherited

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

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

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

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

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

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

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.

                                                                                    {
 
    // get truth particle
    const xAOD::TruthParticle* truth = getTruth( track );
 
    // get track TMP
    static const SG::AuxElement::ConstAccessor< float > tmpAcc( m_truthMatchProbabilityAuxName.data() );
    float truthProb = tmpAcc( *track );
 
    int origin = 0;
 
    // truth link is broken: call it from pileup (not true for < 100 MeV and some specialised samples!)
    if (!truth){
      origin = origin | (0x1 << InDet::TrkOrigin::Pileup);
    }
    
    // For full pile-up truth samples, check explicitly if truth record is present among hard-scatter collection to assign Pileup origin
    else if(m_isFullPileupTruth){
      const xAOD::TruthEventContainer* truthEventContainer(nullptr);
      if(evtStore()->retrieve(truthEventContainer, "TruthEvents").isFailure()){
        ATH_MSG_ERROR("InDetTrackTruthOriginTool configured for full pile-up truth but could not retrieve TruthEvents container");
      }
      const xAOD::TruthEvent* event = truthEventContainer ? truthEventContainer->at(0) : nullptr;
 
      if(event){
        const auto& links = event->truthParticleLinks();
 
        bool isFromHSProdVtx = false;
        for (const auto& link : links){
          if(link.isValid() && truth == *link){
            isFromHSProdVtx = true;
            break;
          }
        }
 
        if(!isFromHSProdVtx) origin = origin | (0x1 << InDet::TrkOrigin::Pileup);
      }
    }
 
    // low TruthMatchProbability: call it fake (also includes poorly reconstructed tracks)
    if(truthProb < m_matchingProbabilityCut) {
      origin = origin | (0x1 << InDet::TrkOrigin::Fake);
    }
 
    // truth link is present: find truth origin
    if (truth) {
      origin = origin | getTruthOrigin(truth);
    }
 
    return origin;
  }

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.

                                                                                                     {
 
      // if the track doesnt't have a valid truth link, skip to the next track
      // in practice, all tracks seem to have a truth link, but we need to also
      // check whether it's valid
      typedef ElementLink<xAOD::TruthParticleContainer> TruthLink;
      static const SG::ConstAccessor<TruthLink>
        truthParticleLinkAcc ("truthParticleLink");
      if ( !truthParticleLinkAcc.isAvailable(*track) ) { 
        return nullptr;
      }
 
      // retrieve the link and check its validity
      const TruthLink &link = truthParticleLinkAcc(*track);
 
      // a missing or invalid link implies truth particle has been dropped from 
      // the truth record at some stage - probably it was from pilup which by
      // default we don't store truth information for
      if(!link or !link.isValid()) {
        return nullptr;
      }
 
      // seems safe to access and return the linked truth particle
      return *link;
  }

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.

                                                                                    {
 
    int origin = 0;
 
    // is it fragmentation? yes until proven otherwise
    bool isFragmentation = true;
 
    // from B decay chain?
    if(isFrom(truth, MC::BQUARK)) {
      origin = origin | (0x1 << InDet::TrkOrigin::BHadronDecay);
      isFragmentation = false;
    }
 
    // from D decay chain?
    if(isFrom(truth, MC::CQUARK)) {
      origin = origin | (0x1 << InDet::TrkOrigin::DHadronDecay);
      isFragmentation = false;
    }
 
    // from tau decay chain?
    if(isFrom(truth, MC::TAU)) {
      origin = origin | (0x1 << InDet::TrkOrigin::TauDecay);
      isFragmentation = false;
    }
 
    // Secondary? 
    if (HepMC::is_simulation_particle(truth)) {
 
      // unknown origin (e.g. parent not in the record)
      if(truth->nParents() != 1) {
        origin = origin | (0x1 << InDet::TrkOrigin::OtherOrigin);
      }
 
      else {
        const xAOD::TruthParticle *parent = truth->parent(0);
 
        if(parent == nullptr) {
          origin = origin | (0x1 << InDet::TrkOrigin::OtherOrigin);
        }
        
        // sub-categorize secondaries which have one valid parent
        else {
 
          int pdgId = truth->pdgId();
          int parentId = parent->pdgId();
 
          // photon conversion
          if(parent->isPhoton() && truth->isElectron()) {
            origin = origin | (0x1 << InDet::TrkOrigin::GammaConversion);
          }
 
          // Strange Mesons
          else if(parent->isStrangeMeson() && parent->nChildren() == 2) {
            origin = origin | (0x1 << InDet::TrkOrigin::StrangeMesonDecay);
            // specifically Kshort
            if (abs(pdgId) == 211 && parentId == 310) {
              origin = origin | (0x1 << InDet::TrkOrigin::KshortDecay);
            }
          }
 
          // Strange Baryons
          else if(parent->isStrangeBaryon() && parent->nChildren() == 2) {
            origin = origin | (0x1 << InDet::TrkOrigin::StrangeBaryonDecay);
            // specifically Lambdas
            if ((abs(pdgId) == MC::PIPLUS || abs(pdgId) == MC::PROTON) && abs(parentId) == MC::LAMBDA0) {
              origin = origin | (0x1 << InDet::TrkOrigin::LambdaDecay);
            }
          }
 
          // other long living particle decays
          else if(parent->isHadron() && parent->nChildren() == 2) {
            origin = origin | (0x1 << InDet::TrkOrigin::OtherDecay);
          }
 
          // hadronic interactions
          else if(parent->nChildren() > 2) {
            origin = origin | (0x1 << InDet::TrkOrigin::HadronicInteraction);
          }
 
          // other secondaries
          else {
            origin = origin | (0x1 << InDet::TrkOrigin::OtherSecondary);
          }
        }
      }
 
      isFragmentation = false;
    }
 
    // uncategorized: call it fragmentation
    if(isFragmentation) {
      origin = origin | (0x1 << InDet::TrkOrigin::Fragmentation);
    }
 
    return origin;
  }

initialize()

StatusCode InDet::InDetTrackTruthOriginTool::initialize ( void )

overrideprivatevirtual

Implements InDet::IInDetTrackTruthOriginTool.

Definition at line 35 of file InDetTrackTruthOriginTool.cxx.

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

inputHandles()

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

overridevirtualinherited

Return this algorithm's input handles.

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

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.

                                                                                       {
    return isFromRec( truth, flav, 0 );
  }

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.

                                                                                                     {
 
    if ( truth == nullptr ) return false;
 
    if ( depth > 30 ) return false;
 
    if( flav != MC::BQUARK && flav != MC::CQUARK && flav != MC::TAU ) return false;
 
    if( flav == MC::BQUARK && truth->isBottomHadron() ) return true;
 
    if( flav == MC::CQUARK && truth->isCharmHadron() ) return true;
 
    if( flav == MC::TAU && MC::isTau(truth) ) return true;
 
 
    for(unsigned int p=0; p<truth->nParents(); p++) {
      const xAOD::TruthParticle* parent = truth->parent(p);
      if(parent == truth ) continue ; // avoid infinite recursion
      if( isFromRec(parent, flav, depth+1) ) return true;
    }
 
    return false;
  }

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

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

inherited

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

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

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

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

Returns

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

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

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

sysStart()

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

overridevirtualinherited

Handle START transition.

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

updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

~InDetTrackTruthOriginTool()

InDet::InDetTrackTruthOriginTool::~InDetTrackTruthOriginTool ( )

privatevirtualdefault

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:

• InDetTrackTruthOriginTool.h
• InDetTrackTruthOriginTool.cxx