Class for vertex truth matching. More...

#include <InDetVertexTruthMatchTool.h>

Inheritance diagram for InDetVertexTruthMatchTool:

Collaboration diagram for InDetVertexTruthMatchTool:

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

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

virtual StatusCode	finalize () override

virtual StatusCode	matchVertices (const xAOD::VertexContainer &vxContainer) const 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
bool	pass (const xAOD::TruthParticle &truthPart) const

bool	pass (const xAOD::TrackParticle &trackPart) 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...

Static Private Member Functions
static const xAOD::TrackParticleContainer *	findTrackParticleContainer (const xAOD::VertexContainer &vxContainer)

Private Attributes
float	m_trkMatchProb

float	m_vxMatchWeight

float	m_trkPtCut

std::atomic< unsigned int >	m_nVtx {}

std::atomic< unsigned int >	m_nVtxWithBadLinks {}

std::atomic< unsigned int >	m_nBadLinks {}

std::atomic< unsigned int >	m_nLinks {}

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 interactions vertices through the chain: track -> particle -> genEvent -> genVertex Categorize reconstructed vertices depending on their composition.

Definition at line 23 of file InDetVertexTruthMatchTool.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

◆ InDetVertexTruthMatchTool()

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

Definition at line 13 of file InDetVertexTruthMatchTool.cxx.

                                                                              : asg::AsgTool(name) {
   declareProperty("trackMatchProb", m_trkMatchProb = 0.5 );
   declareProperty("vertexMatchWeight", m_vxMatchWeight = 0.7 );
   declareProperty("trackPtCut", m_trkPtCut = 500. );
 }

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.

   {
     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

◆ finalize()

StatusCode InDetVertexTruthMatchTool::finalize ( )

overridevirtual

Definition at line 25 of file InDetVertexTruthMatchTool.cxx.

 {
   if (m_nBadLinks>0) {
      ATH_MSG_INFO("Vertex fraction with invalid track particle links: " << std::setw(8) << static_cast<double>(m_nVtxWithBadLinks) / m_nVtx << "; invalid track particle link fraction " << static_cast<double>(m_nBadLinks) / m_nLinks << ".");
   }
   return StatusCode::SUCCESS;
 }

◆ findTrackParticleContainer()

const xAOD::TrackParticleContainer * InDetVertexTruthMatchTool::findTrackParticleContainer ( const xAOD::VertexContainer & vxContainer )

staticprivate

Definition at line 121 of file InDetVertexTruthMatchTool.cxx.

 {
   for (auto vtx : vxContainer)
   {
     for (const ElementLink<xAOD::TrackParticleContainer>& tpLink : vtx->trackParticleLinks())
     {
       if (tpLink.isValid())
       {
         return tpLink.getStorableObjectPointer();
       }
     }
   }
   return nullptr;
 }

◆ 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 InDetVertexTruthMatchTool::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 19 of file InDetVertexTruthMatchTool.cxx.

                                                  {
   ATH_MSG_INFO("Initializing");
  
   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 InDetVertexTruthMatchTool::matchVertices ( const xAOD::VertexContainer & vxContainer ) const

overridevirtual

Implements IInDetVertexTruthMatchTool.

Definition at line 136 of file InDetVertexTruthMatchTool.cxx.

                                                                                                    {
  
   ATH_MSG_DEBUG("Start vertex matching");
   if (vxContainer.empty() ||   // reject empty vertex containers
        (vxContainer.size() == 1 && vxContainer.at(0)->vertexType() == xAOD::VxType::NoVtx)){  // as well as containers containing only a dummy vertex
     ATH_MSG_DEBUG("No vertices to match.");
     return StatusCode::SUCCESS;
   }
   // Identify MC vertices to match to -- this is the collection for hard scatter
   const xAOD::TruthEventBaseContainer * truthEvents = nullptr;
   if ( evtStore()->contains<xAOD::TruthEventBaseContainer>( "TruthEvents" ) )
     ATH_CHECK( evtStore()->retrieve( truthEvents, "TruthEvents" ) );
   else
     ATH_CHECK( evtStore()->retrieve( truthEvents, "TruthEvent" ) );
  
   std::vector<const xAOD::TruthEventBaseContainer *> truthContainers;
   truthContainers.push_back( truthEvents );
  
   ATH_MSG_DEBUG("Found Hard Scatter collection");
  
   // These are the pile-up truth -- don't want to fail if they don't exist
   const xAOD::TruthEventBaseContainer * truthPileup = nullptr;
   if ( evtStore()->contains<xAOD::TruthEventBaseContainer>( "TruthPileupEvents" ) )
     ATH_CHECK( evtStore()->retrieve( truthPileup, "TruthPileupEvents" ) );
   if (truthPileup)
     truthContainers.push_back( truthPileup );
  
   ATH_MSG_DEBUG("Found Pileup collection");
  
   // Find the trackParticle container associated with our reconstructed vertices
   // We could pass this, but it would break the original interface...
   const xAOD::TrackParticleContainer* tkContainer = findTrackParticleContainer(vxContainer);
   if (!tkContainer)
   {
     ATH_MSG_WARNING("Vertex container has no vertices with valid TrackParticle links");
     return StatusCode::SUCCESS;
   }
  
   ATH_MSG_DEBUG("Found track collection");
  
   // create the particle links to events to avoid excessive looping
   // also decorate reconstructed tracks passing selection with truthEvent links
   createTrackTruthMap( truthContainers, *tkContainer, m_trkMatchProb );
  
   // Accessor for the links we just created
   xAOD::TruthParticle::ConstAccessor<ElementLink<xAOD::TruthEventBaseContainer> > backLinkDecor("TruthEventLink");
  
   //setup decorators for truth matching info
   static const xAOD::Vertex::Decorator<std::vector<VertexTruthMatchInfo> > matchInfoDecor("TruthEventMatchingInfos");
   static const xAOD::Vertex::Decorator<std::vector<VertexTruthMatchInfo> > rawMatchInfoDecor("TruthEventRawMatchingInfos");
   static const xAOD::Vertex::Decorator<VertexMatchType> matchTypeDecor("VertexMatchType");
   static const xAOD::Vertex::Decorator<std::vector<ElementLink<xAOD::VertexContainer> > > splitPartnerDecor("SplitPartners");
   static const xAOD::Vertex::Decorator<int> nHSTrkDecor("nHSTrk");
  
   //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");
  
   static const xAOD::TrackParticle::Decorator<ElementLink<xAOD::VertexContainer> > trk_recoVtx("RecoVertex");
   static const xAOD::TrackParticle::Decorator<float> trk_wtVtx("WeightVertex");
  
   //some variables to store
   size_t ntracks;
   xAOD::VxType::VertexType vxType;
  
   ATH_MSG_DEBUG("Starting Loop on Vertices");
  
   //=============================================================================
   //First loop over vertices: get tracks, then TruthParticles, and store relative
   //weights of contribution from each TruthEvent
   //=============================================================================
   size_t vxEntry = 0;
   unsigned int n_bad_links = 0;
   unsigned int n_links = 0;
   unsigned int n_vx_with_bad_links = 0;
  
   for ( auto vxit : vxContainer.stdcont() ) {
     vxEntry++;
     vxType = static_cast<xAOD::VxType::VertexType>( vxit->vertexType() );
     if (vxType == xAOD::VxType::NoVtx) {
       //skip dummy vertices -> match info will be empty vector if someone tries to access later
       //type will be set to dummy
       ATH_MSG_DEBUG("FOUND xAOD::VxType::NoVtx");
       continue;
     }
  
  
     //create the vector we will add as matching info decoration later
     std::vector<VertexTruthMatchInfo> matchinfo;
     std::vector<VertexTruthMatchInfo> rawMatchinfo; //not normalized to one for each reco vertex
  
     //if don't have track particles
     if (!trkAcc.isAvailable(*vxit) || !weightAcc.isAvailable(*vxit) ) {
       ATH_MSG_DEBUG("trackParticles or trackWeights not available, setting fake");
       // Add invalid link for fakes
       matchinfo.emplace_back( ElementLink<xAOD::TruthEventBaseContainer>(), 1., 0. );
       matchInfoDecor( *vxit ) = matchinfo;
       rawMatchinfo.emplace_back( ElementLink<xAOD::TruthEventBaseContainer>(), 1., 0. );
       rawMatchInfoDecor( *vxit ) = rawMatchinfo;
       nHSTrkDecor( *vxit ) = 0;
       continue;
     }
  
     //things we need to do the matching
     const xAOD::Vertex::TrackParticleLinks_t & trkParts = trkAcc( *vxit );
     ntracks = trkParts.size();
     const std::vector<float> & trkWeights = weightAcc( *vxit );
  
     //double check
     if ( trkWeights.size() != ntracks ) {
       ATH_MSG_DEBUG("Vertex without same number of tracks and trackWeights, setting fake");
       matchinfo.emplace_back( ElementLink<xAOD::TruthEventBaseContainer>(), 1., 0. );
       matchInfoDecor( *vxit ) = matchinfo;
       rawMatchinfo.emplace_back( ElementLink<xAOD::TruthEventBaseContainer>(), 1., 0. );
       rawMatchInfoDecor( *vxit ) = rawMatchinfo;
       nHSTrkDecor( *vxit ) = 0;
       continue;
     }
  
     ATH_MSG_DEBUG("Matching new vertex at (" << vxit->x() << ", " << vxit->y() << ", " << vxit->z() << ")" << " with " << ntracks << " tracks, at index: " << vxit->index());
  
     float totalWeight = 0.;
     float totalFake = 0.;
     int nHSTrk = 0;
  
     unsigned vx_n_bad_links = 0;
     //loop element link to track particle
     for ( size_t t = 0; t < ntracks; ++t ) {
       if (!trkParts[t].isValid()) {
          ++vx_n_bad_links;
          continue;
       }
       const xAOD::TrackParticle & trk = **trkParts[t];
  
       totalWeight += trkWeights[t];
       trk_recoVtx(trk) = ElementLink<xAOD::VertexContainer>(vxContainer, vxEntry - 1);
       trk_wtVtx(trk) = trkWeights[t];
  
       const ElementLink<xAOD::TruthParticleContainer> & truthPartLink = trk_truthPartAcc( trk );
       float prob = trk_truthProbAcc( trk );
  
       if (!truthPartLink.isValid()) continue;
  
       if (prob > m_trkMatchProb) {
         const xAOD::TruthParticle & truthPart = **truthPartLink;
         //check if the truth particle is "good"
         if ( pass( truthPart) ) {
           ElementLink<xAOD::TruthEventBaseContainer> match = backLinkDecor( truthPart );
           //check we have an actual link
           if ( match.isValid() ) {
             size_t matchIdx = indexOfMatchInfo( matchinfo, match );
             std::get<1>(matchinfo[matchIdx]) += trkWeights[t];
             std::get<2>(matchinfo[matchIdx]) += (trk.pt()/1000.) * (trk.pt()/1000.) * trkWeights[t];
             matchIdx = indexOfMatchInfo( rawMatchinfo, match );
             std::get<1>(rawMatchinfo[matchIdx]) += trkWeights[t];
             std::get<2>(rawMatchinfo[matchIdx]) += (trk.pt()/1000.) * (trk.pt()/1000.) * trkWeights[t];
             if((*match)->type() == xAOD::Type::TruthEvent && match.index() == 0) nHSTrk++;
           } else {
             totalFake += trkWeights[t];
           }
  
         } else {
           //truth particle failed cuts -> add to fakes
           totalFake += trkWeights[t];
         }
       } else {
         //not valid or low matching probability -> add to fakes
         totalFake += trkWeights[t];
       }
     }//end loop over tracks in vertex
     n_links     += ntracks;
     n_bad_links += vx_n_bad_links;
     if (vx_n_bad_links>0) {
        ++n_vx_with_bad_links;
     }
  
     //finalize the match info vector
     if ( totalWeight < 1e-12 ) { // in case we don't have any passing tracks we want to make sure labeled fake
       ATH_MSG_DEBUG("   Declaring vertex fully fake (no passing tracks included)");
       totalWeight = 1.;
       totalFake = 1.;
     }
     if ( totalFake > 0. )
     {
       matchinfo.emplace_back( ElementLink<xAOD::TruthEventBaseContainer>(), totalFake, 0. );
       rawMatchinfo.emplace_back( ElementLink<xAOD::TruthEventBaseContainer>(), totalFake, 0. );
     }
  
     for ( auto & mit : matchinfo ) {
       std::get<1>(mit) /= totalWeight;
     }
     std::sort( matchinfo.begin(), matchinfo.end(), compareMatchPair );
     std::sort( rawMatchinfo.begin(), rawMatchinfo.end(), compareMatchPair );
     matchInfoDecor( *vxit ) = matchinfo;
     rawMatchInfoDecor( *vxit ) = rawMatchinfo;
     nHSTrkDecor( *vxit ) = nHSTrk;
   }
   m_nVtx             += vxContainer.stdcont().size();
   m_nVtxWithBadLinks += n_vx_with_bad_links;
   m_nBadLinks        += n_bad_links;
   m_nLinks           += n_links;
  
   //After first loop, all vertices have been decorated with their vector of match info (link to TruthEvent 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( vxContainer.size(), false );
  
   for ( size_t i = 0; i < vxContainer.size(); ++i ) {
  
     if ( assignedType[i] ) continue; // make sure we don't reclassify vertices already found in the split loop below
  
     std::vector<VertexTruthMatchInfo> & info = matchInfoDecor( *vxContainer[i] );
     if (info.empty()) {
       matchTypeDecor( *vxContainer[i] ) = DUMMY;
     } else if ( !std::get<0>(info[0]).isValid() ) {
       matchTypeDecor( *vxContainer[i] ) = FAKE;
     } else if ( std::get<1>(info[0]) > m_vxMatchWeight ) {
       matchTypeDecor( *vxContainer[i] ) = MATCHED;
     } else {
       matchTypeDecor( *vxContainer[i] ) = MERGED;
     }
  
     //check for splitting
     if ( matchTypeDecor( *vxContainer[i] ) == MATCHED || matchTypeDecor( *vxContainer[i] ) == MERGED ) {
       std::vector<size_t> foundSplits;
       for ( size_t j = i + 1; j < vxContainer.size(); ++j ) {
         std::vector<VertexTruthMatchInfo> & info2 = matchInfoDecor( *vxContainer[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 (matchTypeDecor( *vxContainer[j] ) == FAKE || matchTypeDecor( *vxContainer[j] ) == DUMMY) 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
           splitPartnerDecor( *vxContainer[i] ).emplace_back( vxContainer, j );
           splitPartnerDecor( *vxContainer[j] ).emplace_back( vxContainer, i );
           //then between any others we found along the way
           for ( auto k : foundSplits ) { //k is a size_t in the vector of splits
             splitPartnerDecor( *vxContainer[k] ).emplace_back( vxContainer, j );
             splitPartnerDecor( *vxContainer[j] ).emplace_back( vxContainer, k );
           }
           //then keep track that we found this one
           foundSplits.push_back(j);
         } //if the two vertices match to same TruthEvent
       }//inner loop over vertices
  
       // Correct labelling of split vertices - keep highest sumpt2 vertex labelled as matched/merged
       float maxSumpT2 = std::get<2>( matchInfoDecor( *vxContainer[i] )[0] );
       size_t indexOfMax = i;
       for ( auto l : foundSplits ) {
         if ( std::get<2>( matchInfoDecor( *vxContainer[l] )[0] ) > maxSumpT2 ){
           maxSumpT2 = std::get<2>( matchInfoDecor( *vxContainer[l] )[0] );
           indexOfMax = l;
         } else {
           matchTypeDecor( *vxContainer[l] ) = SPLIT;
           assignedType[l] = true;
         }
       }
       if ( indexOfMax!=i ) matchTypeDecor( *vxContainer[i] ) = SPLIT;
     } //if matched or merged
   } //outer loop
  
   //DEBUG MATCHING
   if (msgLvl(MSG::DEBUG)) {
     for (const auto &vxit : vxContainer.stdcont() ) {
       ATH_MSG_DEBUG("Matched vertex (index " << (*vxit).index() << ") to type " << matchTypeDecor(*vxit) << " with following info of size " << matchInfoDecor(*vxit).size() << ":");
       for (const auto &vit : matchInfoDecor(*vxit) ) {
         if ( std::get<0>(vit).isValid() ) {
           ATH_MSG_DEBUG("  GenEvent type " << (* std::get<0>(vit))->type() << ", index " << std::get<0>(vit).index() << " with relative weight " << std::get<1>(vit) );
         } else {
           ATH_MSG_DEBUG("  Fakes with relative weight " << std::get<1>(vit) );
         }
       }
       if (matchTypeDecor(*vxit) == SPLIT) {
         ATH_MSG_DEBUG("  Split partners are:");
         for (const auto &split : splitPartnerDecor( *vxit ) ) {
           if ( split.isValid() )
             ATH_MSG_DEBUG("    Vertex " << split.index());
           else
             ATH_MSG_DEBUG("    ERROR");
         }
       }
     }
   }
  
   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.

◆ pass() [1/2]

bool InDetVertexTruthMatchTool::pass ( const xAOD::TrackParticle & trackPart ) const

private

◆ pass() [2/2]

bool InDetVertexTruthMatchTool::pass ( const xAOD::TruthParticle & truthPart ) const

private

Definition at line 435 of file InDetVertexTruthMatchTool.cxx.

                                                                                 {
  
   //remove the registered secondaries
   return truthPart.pt() >= m_trkPtCut;
  
 }

◆ 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, top::TopObjectSelection, 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, top::TopObjectSelection, 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_nBadLinks

std::atomic<unsigned int> InDetVertexTruthMatchTool::m_nBadLinks {}

mutableprivate

Definition at line 51 of file InDetVertexTruthMatchTool.h.

◆ m_nLinks

std::atomic<unsigned int> InDetVertexTruthMatchTool::m_nLinks {}

mutableprivate

Definition at line 52 of file InDetVertexTruthMatchTool.h.

◆ m_nVtx

std::atomic<unsigned int> InDetVertexTruthMatchTool::m_nVtx {}

mutableprivate

Definition at line 49 of file InDetVertexTruthMatchTool.h.

◆ m_nVtxWithBadLinks

std::atomic<unsigned int> InDetVertexTruthMatchTool::m_nVtxWithBadLinks {}

mutableprivate

Definition at line 50 of file InDetVertexTruthMatchTool.h.

◆ m_trkMatchProb

float InDetVertexTruthMatchTool::m_trkMatchProb

private

Definition at line 43 of file InDetVertexTruthMatchTool.h.

◆ m_trkPtCut

float InDetVertexTruthMatchTool::m_trkPtCut

private

Definition at line 47 of file InDetVertexTruthMatchTool.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

float InDetVertexTruthMatchTool::m_vxMatchWeight

private

Definition at line 45 of file InDetVertexTruthMatchTool.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ InDetVertexTruthMatchTool()

Member Function Documentation

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

◆ finalize()

◆ findTrackParticleContainer()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ matchVertices()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ pass() [1/2]

◆ pass() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_nBadLinks

◆ m_nLinks

◆ m_nVtx

◆ m_nVtxWithBadLinks

◆ m_trkMatchProb

◆ m_trkPtCut

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_vxMatchWeight