#include <MVATrackVertexAssociationTool.h>

Inheritance diagram for CP::MVATrackVertexAssociationTool:

Collaboration diagram for CP::MVATrackVertexAssociationTool:

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

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

virtual bool	isCompatible (const xAOD::TrackParticle &trk, const xAOD::Vertex &vx) const override
	This function just return the decision of whether the track is matched to the Vertex Not sure whether the track is matched to best choice. More...

virtual bool	isCompatible (const xAOD::TrackParticle &trk) const override

virtual xAOD::TrackVertexAssociationMap	getMatchMap (std::vector< const xAOD::TrackParticle * > &trk_list, std::vector< const xAOD::Vertex * > &vx_list) const override

virtual xAOD::TrackVertexAssociationMap	getMatchMap (const xAOD::TrackParticleContainer &trk_cont, const xAOD::VertexContainer &vx_cont) const override

virtual ElementLink< xAOD::VertexContainer >	getUniqueMatchVertexLink (const xAOD::TrackParticle &trk, const xAOD::VertexContainer &vx_cont) const override
	This functions will return the best matched vertex. More...

virtual const xAOD::Vertex *	getUniqueMatchVertex (const xAOD::TrackParticle &trk, std::vector< const xAOD::Vertex * > &vx_list) const override

virtual xAOD::TrackVertexAssociationMap	getUniqueMatchMap (std::vector< const xAOD::TrackParticle * > &trk_list, std::vector< const xAOD::Vertex * > &vx_list) const override
	This functions related to the previous functions, will return a 2D vector to store the best matched tracks for each vertex. More...

virtual xAOD::TrackVertexAssociationMap	getUniqueMatchMap (const xAOD::TrackParticleContainer &trk_cont, const xAOD::VertexContainer &vx_cont) const override

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	isMatch (const xAOD::TrackParticle &trk, const xAOD::Vertex &vx, float &mvaOutput, const xAOD::EventInfo *evtInfo=nullptr) const

template<typename T , typename V >
xAOD::TrackVertexAssociationMap	getMatchMapInternal (const T &trk_list, const V &vx_list) const

template<typename T , typename V >
xAOD::TrackVertexAssociationMap	getUniqueMatchMapInternal (const T &trk_list, const V &vx_list) const

template<typename T >
const xAOD::Vertex *	getUniqueMatchVertexInternal (const xAOD::TrackParticle &trk, const T &vx_list) const

StatusCode	initializeNetwork ()

float	evaluateNetwork (const xAOD::TrackParticle &trk, const xAOD::Vertex &vx, const xAOD::EventInfo &evt) 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
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

The properties that can be defined via the python job options
Gaudi::Property< std::string >	m_fileName {this, "NetworkFileName", "" }
	Input lwtnn network file. More...

Gaudi::Property< std::vector< std::string > >	m_inputNames
	Vector of input variable names. More...

Gaudi::Property< std::vector< int > >	m_inputTypes
	Vector of input variable types. More...

Gaudi::Property< std::string >	m_outputName
	Name of the output node to cut on. More...

Gaudi::Property< bool >	m_isSequential
	Is the network sequential or functional. More...

Gaudi::Property< std::string >	m_wp {this, "WorkingPoint", "Tight", "TVA working point to apply."}
	TVA working point. More...

Gaudi::Property< float >	m_cut
	TVA cut value on the output discriminant. More...

Gaudi::Property< bool >	m_usePathResolver
	Use the PathResolver to find our input file. More...

Gaudi::Property< std::string >	m_hardScatterDeco
	The decoration name of the ElementLink to the hardscatter vertex (found on xAOD::EventInfo) More...

Truly private internal data members
MVAInputEvaluator::InputSelectionMap	m_inputMap
	Input variable name/type map. More...

MVAInputEvaluator	m_inputEval
	Input variable evaluator. More...

SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfo {this, "EventInfo", "EventInfo", "EventInfo key"}
	EventInfo key. More...

SG::ReadDecorHandleKey< xAOD::EventInfo >	m_hardScatterDecoKey
	Hardscatter vertex link key. More...

std::string	m_inputNodeName = ""
	Name of the input node (for functional modes) More...

