Class for vertex truth matching. More...

#include <InDetSecVtxTruthMatchTool.h>

Inheritance diagram for InDetSecVtxTruthMatchTool:

Collaboration diagram for InDetSecVtxTruthMatchTool:

Public Member Functions
	InDetSecVtxTruthMatchTool (const std::string &name)

virtual StatusCode	initialize () override final
	Dummy implementation of the initialisation function. More...

virtual StatusCode	matchVertices (std::vector< const xAOD::Vertex * > recoVerticesToMatch, std::vector< const xAOD::TruthVertex * > truthVerticesToMatch, const xAOD::TrackParticleContainer *trackParticles) override

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< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
int	checkProduction (const xAOD::TruthParticle &truthPart, std::vector< const xAOD::TruthVertex * > truthVerticesToMatch) const

void	countReconstructibleDescendentParticles (const xAOD::TruthVertex &signalTruthVertex, std::vector< const xAOD::TruthParticle * > &set, int counter) const

std::vector< int >	checkParticle (const xAOD::TruthParticle &part, const xAOD::TrackParticleContainer *tkCont) const

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
Gaudi::Property< float >	m_trkMatchProb {this, "trackMatchProb", 0.5, "Required MC match probability to consider track a good match" }

Gaudi::Property< float >	m_vxMatchWeight {this, "vertexMatchWeight", 0.5, "Relative weight threshold to consider vertex matched"}

Gaudi::Property< float >	m_trkPtCut {this, "trackPtCut", 1000., "pt cut to apply on tracks"}

Gaudi::Property< std::string >	m_selectedTrackFlag {this, "selectedTrackFlag", "is_selected", "Aux decoration on tracks for seeding efficiencies"}

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

Class for vertex truth matching.

Match reconstructed vertices to truth level decay vertices Categorize reconstructed vertices depending on their composition.

Definition at line 95 of file InDetSecVtxTruthMatchTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ InDetSecVtxTruthMatchTool()

InDetSecVtxTruthMatchTool::InDetSecVtxTruthMatchTool ( const std::string & name )

Definition at line 12 of file InDetSecVtxTruthMatchTool.cxx.

12 : asg::AsgTool(name) {}

Member Function Documentation

◆ checkParticle()

std::vector< int > InDetSecVtxTruthMatchTool::checkParticle	(	const xAOD::TruthParticle &	part,
		const xAOD::TrackParticleContainer *	tkCont
	)		const

private

Definition at line 318 of file InDetSecVtxTruthMatchTool.cxx.

                                                                                                                                            {
  
   xAOD::TrackParticle::ConstAccessor<char>  trackPass(m_selectedTrackFlag);
   xAOD::TrackParticle::ConstAccessor<ElementLink<xAOD::TruthParticleContainer> > trk_truthPartAcc("truthParticleLink");
   xAOD::TrackParticle::ConstAccessor<float> trk_truthProbAcc("truthMatchProbability");
  
   if(truthPart.pt() < m_trkPtCut){
     ATH_MSG_DEBUG("Insufficient pt to reconstruct the particle");
     return {0,0,0};
   }
   else{
  
     for(const xAOD::TrackParticle* trkPart : *trkCont){
       const ElementLink<xAOD::TruthParticleContainer> & truthPartLink = trk_truthPartAcc( *trkPart );
       float matchProb = trk_truthProbAcc( *trkPart );
  
       if(truthPartLink.isValid() && matchProb > m_trkMatchProb) {
         const xAOD::TruthParticle& tmpPart = **truthPartLink;
         if( HepMC::is_same_particle(tmpPart,truthPart) ) {
           if(trackPass.isAvailable( *trkPart )) {
             if(trackPass( *trkPart )) {
               ATH_MSG_DEBUG("Particle has a track that passes track selection.");
               return {1,1,1};
             } else {
               ATH_MSG_DEBUG("Particle has a track, but did not pass track selection.");
               return {1,1,0};
             }
           } else {
             ATH_MSG_DEBUG("Track selection decoration not available, calling the track selected");
             return {1,1,1};
           }
         }
       }
     }
     ATH_MSG_DEBUG("Particle has enough pt.");
     return {1,0,0};
     
   }
   return {0,0,0};
 }

◆ checkProduction()