std::unique_ptr< lwt::LightweightNeuralNetwork >	m_network
	Network as implemented using lwtnn. More...

std::unique_ptr< lwt::LightweightGraph >	m_graph

Detailed Description

Definition at line 36 of file MVATrackVertexAssociationTool.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

◆ MVATrackVertexAssociationTool()

CP::MVATrackVertexAssociationTool::MVATrackVertexAssociationTool ( const std::string & name )

Definition at line 36 of file MVATrackVertexAssociationTool.cxx.

36 :

37 AsgTool(name) {}

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; }

◆ evaluateNetwork()

float CP::MVATrackVertexAssociationTool::evaluateNetwork	(	const xAOD::TrackParticle &	trk,
		const xAOD::Vertex &	vx,
		const xAOD::EventInfo &	evt
	)		const

private

Definition at line 276 of file MVATrackVertexAssociationTool.cxx.

                                                                                                                                        {
  
   // Evaluate our inputs
   std::map<std::string, double> input;
   m_inputEval.eval(trk, vx, evt, input);
  
   // Evaluate our network
   std::map<std::string, double> output;
   // For sequential:
   if (m_isSequential) {
     output = m_network->compute(input);
   }
   // For functional:
   else {
     std::map<std::string, std::map<std::string, double>> wrappedInput;
     wrappedInput[m_inputNodeName] = input;
     output = m_graph->compute(wrappedInput);
   }
  
   return output[m_outputName];
 }

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

◆ getMatchMap() [1/2]

xAOD::TrackVertexAssociationMap CP::MVATrackVertexAssociationTool::getMatchMap	(	const xAOD::TrackParticleContainer &	trk_cont,
		const xAOD::VertexContainer &	vx_cont
	)		const

overridevirtual

Implements CP::ITrackVertexAssociationTool.

Definition at line 101 of file MVATrackVertexAssociationTool.cxx.

                                                                                                                                                            {
   return getMatchMapInternal(trkCont, vxCont);
 }

◆ getMatchMap() [2/2]

xAOD::TrackVertexAssociationMap CP::MVATrackVertexAssociationTool::getMatchMap	(	std::vector< const xAOD::TrackParticle * > &	trk_list,
		std::vector< const xAOD::Vertex * > &	vx_list
	)		const

overridevirtual

Implements CP::ITrackVertexAssociationTool.

Definition at line 97 of file MVATrackVertexAssociationTool.cxx.

                                                                                                                                                                    {
   return getMatchMapInternal(trk_list, vx_list);
 }

◆ getMatchMapInternal()

template<typename T , typename V >

xAOD::TrackVertexAssociationMap CP::MVATrackVertexAssociationTool::getMatchMapInternal	(	const T &	trk_list,
		const V &	vx_list
	)		const

private

Definition at line 158 of file MVATrackVertexAssociationTool.cxx.

                                                                                                                           {
  
   xAOD::TrackVertexAssociationMap trktovxmap;
  
   for (const auto *vertex : vx_list) {
     xAOD::TrackVertexAssociationList trktovxlist;
     trktovxlist.clear();
     trktovxlist.reserve(trk_list.size());
     for (const auto *track : trk_list) {
       if (isCompatible(*track, *vertex)) {
         trktovxlist.push_back(track);
       }
     }
     trktovxmap[vertex] = trktovxlist;
   }
  
   return trktovxmap;
 }

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

◆ getUniqueMatchMap() [1/2]

xAOD::TrackVertexAssociationMap CP::MVATrackVertexAssociationTool::getUniqueMatchMap	(	const xAOD::TrackParticleContainer &	trk_cont,
		const xAOD::VertexContainer &	vx_cont
	)		const

overridevirtual

Implements CP::ITrackVertexAssociationTool.

Definition at line 122 of file MVATrackVertexAssociationTool.cxx.

                                                                                                                                                                  {
   return getUniqueMatchMapInternal(trkCont, vxCont);
 }

◆ getUniqueMatchMap() [2/2]

xAOD::TrackVertexAssociationMap CP::MVATrackVertexAssociationTool::getUniqueMatchMap	(	std::vector< const xAOD::TrackParticle * > &	trk_list,
		std::vector< const xAOD::Vertex * > &	vx_list
	)		const

overridevirtual

This functions related to the previous functions, will return a 2D vector to store the best matched tracks for each vertex.

Implements CP::ITrackVertexAssociationTool.

Definition at line 118 of file MVATrackVertexAssociationTool.cxx.

                                                                                                                                                                          {
   return getUniqueMatchMapInternal(trk_list, vx_list);
 }

◆ getUniqueMatchMapInternal()

template<typename T , typename V >

xAOD::TrackVertexAssociationMap CP::MVATrackVertexAssociationTool::getUniqueMatchMapInternal	(	const T &	trk_list,
		const V &	vx_list
	)		const

private

Definition at line 202 of file MVATrackVertexAssociationTool.cxx.

                                                                                                                                 {
  
   xAOD::TrackVertexAssociationMap trktovxmap;
  
   // Initialize map
   for (const auto *vertex : vx_list) {
     xAOD::TrackVertexAssociationList trktovxlist;
     trktovxlist.clear();
     trktovxlist.reserve(trk_list.size());
     trktovxmap[vertex] = trktovxlist;
   }
  
   // Perform matching
   for (const auto *track : trk_list) {
     const xAOD::Vertex* vx_match = getUniqueMatchVertexInternal(*track, vx_list);
     if (vx_match) {
       // Found matched vertex
       trktovxmap[vx_match].push_back(track);
     }
   }
  
   return trktovxmap;
 }

◆ getUniqueMatchVertex()

const xAOD::Vertex * CP::MVATrackVertexAssociationTool::getUniqueMatchVertex	(	const xAOD::TrackParticle &	trk,
		std::vector< const xAOD::Vertex * > &	vx_list
	)		const

overridevirtual

Implements CP::ITrackVertexAssociationTool.

Definition at line 105 of file MVATrackVertexAssociationTool.cxx.

                                                                                                                                                {
   return getUniqueMatchVertexInternal(trk, vx_list);
 }

◆ getUniqueMatchVertexInternal()

template<typename T >

const xAOD::Vertex * CP::MVATrackVertexAssociationTool::getUniqueMatchVertexInternal	(	const xAOD::TrackParticle &	trk,
		const T &	vx_list
	)		const

private

Definition at line 178 of file MVATrackVertexAssociationTool.cxx.

                                                                                                                                   {
  
   bool match;
   float mvaOutput;
   float maxValue = -1.0; // MVA output ranges between 0 and 1
   const xAOD::Vertex* bestMatchVertex = nullptr;
  
   for (const auto *vertex : vx_list) {
     match = isMatch(trk, *vertex, mvaOutput);
     if (match && (maxValue < mvaOutput)) {
       maxValue = mvaOutput;
       bestMatchVertex = vertex;
     }
   }
  
   // check if get the matched Vertex, for the tracks not used in vertex fit
   if (!bestMatchVertex) {
     ATH_MSG_DEBUG("Could not find any matched vertex for this track.");
   }
  
   return bestMatchVertex;
 }

◆ getUniqueMatchVertexLink()

ElementLink< xAOD::VertexContainer > CP::MVATrackVertexAssociationTool::getUniqueMatchVertexLink	(	const xAOD::TrackParticle &	trk,
		const xAOD::VertexContainer &	vxCont
	)		const

overridevirtual

This functions will return the best matched vertex.

Implements CP::ITrackVertexAssociationTool.

Definition at line 109 of file MVATrackVertexAssociationTool.cxx.

                                                                                                                                                               {
   ElementLink<xAOD::VertexContainer> vx_link_tmp;
   const xAOD::Vertex* vx_tmp = getUniqueMatchVertexInternal(trk, vxCont);
   if (vx_tmp) {
     vx_link_tmp.toContainedElement(vxCont, vx_tmp);
   }
   return vx_link_tmp;
 }

◆ initialize()

StatusCode CP::MVATrackVertexAssociationTool::initialize ( )