int InDetSecVtxTruthMatchTool::checkProduction	(	const xAOD::TruthParticle &	truthPart,
		std::vector< const xAOD::TruthVertex * >	truthVerticesToMatch
	)		const

private

Definition at line 360 of file InDetSecVtxTruthMatchTool.cxx.

                                                                                                                                                   {
  
   if (truthPart.nParents() == 0){
     ATH_MSG_DEBUG("Particle has no parents (end of loop)");
     return HepMC::INVALID_VERTEX_ID;
   }
   else{
     const xAOD::TruthParticle * parent = truthPart.parent(0);
     if(not parent) {
       ATH_MSG_DEBUG("Particle parent is null");
       return HepMC::INVALID_VERTEX_ID;
     }
     ATH_MSG_DEBUG("Parent ID: " << parent->pdgId());
  
     const xAOD::TruthVertex* parentVertex = parent->decayVtx();
     if(std::find(truthVerticesToMatch.begin(), truthVerticesToMatch.end(), parentVertex) != truthVerticesToMatch.end()) {
       ATH_MSG_DEBUG("Found LLP decay.");
       return HepMC::barcode(parentVertex); // FIXME barcode-based
     }
     // recurse on parent
     return checkProduction(*parent, truthVerticesToMatch);
   }
   return HepMC::INVALID_VERTEX_ID;
 }

◆ countReconstructibleDescendentParticles()

void InDetSecVtxTruthMatchTool::countReconstructibleDescendentParticles	(	const xAOD::TruthVertex &	signalTruthVertex,
		std::vector< const xAOD::TruthParticle * > &	set,
		int	counter
	)		const

private

Definition at line 385 of file InDetSecVtxTruthMatchTool.cxx.

                                                                                                                                         {
  
   counter++;
  
   for( size_t itrk = 0; itrk < signalTruthVertex.nOutgoingParticles(); itrk++) {
     const auto* particle = signalTruthVertex.outgoingParticle( itrk );
     if( !particle ) continue;
     // Recursively add descendents
     if( particle->hasDecayVtx() ) {
       
       TVector3 decayPos( particle->decayVtx()->x(), particle->decayVtx()->y(), particle->decayVtx()->z() );
       TVector3 prodPos ( particle->prodVtx()->x(),  particle->prodVtx()->y(),  particle->prodVtx()->z()  );
       
       auto isInside  = []( TVector3& v ) { return ( v.Perp() < 300. && std::abs( v.z() ) < 1500. ); };
       auto isOutside = []( TVector3& v ) { return ( v.Perp() > 563. || std::abs( v.z() ) > 2720. ); };
       
       const auto distance = (decayPos - prodPos).Mag();
  
       if (counter > 100) {
         ATH_MSG_WARNING("Vetoing particle that may be added recursively infinitely (potential loop in generator record");
         break;
       }
       
       // consider track reconstructible if it travels at least 10mm
       if( distance < 10.0 ) {
         countReconstructibleDescendentParticles( *particle->decayVtx(), set , counter);
       } else if( isInside ( prodPos  )  && isOutside( decayPos )  && particle->isCharged() ) {
         set.push_back( particle );
       } else if( particle->isElectron() || particle->isMuon() ) {
         set.push_back( particle );
       }
     } else {
       if( !(particle->isCharged()) ) continue;
       set.push_back( particle );
     }
   }
   
   }

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

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

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

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

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

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

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

   {
     return PBASE::declareProperty(t);
   }