overridevirtual

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 39 of file MVATrackVertexAssociationTool.cxx.

                                                      {
  
   // Init EventInfo and hardscatter vertex link deco
   ATH_CHECK(m_eventInfo.initialize());
   m_hardScatterDecoKey = m_eventInfo.key() +"." + m_hardScatterDeco;
   ATH_CHECK(m_hardScatterDecoKey.initialize());
  
   // Init network
   StatusCode initNetworkStatus = initializeNetwork();
   if (initNetworkStatus != StatusCode::SUCCESS) {
     return initNetworkStatus;
   }
  
   // Map our working point to a cut on the MVA output discriminant
   if (m_wp == "Tight") {
     m_cut = 0.85;
   }
   else if (m_wp == "Custom") {
     // Nothing to do here
   }
   else {
     ATH_MSG_ERROR("Invalid TVA working point \"" << m_wp << "\" - for a custom configuration, please provide \"Custom\" for the \"WorkingPoint\" property.");
     return StatusCode::FAILURE;
   }
  
   // Some extra printout for Custom
   if (m_wp == "Custom") {
     ATH_MSG_INFO("TVA working point \"Custom\" provided - tool properties are initialized to default values unless explicitly set by the user.");
   }
   else {
     ATH_MSG_INFO("TVA working point \"" << m_wp << "\" provided - tool properties have been configured accordingly.");
   }
  
   ATH_MSG_DEBUG("Cut on MVA output discriminant: " << m_cut);
  
   return StatusCode::SUCCESS;
 }

◆ initializeNetwork()

StatusCode CP::MVATrackVertexAssociationTool::initializeNetwork ( )

private

Definition at line 226 of file MVATrackVertexAssociationTool.cxx.

                                                             {
  
   // Load our input evaluator
   if (m_inputNames.size() != m_inputTypes.size()) {
     ATH_MSG_ERROR("Size of input variable names (" + std::to_string(m_inputNames.size()) + ") does not equal size of input variable types (" + std::to_string(m_inputTypes.size()) + ").");
     return StatusCode::FAILURE;
   }
   m_inputMap.clear();
   for (std::size_t i = 0; i < m_inputNames.size(); i++) {
     m_inputMap[m_inputNames[i]] = static_cast<MVAInputEvaluator::Input>(m_inputTypes[i]);
   }
   m_inputEval.load(m_inputMap);
  
   // Load our input file
   std::string fileName; 
   if (m_usePathResolver) {
     fileName = PathResolverFindCalibFile(m_fileName);
     if (fileName.empty()) {
       ATH_MSG_ERROR("Could not find input network file: " + m_fileName);
       return StatusCode::FAILURE;
     }
   }
   else {
     fileName = m_fileName;
   }
   std::ifstream netFile(fileName);
   if (!netFile) {
     ATH_MSG_ERROR("Could not properly open input network file: " + fileName);
     return StatusCode::FAILURE;
   }
  
   // For sequential:
   if (m_isSequential) {
     lwt::JSONConfig netDef = lwt::parse_json(netFile);
     m_network = std::make_unique<lwt::LightweightNeuralNetwork>(netDef.inputs, netDef.layers, netDef.outputs);
   }
   // For functional:
   else {
     lwt::GraphConfig netDef = lwt::parse_json_graph(netFile);
     if (netDef.inputs.size() != 1) {
       ATH_MSG_ERROR("Network in file \"" + fileName + "\" has more than 1 input node: # of input nodes = " + std::to_string(netDef.inputs.size()));
       return StatusCode::FAILURE;
     }
     m_inputNodeName = netDef.inputs[0].name;
     m_graph = std::make_unique<lwt::LightweightGraph>(netDef);
   }
  
   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.

◆ isCompatible() [1/2]

bool CP::MVATrackVertexAssociationTool::isCompatible ( const xAOD::TrackParticle & trk ) const

overridevirtual

Implements CP::ITrackVertexAssociationTool.

Definition at line 82 of file MVATrackVertexAssociationTool.cxx.

                                                                                    {
   const EventContext& ctx = Gaudi::Hive::currentContext();
   SG::ReadHandle<xAOD::EventInfo> evt(m_eventInfo, ctx);
   if (!evt.isValid()) {
     throw std::runtime_error("ERROR in CP::MVATrackVertexAssociationTool::isCompatible : could not retrieve xAOD::EventInfo!");
   }
   SG::ReadDecorHandle<xAOD::EventInfo, ElementLink<xAOD::VertexContainer>> hardScatterDeco(m_hardScatterDecoKey, ctx);
   const ElementLink<xAOD::VertexContainer>& vtxLink = hardScatterDeco(*evt);
   if (!vtxLink.isValid()) {
     throw std::runtime_error("ERROR in CP::MVATrackVertexAssociationTool::isCompatible : hardscatter vertex link is not valid!");
   }
   float mvaOutput = -1.;
   return isMatch(trk, **vtxLink, mvaOutput, evt.get());
 }

◆ isCompatible() [2/2]

bool CP::MVATrackVertexAssociationTool::isCompatible	(	const xAOD::TrackParticle &	trk,
		const xAOD::Vertex &	vx
	)		const

overridevirtual

This function just return the decision of whether the track is matched to the Vertex Not sure whether the track is matched to best choice.

Implements CP::ITrackVertexAssociationTool.

Definition at line 77 of file MVATrackVertexAssociationTool.cxx.

                                                                                                          {
   float mvaOutput = -1.;
   return isMatch(trk, vx, mvaOutput);
 }

◆ isMatch()

bool CP::MVATrackVertexAssociationTool::isMatch	(	const xAOD::TrackParticle &	trk,
		const xAOD::Vertex &	vx,
		float &	mvaOutput,
		const xAOD::EventInfo *	evtInfo = `nullptr`
	)		const

private

Definition at line 130 of file MVATrackVertexAssociationTool.cxx.

                                                                                                                                                     {
  
   const EventContext& ctx = Gaudi::Hive::currentContext();
  
   // Fake vertex, return false
   if (vx.vertexType() == xAOD::VxType::NoVtx) {
     return false;
   }
  
   // Retrieve our EventInfo
   const xAOD::EventInfo* evt = nullptr;
   if (!evtInfo) {
     SG::ReadHandle<xAOD::EventInfo> evttmp(m_eventInfo, ctx);
     if (!evttmp.isValid()) {
       throw std::runtime_error("ERROR in CP::MVATrackVertexAssociationTool::isMatch : could not retrieve xAOD::EventInfo!");
     }
     evt = evttmp.get();
   }
   else {
     evt = evtInfo;
   }
  
   // Evaluate our network and compare against our TVA cut (">= cut" := associated)
   mvaOutput = this->evaluateNetwork(trk, vx, *evt);
   return (mvaOutput >= m_cut);
 }

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

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;
    }

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

Gaudi::Property<float> CP::MVATrackVertexAssociationTool::m_cut

private

Initial value:

{this, "OutputCut" , -1.0,

"TVA cut value on the output value (set manually with \"Custom\" WP)."}

TVA cut value on the output discriminant.

Definition at line 111 of file MVATrackVertexAssociationTool.h.

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

SG::ReadHandleKey<xAOD::EventInfo> CP::MVATrackVertexAssociationTool::m_eventInfo {this, "EventInfo", "EventInfo", "EventInfo key"}

private

EventInfo key.

Definition at line 136 of file MVATrackVertexAssociationTool.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_fileName

Gaudi::Property<std::string> CP::MVATrackVertexAssociationTool::m_fileName {this, "NetworkFileName", "" }

private

Input lwtnn network file.

Definition at line 89 of file MVATrackVertexAssociationTool.h.

◆ m_graph

std::unique_ptr<lwt::LightweightGraph> CP::MVATrackVertexAssociationTool::m_graph

private

Definition at line 147 of file MVATrackVertexAssociationTool.h.

◆ m_hardScatterDeco

Gaudi::Property<std::string> CP::MVATrackVertexAssociationTool::m_hardScatterDeco

private

Initial value:

{this, "HardScatterLinkDeco", "hardScatterVertexLink",

"The decoration name of the ElementLink to the hardscatter vertex (found on xAOD::EventInfo)"}

The decoration name of the ElementLink to the hardscatter vertex (found on xAOD::EventInfo)

Definition at line 119 of file MVATrackVertexAssociationTool.h.

◆ m_hardScatterDecoKey

SG::ReadDecorHandleKey<xAOD::EventInfo> CP::MVATrackVertexAssociationTool::m_hardScatterDecoKey

private

Initial value:

{this, "VertexScatterKey", "" ,

"Overwrriten in the configuration step by the <HardScatterLinkDeco> property"}