◆ 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

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< AlgTool > >::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< 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.

   {
  
     // 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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::declareProperty ( Gaudi::Property< T > & 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.

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

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.

◆ initialize()

StatusCode InDetSecVtxTruthMatchTool::initialize ( )

finaloverridevirtual

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 14 of file InDetSecVtxTruthMatchTool.cxx.

                                                  {
   ATH_MSG_INFO("Initializing InDetSecVtxTruthMatchTool");
  
  
   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.

◆ matchVertices()

StatusCode InDetSecVtxTruthMatchTool::matchVertices	(	std::vector< const xAOD::Vertex * >	recoVerticesToMatch,
		std::vector< const xAOD::TruthVertex * >	truthVerticesToMatch,
		const xAOD::TrackParticleContainer *	trackParticles
	)

overridevirtual

Implements IInDetSecVtxTruthMatchTool.

Definition at line 37 of file InDetSecVtxTruthMatchTool.cxx.

                                                                                                           {
  
   ATH_MSG_DEBUG("Start vertex matching");
  
   //setup decorators for truth matching info
   static const xAOD::Vertex::Decorator<std::vector<VertexTruthMatchInfo> > matchInfoDecor("truthVertexMatchingInfos");
   static const xAOD::Vertex::Decorator<int> recoMatchTypeDecor("vertexMatchType");
   static const xAOD::Vertex::Decorator<std::vector<ElementLink<xAOD::VertexContainer> > > splitPartnerDecor("splitPartners");
  
   const xAOD::Vertex::Decorator<float> fakeScoreDecor("fakeScore");
   const xAOD::Vertex::Decorator<float> otherScoreDecor("otherScore");
  
   //setup accessors
   // can switch to built in method in xAOD::Vertex once don't have to deal with changing names anymore
   xAOD::Vertex::ConstAccessor<xAOD::Vertex::TrackParticleLinks_t> trkAcc("trackParticleLinks");
   xAOD::Vertex::ConstAccessor<std::vector<float> > weightAcc("trackWeights");
  
   xAOD::TrackParticle::ConstAccessor<ElementLink<xAOD::TruthParticleContainer> > trk_truthPartAcc("truthParticleLink");
   xAOD::TrackParticle::ConstAccessor<float> trk_truthProbAcc("truthMatchProbability");
  
   ATH_MSG_DEBUG("Starting Loop on Vertices");
  
   //=============================================================================
   //First loop over vertices: get tracks, then TruthParticles, and store relative
   //weights from each TruthVertex
   //=============================================================================
   for ( const xAOD::Vertex* vtx : recoVerticesToMatch ) {
  
     //create the vector we will add as matching info decoration later
     std::vector<VertexTruthMatchInfo> matchinfo;
  
     const xAOD::Vertex::TrackParticleLinks_t & trkParts = trkAcc( *vtx );
     size_t ntracks = trkParts.size();
     const std::vector<float> & trkWeights = weightAcc( *vtx );
  
     //if don't have track particles
     if (!trkAcc.isAvailable(*vtx) || !weightAcc.isAvailable(*vtx) ) {
       ATH_MSG_WARNING("trackParticles or trackWeights not available, vertex is missing info");
       continue;
     }
     if ( trkWeights.size() != ntracks ) {
       ATH_MSG_WARNING("Vertex without same number of tracks and trackWeights, vertex is missing info");
       continue;
     }
  
     ATH_MSG_DEBUG("Matching new vertex at (" << vtx->x() << ", " << vtx->y() << ", " << vtx->z() << ")" << " with " << ntracks << " tracks, at index: " << vtx->index());
  
     float totalWeight = 0.;
     float totalPt = 0; 
     float otherPt = 0;
     float fakePt = 0;
  
     //loop over the tracks in the vertex
     for ( size_t t = 0; t < ntracks; ++t ) {
  
       ATH_MSG_DEBUG("Checking track number " << t);
  
       if (!trkParts[t].isValid()) {
          ATH_MSG_DEBUG("Track " << t << " is bad!");
          continue;
       }
       const xAOD::TrackParticle & trk = **trkParts[t];
  
       // store the contribution to total weight and pT
       totalWeight += trkWeights[t];
       totalPt += trk.pt();
  
       // get the linked truth particle
       if (!trk_truthPartAcc.isAvailable(trk)) {
         ATH_MSG_DEBUG("The truth particle link decoration isn't available.");
         continue;
       }  
       const ElementLink<xAOD::TruthParticleContainer> & truthPartLink = trk_truthPartAcc( trk );
       float prob = trk_truthProbAcc( trk );
       ATH_MSG_DEBUG("Truth prob: " << prob);
  
       // check the truth particle origin
       if (truthPartLink.isValid()  && prob > m_trkMatchProb) {
         const xAOD::TruthParticle & truthPart = **truthPartLink;
  
         const int ancestorVertexUniqueID =  checkProduction(truthPart, truthVerticesToMatch);
  
         //check if the truth particle is "good"
         if ( ancestorVertexUniqueID != HepMC::INVALID_VERTEX_ID ) {
           //track in vertex is linked to LLP descendant
           //create link to truth vertex and add to matchInfo
           auto it = std::find_if(truthVerticesToMatch.begin(), truthVerticesToMatch.end(),
                                  [&](const auto& ele){ return HepMC::uniqueID(ele) == ancestorVertexUniqueID;} );
  
           if(it == truthVerticesToMatch.end()) {
             ATH_MSG_WARNING("Truth vertex with unique ID " << ancestorVertexUniqueID << " not found!");
           }
           else {
             ElementLink<xAOD::TruthVertexContainer> elLink;
             elLink.setElement(*it); 
             elLink.setStorableObject( *dynamic_cast<const xAOD::TruthVertexContainer*>( (*it)->container()  ) );
             size_t matchIdx = indexOfMatchInfo( matchinfo, elLink );
  
             std::get<1>(matchinfo[matchIdx]) += trkWeights[t];
             std::get<2>(matchinfo[matchIdx]) += trk.pt();
           }
         } else {
           //truth particle failed cuts
           ATH_MSG_DEBUG("Truth particle not from LLP decay.");
           otherPt += trk.pt();
         }
       } else {
         //not valid or low matching probability
         ATH_MSG_DEBUG("Invalid or low prob truth link!");
         fakePt += trk.pt();
       }
     }//end loop over tracks in vertex
  
     // normalize by total weight and pT
     std::for_each( matchinfo.begin(), matchinfo.end(), [&](VertexTruthMatchInfo& link)
     {
       std::get<1>(link) /= totalWeight;
       std::get<2>(link) /= totalPt;
     });
  
     float fakeScore = fakePt/totalPt;
     float otherScore = otherPt/totalPt;
  
     matchInfoDecor ( *vtx ) = matchinfo;
     fakeScoreDecor ( *vtx ) = fakeScore;
     otherScoreDecor( *vtx ) = otherScore;
   }
  
   //After first loop, all vertices have been decorated with their vector of match info (link to TruthVertex paired with weight)
   //now we want to use that information from the whole collection to assign types
   //keep track of whether a type is assigned
   //useful since looking for splits involves a double loop, and then setting types ahead in the collection
   std::vector<bool> assignedType( recoVerticesToMatch.size(), false );
   static const xAOD::TruthVertex::Decorator<bool> isMatched("matchedToRecoVertex");
   static const xAOD::TruthVertex::Decorator<bool> isSplit("vertexSplit");
  
   for ( size_t i = 0; i < recoVerticesToMatch.size(); ++i ) {
  
     int recoVertexMatchType = 0;
  
     if ( assignedType[i] ) {
       ATH_MSG_DEBUG("Vertex already defined as split.");
       continue; // make sure we don't reclassify vertices already found in the split loop below
     }
  
     std::vector<VertexTruthMatchInfo> & info = matchInfoDecor( *recoVerticesToMatch[i] );
     float fakeScore  = fakeScoreDecor( *recoVerticesToMatch[i] );
  
     if(fakeScore > m_vxMatchWeight) {
       ATH_MSG_DEBUG("Vertex is fake.");
       recoVertexMatchType = recoVertexMatchType | (0x1 << InDetSecVtxTruthMatchUtils::Fake);
     } else if (info.size() == 1) {
       if(std::get<2>(info[0]) > m_vxMatchWeight ) { // one truth matched vertex, sufficient weight
         ATH_MSG_DEBUG("One true decay vertices matched with sufficient weight. Vertex is matched.");
         recoVertexMatchType = recoVertexMatchType | (0x1 << InDetSecVtxTruthMatchUtils::Matched);
         isMatched(**std::get<0>(info[0])) = true;
       }
       else {
         ATH_MSG_DEBUG("One true decay vertices matched with insufficient weight. Vertex is other.");
         recoVertexMatchType = recoVertexMatchType | (0x1 << InDetSecVtxTruthMatchUtils::Other);
       }
     } else if (info.size() >= 2 ) {                        // more than one true deacy vertices matched
       ATH_MSG_DEBUG("Multiple true decay vertices matched. Vertex is merged.");
       recoVertexMatchType = recoVertexMatchType | (0x1 << InDetSecVtxTruthMatchUtils::Merged);
       std::for_each( info.begin(), info.end(), [](VertexTruthMatchInfo& link)
       {
         isMatched(**std::get<0>(link)) = true;
       });
     } else {                                // zero truth matched vertices, but not fake 
       ATH_MSG_DEBUG("Vertex is neither fake nor LLP. Marking as OTHER.");
       recoVertexMatchType = recoVertexMatchType | (0x1 << InDetSecVtxTruthMatchUtils::Other);
     }
  
     recoMatchTypeDecor(*recoVerticesToMatch[i]) = recoVertexMatchType;
  
     //check for splitting
     if ( InDetSecVtxTruthMatchUtils::isMatched(recoMatchTypeDecor(*recoVerticesToMatch[i])) || 
          InDetSecVtxTruthMatchUtils::isMerged(recoMatchTypeDecor(*recoVerticesToMatch[i])) ) {
       std::vector<size_t> foundSplits;
       for ( size_t j = i + 1; j < recoVerticesToMatch.size(); ++j ) {
         std::vector<VertexTruthMatchInfo> & info2 = matchInfoDecor( *recoVerticesToMatch[j] );
         //check second vertex is not dummy or fake, and that it has same elementlink as first vertex
         //equality test is in code but doesnt seem to work for ElementLinks that I have?
         //so i am just checking that the contianer key hash and the index are the same
         if (recoMatchTypeDecor( *recoVerticesToMatch[j] ) & (0x1 << InDetSecVtxTruthMatchUtils::Fake)) continue;
         if (!info2.empty() && std::get<0>(info2[0]).isValid() && std::get<0>(info[0]).key() == std::get<0>(info2[0]).key() && std::get<0>(info[0]).index() == std::get<0>(info2[0]).index() ) {
           //add split links; first between first one found and newest one
           ElementLink<xAOD::VertexContainer> splitLink_ij;
           splitLink_ij.setElement( recoVerticesToMatch[j] ); 
           splitLink_ij.setStorableObject( *dynamic_cast<const xAOD::VertexContainer*>(recoVerticesToMatch[j]->container()));
           splitPartnerDecor( *recoVerticesToMatch[i] ).emplace_back(splitLink_ij);
  
           ElementLink<xAOD::VertexContainer> splitLink_ji;
           splitLink_ji.setElement( recoVerticesToMatch[i] ); 
           splitLink_ji.setStorableObject( *dynamic_cast<const xAOD::VertexContainer*>(recoVerticesToMatch[i]->container()));
           splitPartnerDecor( *recoVerticesToMatch[j] ).emplace_back(splitLink_ji);
  
           //then between any others we found along the way
           for ( auto k : foundSplits ) { //k is a size_t in the vector of splits
             ElementLink<xAOD::VertexContainer> splitLink_kj;
             splitLink_kj.setElement( recoVerticesToMatch[j] ); 
             splitLink_kj.setStorableObject( *dynamic_cast<const xAOD::VertexContainer*>(recoVerticesToMatch[j]->container()));
             splitPartnerDecor( *recoVerticesToMatch[k] ).emplace_back(splitLink_kj);
  
             ElementLink<xAOD::VertexContainer> splitLink_jk;
             splitLink_jk.setElement( recoVerticesToMatch[k] );
             splitLink_jk.setStorableObject( *dynamic_cast<const xAOD::VertexContainer*>(recoVerticesToMatch[k]->container()));
             splitPartnerDecor( *recoVerticesToMatch[j] ).emplace_back(splitLink_jk);
           }
           //then keep track that we found this one
           foundSplits.push_back(j);
           recoMatchTypeDecor( *recoVerticesToMatch[i] ) = recoMatchTypeDecor( *recoVerticesToMatch[i] ) | (0x1 << InDetSecVtxTruthMatchUtils::Split);
           recoMatchTypeDecor( *recoVerticesToMatch[j] ) = recoMatchTypeDecor( *recoVerticesToMatch[j] ) | (0x1 << InDetSecVtxTruthMatchUtils::Split);
           isSplit(**std::get<0>(info[0])) = true;
           assignedType[j] = true;
         } //if the two vertices match to same TruthVertex
       }//inner loop over vertices
     } //if matched or merged
  
   } //outer loop
  
   // now label truth vertices
  
   ATH_MSG_DEBUG("Labeling truth vertices");
  
   static const xAOD::TruthVertex::Decorator<int> truthMatchTypeDecor("truthVertexMatchType");
  
   for(const xAOD::TruthVertex* truthVtx : truthVerticesToMatch) {
  
     std::vector<const xAOD::TruthParticle*> reconstructibleParticles;
     int counter = 0;
     countReconstructibleDescendentParticles( *truthVtx, reconstructibleParticles, counter );
  
     // hacky solution for keeping track of particles in the vertex
     std::vector<int> particleInfo = {0,0,0};
     std::vector<int> vertexInfo = {0,0,0};
  
     for(size_t n = 0; n < reconstructibleParticles.size(); n++){
       ATH_MSG_DEBUG("Checking daughter no. " << n);
       const xAOD::TruthParticle* outPart = reconstructibleParticles.at(n);
       
       if (trackParticles){
         particleInfo = checkParticle(*outPart, trackParticles);
       
         for(size_t h = 0; h < particleInfo.size(); h++){
           vertexInfo.at(h) += particleInfo.at(h);
         }
       }
     }
       
     int truthMatchType = 0;
     if( vertexInfo.at(0) > 1 &&  truthVtx->perp() <  320 && abs(truthVtx->z()) < 1500){
       ATH_MSG_DEBUG("Vertex is reconstructable and in Inner Det region");
       truthMatchType = truthMatchType | (0x1 << InDetSecVtxTruthMatchUtils::Reconstructable);
     }
     if( InDetSecVtxTruthMatchUtils::isReconstructable(truthMatchType) and vertexInfo.at(1) > 1){
       ATH_MSG_DEBUG("Vertex has at least two tracks");
       truthMatchType = truthMatchType | (0x1 << InDetSecVtxTruthMatchUtils::Accepted);
     }
     if(InDetSecVtxTruthMatchUtils::isAccepted(truthMatchType) and vertexInfo.at(2) > 1){
       ATH_MSG_DEBUG("Vertex is has at least two tracks passing track selection: " << vertexInfo.at(2));
       truthMatchType = truthMatchType | (0x1 << InDetSecVtxTruthMatchUtils::Seeded);
     }
     if(InDetSecVtxTruthMatchUtils::isSeeded(truthMatchType) and isMatched(*truthVtx)){
       ATH_MSG_DEBUG("Vertex is matched to a reconstructed secVtx");
       truthMatchType = truthMatchType | (0x1 << InDetSecVtxTruthMatchUtils::Reconstructed);
     }
     if(InDetSecVtxTruthMatchUtils::isSeeded(truthMatchType) and isSplit(*truthVtx)){
       ATH_MSG_DEBUG("Vertex is matched to multiple secVtx");
       truthMatchType = truthMatchType | (0x1 << InDetSecVtxTruthMatchUtils::ReconstructedSplit);
     }
     truthMatchTypeDecor(*truthVtx) = truthMatchType;
   }
   ATH_MSG_DEBUG("Done labeling truth vertices");
  
   return StatusCode::SUCCESS;
  
 }

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

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

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

◆ print() [2/2]

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

pure virtualinherited

Print the state of the tool.

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

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

                                                {
     // 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< 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_selectedTrackFlag

Gaudi::Property<std::string> InDetSecVtxTruthMatchTool::m_selectedTrackFlag {this, "selectedTrackFlag", "is_selected", "Aux decoration on tracks for seeding efficiencies"}

private

Definition at line 114 of file InDetSecVtxTruthMatchTool.h.

◆ m_trkMatchProb

Gaudi::Property<float> InDetSecVtxTruthMatchTool::m_trkMatchProb {this, "trackMatchProb", 0.5, "Required MC match probability to consider track a good match" }

private

Definition at line 111 of file InDetSecVtxTruthMatchTool.h.

◆ m_trkPtCut

Gaudi::Property<float> InDetSecVtxTruthMatchTool::m_trkPtCut {this, "trackPtCut", 1000., "pt cut to apply on tracks"}

private

Definition at line 113 of file InDetSecVtxTruthMatchTool.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.

◆ m_vxMatchWeight

Gaudi::Property<float> InDetSecVtxTruthMatchTool::m_vxMatchWeight {this, "vertexMatchWeight", 0.5, "Relative weight threshold to consider vertex matched"}

private

Definition at line 112 of file InDetSecVtxTruthMatchTool.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

Constructor & Destructor Documentation

◆ InDetSecVtxTruthMatchTool()

Member Function Documentation

◆ checkParticle()

◆ checkProduction()

◆ countReconstructibleDescendentParticles()

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

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ matchVertices()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_selectedTrackFlag

◆ m_trkMatchProb

◆ m_trkPtCut

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_vxMatchWeight