Hardscatter vertex link key.

Definition at line 139 of file MVATrackVertexAssociationTool.h.

◆ m_inputEval

MVAInputEvaluator CP::MVATrackVertexAssociationTool::m_inputEval

private

Input variable evaluator.

Definition at line 133 of file MVATrackVertexAssociationTool.h.

◆ m_inputMap

MVAInputEvaluator::InputSelectionMap CP::MVATrackVertexAssociationTool::m_inputMap

private

Input variable name/type map.

Definition at line 130 of file MVATrackVertexAssociationTool.h.

◆ m_inputNames

Gaudi::Property<std::vector<std::string> > CP::MVATrackVertexAssociationTool::m_inputNames

private

Initial value:

{this, "InputNames", {},

"Vector of the network's input variable names (std::vector<std::string>)." }

Vector of input variable names.

Definition at line 92 of file MVATrackVertexAssociationTool.h.

◆ m_inputNodeName

std::string CP::MVATrackVertexAssociationTool::m_inputNodeName = ""

private

Name of the input node (for functional modes)

Definition at line 143 of file MVATrackVertexAssociationTool.h.

◆ m_inputTypes

Gaudi::Property<std::vector<int> > CP::MVATrackVertexAssociationTool::m_inputTypes

private

Initial value:

{this,"InputTypes", {},

"Vector of the network's input variable evaluator types (std::vector<CP::MVAEvaluatorInput::Input>)."}

Vector of input variable types.

Definition at line 96 of file MVATrackVertexAssociationTool.h.

◆ m_isSequential

Gaudi::Property<bool> CP::MVATrackVertexAssociationTool::m_isSequential

private

Initial value:

{this, "IsSequential", true,

"Is the network sequential (true) or functional (false)."}

Is the network sequential or functional.

Definition at line 104 of file MVATrackVertexAssociationTool.h.

◆ m_network

std::unique_ptr<lwt::LightweightNeuralNetwork> CP::MVATrackVertexAssociationTool::m_network

private

Network as implemented using lwtnn.

Definition at line 146 of file MVATrackVertexAssociationTool.h.

◆ m_outputName

Gaudi::Property<std::string> CP::MVATrackVertexAssociationTool::m_outputName

private

Initial value:

{this, "OutputNodeName", "",

"Name of the output node to cut on for TVA."}

Name of the output node to cut on.

Definition at line 100 of file MVATrackVertexAssociationTool.h.

◆ m_usePathResolver

Gaudi::Property<bool> CP::MVATrackVertexAssociationTool::m_usePathResolver

private

Initial value:

{this, "UsePathResolver", true,

"Use the PathResolver for finding the input lwtnn network file."}

Use the PathResolver to find our input file.

Definition at line 115 of file MVATrackVertexAssociationTool.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_wp

Gaudi::Property<std::string> CP::MVATrackVertexAssociationTool::m_wp {this, "WorkingPoint", "Tight", "TVA working point to apply."}

private

TVA working point.

Definition at line 108 of file MVATrackVertexAssociationTool.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

◆ MVATrackVertexAssociationTool()

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

◆ evaluateNetwork()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getKey()

◆ getMatchMap() [1/2]

◆ getMatchMap() [2/2]

◆ getMatchMapInternal()

◆ getName()

◆ getProperty()

◆ getUniqueMatchMap() [1/2]

◆ getUniqueMatchMap() [2/2]

◆ getUniqueMatchMapInternal()

◆ getUniqueMatchVertex()

◆ getUniqueMatchVertexInternal()

◆ getUniqueMatchVertexLink()

◆ initialize()

◆ initializeNetwork()

◆ inputHandles()

◆ isCompatible() [1/2]

◆ isCompatible() [2/2]

◆ isMatch()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_cut

◆ m_detStore

◆ m_eventInfo

◆ m_evtStore

◆ m_fileName

◆ m_graph

◆ m_hardScatterDeco

◆ m_hardScatterDecoKey

◆ m_inputEval

◆ m_inputMap

◆ m_inputNames

◆ m_inputNodeName

◆ m_inputTypes

◆ m_isSequential

◆ m_network

◆ m_outputName

◆ m_usePathResolver

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_wp