CP::TrackVertexAssociationTool Class Reference

General track-vertex association tool. More...

#include <TrackVertexAssociationTool.h>

Inheritance diagram for CP::TrackVertexAssociationTool:

Collaboration diagram for CP::TrackVertexAssociationTool:

Classes
class	WorkingPoint

Public Types
Public helper class for applying the difference TTVA WPs
typedef SG::AuxElement::ConstAccessor< std::vector< ElementLink< xAOD::VertexContainer > > >	AMVFVerticesAcc
typedef SG::AuxElement::ConstAccessor< std::vector< float > >	AMVFWeightsAcc

Public Member Functions
	TrackVertexAssociationTool (const std::string &name)
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
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.
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 &trkCont, const xAOD::VertexContainer &vxCont) const override
virtual ElementLink< xAOD::VertexContainer >	getUniqueMatchVertexLink (const xAOD::TrackParticle &trk, const xAOD::VertexContainer &vxCont) const override
	This functions will return the best matched vertex.
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.
virtual xAOD::TrackVertexAssociationMap	getUniqueMatchMap (const xAOD::TrackParticleContainer &trkCont, const xAOD::VertexContainer &vxCont) const override
template<typename U, typename V>
xAOD::TrackVertexAssociationMap	getMatchMapInternal (U &trk_list, V &vx_list) const
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	isMatch (const xAOD::TrackParticle &trk, const xAOD::Vertex &vx, const xAOD::EventInfo *evtInfo=nullptr) const
template<typename T, typename U>
xAOD::TrackVertexAssociationMap	getMatchMapInternal (T &trk_list, U &vx_list) const
template<typename T, typename U>
xAOD::TrackVertexAssociationMap	getUniqueMatchMapInternal (T &trk_list, U &vx_list) const
template<typename T>
const xAOD::Vertex *	getUniqueMatchVertexInternal (const xAOD::TrackParticle &trk, T &vx_list) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared
The properties that can be defined via the python job options
Gaudi::Property< std::string >	m_wp
Gaudi::Property< float >	m_d0_cut
Gaudi::Property< bool >	m_use_d0sig
Gaudi::Property< float >	m_d0sig_cut
Gaudi::Property< float >	m_dzSinTheta_cut
Gaudi::Property< bool >	m_doUsedInFit
	Flag to cut on d0sig instead of d0.
Gaudi::Property< bool >	m_doPVPriority
Gaudi::Property< bool >	m_requirePriVtx
Gaudi::Property< std::string >	m_hardScatterDeco {this, "HardScatterLinkDeco", "hardScatterVertexLink"}
	The decoration name of the ElementLink to the hardscatter vertex (found on xAOD::EventInfo)
SG::ReadHandleKey< xAOD::TrackParticleContainer >	m_trkKey {this, "TrackContName", "InDetTrackParticles"}
	The name of the xAOD::TrackParticleContainer to access the AMVF vertices+weights for (not actually read).
Truly private internal data members
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfo {this, "EventInfo", "EventInfo", "EventInfo key"}
	EventInfo key.
Gaudi::Property< std::string >	m_vtxDecoName
	AMVF vertices decoration key.
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_vtxDecoKey {this, "AMVFVerticesKey", "" , "Overwritten with the <AMVFVerticesDeco> property"}
std::unique_ptr< AMVFVerticesAcc >	m_vtxDecoAcc {nullptr}
	AMVF vertices decoration accessor.
Gaudi::Property< std::string >	m_wgtDecoName
	AMVF weights decoration key.
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_wgtDecoKey {this, "MVWeightKey", "" , "Overwritten with the <AMVFWeightsDeco> property"}
std::unique_ptr< AMVFWeightsAcc >	m_wgtDecoAcc {nullptr}
	AMVF weights decoration accessor.
SG::ReadDecorHandleKey< xAOD::EventInfo >	m_hardScatterDecoKey
	Hardscatter vertex link key.
std::unique_ptr< WorkingPoint >	m_applicator {nullptr}
	Stored WorkingPoint class.

Detailed Description

General track-vertex association tool.

Supported properties (set via setProperty):

• WorkingPoint: Working Point to operate on.
• d0_cut: Cut on d0. Not applied if set to -1.
• use_d0sig: flag to cut on d0sig instead of d0.
• d0sig_cut: Cut on d0Sig. Not applied if set to -1.
• dzSinTheta_cut: Cut on |dz*sinTheta| (in mm). Not applied if set to -1.
• doUsedInFit: Control whether to allow for a MatchStatus of UsedInFit.
• requirePriVtx: Control whether a vertex must be VxType::PriVtx in order for a track (not UsedInFit) to be uniquely matched to it.
• HardScatterLinkDeco: The decoration name of the ElementLink to the hardscatter vertex (found on xAOD::EventInfo)

To apply the recommendations, please visit https://twiki.cern.ch/twiki/bin/view/AtlasProtected/TrackingCPRecsEarly2018#Track_to_Vertex_Association_Tool

Definition at line 51 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

Member Typedef Documentation

AMVFVerticesAcc

typedef SG::AuxElement::ConstAccessor<std::vector<ElementLink<xAOD::VertexContainer> > > CP::TrackVertexAssociationTool::AMVFVerticesAcc

Definition at line 64 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

AMVFWeightsAcc

typedef SG::AuxElement::ConstAccessor<std::vector<float> > CP::TrackVertexAssociationTool::AMVFWeightsAcc

Definition at line 65 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

TrackVertexAssociationTool()

TrackVertexAssociationTool::TrackVertexAssociationTool

(

const std::string &

name

)

Definition at line 240 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.

                                                                            :
  AsgTool(name) {} 

Member Function Documentation

declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

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

getKey()

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

inherited

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

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

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

See also

asg::AsgTool::getName

Parameters

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

Returns

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

Definition at line 119 of file AsgTool.cxx.

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

getMatchMap() [1/2]

xAOD::TrackVertexAssociationMap TrackVertexAssociationTool::getMatchMap ( const xAOD::TrackParticleContainer & trkCont, const xAOD::VertexContainer & vxCont ) const

overridevirtual

Implements CP::ITrackVertexAssociationTool.

Definition at line 350 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.

{
  return getMatchMapInternal(trkCont, vxCont);
}

getMatchMap() [2/2]

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

overridevirtual

Implements CP::ITrackVertexAssociationTool.

Definition at line 345 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.

{
  return getMatchMapInternal(trk_list, vx_list);
}

getMatchMapInternal() [1/2]

template<typename T, typename U>

xAOD::TrackVertexAssociationMap CP::TrackVertexAssociationTool::getMatchMapInternal ( T & trk_list, U & vx_list ) const

private

getMatchMapInternal() [2/2]

template<typename U, typename V>

xAOD::TrackVertexAssociationMap CP::TrackVertexAssociationTool::getMatchMapInternal	(	U &	trk_list,
		V &	vx_list ) const

Definition at line 412 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.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 TrackVertexAssociationTool::getUniqueMatchMap ( const xAOD::TrackParticleContainer & trkCont, const xAOD::VertexContainer & vxCont ) const

overridevirtual

Implements CP::ITrackVertexAssociationTool.

Definition at line 375 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.

{
  return getUniqueMatchMapInternal(trkCont, vxCont);
}

getUniqueMatchMap() [2/2]

xAOD::TrackVertexAssociationMap TrackVertexAssociationTool::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 370 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.

{
  return getUniqueMatchMapInternal(trk_list, vx_list);
}

getUniqueMatchMapInternal()

template<typename T, typename U>

xAOD::TrackVertexAssociationMap TrackVertexAssociationTool::getUniqueMatchMapInternal ( T & trk_list, U & vx_list ) const

private

Definition at line 467 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.

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

getUniqueMatchVertex()

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

overridevirtual

Implements CP::ITrackVertexAssociationTool.

Definition at line 355 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.

{
  return getUniqueMatchVertexInternal(trk, vx_list);
}

getUniqueMatchVertexInternal()

template<typename T>

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

private

Definition at line 432 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.

{
  FitWeight weight;
  float dzSinTheta{0.};
  float min_dz = ((m_dzSinTheta_cut >= 0) ? m_dzSinTheta_cut.value() : +999.0);
  const xAOD::Vertex* bestMatchVertex = nullptr;
 
  for (const auto& vertex : vx_list) {
    weight = ::fitWeight(&trk, vertex, *m_vtxDecoAcc, *m_wgtDecoAcc);
    if (m_doUsedInFit && weight.first > 0.0 && weight.first >= weight.second) {
      bestMatchVertex = vertex;
      break;
    }
    else {
      if (m_requirePriVtx && vertex->vertexType() != xAOD::VxType::PriVtx) continue;
      if (isCompatible(trk, *vertex)) {
        dzSinTheta = ::absDzSinTheta(&trk, vertex);
        if (dzSinTheta < min_dz) {
          min_dz = dzSinTheta;
          bestMatchVertex = vertex;
          if(m_doPVPriority) break; //This will stop the iteration on the vertices. This works since the PV should always be the first entry in the vertex collection
        }
      }
    }
  }
 
  // Check if get the matched vertex
  if (!bestMatchVertex) {
    ATH_MSG_DEBUG("Could not find any matched vertex for this track!");
  }
 
  return bestMatchVertex;
}

getUniqueMatchVertexLink()

ElementLink< xAOD::VertexContainer > TrackVertexAssociationTool::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 360 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.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 TrackVertexAssociationTool::initialize ( void )

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 251 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.

{
  static const std::set<std::string> run_2_wps = {"Loose", "Nominal", "Tight", "Electron", "Muon", "Old_Loose", "Old_Nominal", "Old_Tight", "Old_Electron", "Old_Muon"};
  std::string wp{m_wp};  
  if (run_2_wps.count(wp)) {
    std::string prefix = "Old_";
    if (wp.compare(0, prefix.size(), prefix) == 0) {
      ATH_MSG_WARNING("WorkingPoint '" << m_wp << "' corresponds to a Run 2 working point and is not recommended.");
    }
    else {
      ATH_MSG_WARNING("WorkingPoint '" << m_wp << "' corresponds to a Run 2 working point and is not recommended - remapping to 'Old_" << m_wp << "' (same definition, however).");
      wp.insert(0, "Old_");
    }
    m_wp = wp;
  }
 
  IF_WORKING_POINT(Old_Loose, true, true)
  else IF_WORKING_POINT(Old_Nominal, false, false)
  else IF_WORKING_POINT(Old_Tight, false, false)
  else IF_WORKING_POINT(Old_Electron, false, false)
  else IF_WORKING_POINT(Old_Muon, false, false)
  else IF_WORKING_POINT(Prompt_D0Sig, true, false)
  else IF_WORKING_POINT(Nonprompt_Hard_D0Sig, true, false)
  else IF_WORKING_POINT(Nonprompt_Medium_D0Sig, true, false)
  else IF_WORKING_POINT(Nonprompt_All_D0Sig, true, false)
  else IF_WORKING_POINT(Prompt_MaxWeight, true, false)
  else IF_WORKING_POINT(Nonprompt_Hard_MaxWeight, true, false)
  else IF_WORKING_POINT(Nonprompt_Medium_MaxWeight, true, false)
  else IF_WORKING_POINT(Nonprompt_All_MaxWeight, true, false)
  // Backwards compatability for Custom WP
  else if (m_wp == "Custom") {
    m_applicator = std::unique_ptr<CP::TrackVertexAssociationTool::WorkingPoint>(
      new ::Custom(m_d0_cut, m_use_d0sig, m_d0sig_cut, m_dzSinTheta_cut, m_doUsedInFit));
  }
  else {
    ATH_MSG_ERROR("Invalid TVA working point '" << m_wp << "' - for a custom configuration, please provide 'Custom' for the 'WorkingPoint' property.");
    return StatusCode::FAILURE;
  }
 
  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.");
  }
 
  if (m_use_d0sig) {
    ATH_MSG_DEBUG("(For Custom WP:) cut on d0 significance: " << m_d0sig_cut << "\t(d0sig_cut).");
  }
  else {
    ATH_MSG_DEBUG("(For Custom WP:) cut on d0: " << m_d0_cut << "\t(d0_cut).");
  }
  ATH_MSG_DEBUG("(For Custom WP:) cut on Δz * sin θ: " << m_dzSinTheta_cut << "\t(dzSinTheta_cut).");
  ATH_MSG_DEBUG("(For Custom WP:) allow UsedInFit MatchStatus: " << m_doUsedInFit << "\t(doUsedInFit).");
  ATH_MSG_DEBUG("Require VxType::PriVtx for unique match: " << m_requirePriVtx << "\t(requirePriVtx).");
 
  // Initialize our EventInfo container and decoration reads
  ATH_CHECK(m_eventInfo.initialize());
  ATH_CHECK(m_trkKey.initialize());
  {
    const std::string decorName = m_hardScatterDeco;
    m_hardScatterDecoKey = m_eventInfo.key() + "." + decorName;
    ATH_CHECK(m_hardScatterDecoKey.initialize(!decorName.empty()));
  }
  m_vtxDecoAcc = std::make_unique<AMVFVerticesAcc>(m_vtxDecoName);
  m_vtxDecoKey = m_trkKey.key() + "." + m_vtxDecoName;
  ATH_CHECK(m_vtxDecoKey.initialize());
  m_wgtDecoAcc = std::make_unique<AMVFWeightsAcc>(m_wgtDecoName);
  m_wgtDecoKey = m_trkKey.key() + "." + m_wgtDecoName;
  ATH_CHECK(m_wgtDecoKey.initialize());
 
  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 TrackVertexAssociationTool::isCompatible ( const xAOD::TrackParticle & trk ) const

overridevirtual

Implements CP::ITrackVertexAssociationTool.

Definition at line 331 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.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::TrackVertexAssociationTool::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::TrackVertexAssociationTool::isCompatible : hardscatter vertex link is not valid!");
  }
  return isMatch(trk, **vtxLink, evt.get());
}

isCompatible() [2/2]

bool TrackVertexAssociationTool::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 325 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.

{
  ATH_MSG_DEBUG("In TrackVertexAssociationTool::isCompatible function.");
  return isMatch(trk, vx);
}

isMatch()

bool TrackVertexAssociationTool::isMatch ( const xAOD::TrackParticle & trk, const xAOD::Vertex & vx, const xAOD::EventInfo * evtInfo = nullptr ) const

private

Definition at line 384 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.

                                                                                                                               {
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
 
  // Return false for fake vertices
  if (vx.vertexType() == xAOD::VxType::NoVtx) {
    return false;
  }
 
  // Read 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::TrackVertexAssociationTool::isMatch : could not retrieve xAOD::EventInfo!");
    }
    evt = evttmp.get();
  }
  else {
    evt = evtInfo;
  }
 
  // Apply the working point
  return m_applicator->apply(&trk, &vx, evt, *m_vtxDecoAcc, *m_wgtDecoAcc);
 
}

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

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

inherited

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

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

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

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

Returns

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

Definition at line 101 of file AsgTool.cxx.

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

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

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

sysStart()

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

overridevirtualinherited

Handle START transition.

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

updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

m_applicator

std::unique_ptr<WorkingPoint> CP::TrackVertexAssociationTool::m_applicator {nullptr}

private

Stored WorkingPoint class.

Definition at line 170 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

{nullptr};

m_d0_cut

Gaudi::Property<float> CP::TrackVertexAssociationTool::m_d0_cut

private

Initial value:

{this, "d0_cut", -1.,
                                   "Cut on d0. Not applied if set to -1."}

Definition at line 113 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

                                 {this, "d0_cut", -1.,
                                   "Cut on d0. Not applied if set to -1."};

m_d0sig_cut

Gaudi::Property<float> CP::TrackVertexAssociationTool::m_d0sig_cut

private

Initial value:

{this, "d0sig_cut", -1., 
                                       "Cut on d0Sig. Not applied if set to -1."}

Definition at line 119 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

                                    {this, "d0sig_cut", -1., 
                                       "Cut on d0Sig. Not applied if set to -1."};

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_doPVPriority

Gaudi::Property<bool> CP::TrackVertexAssociationTool::m_doPVPriority

private

Initial value:

{this, "doPVPriority", false, 
                        "Control whether to give priority to matching to PV instead of closest vertex."}

Definition at line 129 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

                                      {this, "doPVPriority", false, 
                        "Control whether to give priority to matching to PV instead of closest vertex."};

m_doUsedInFit

Gaudi::Property<bool> CP::TrackVertexAssociationTool::m_doUsedInFit

private

Initial value:

{this, "doUsedInFit", false,
                          "Control whether to allow for a MatchStatus of UsedInFit."}

Flag to cut on d0sig instead of d0.

Definition at line 126 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

                                     {this, "doUsedInFit", false,
                          "Control whether to allow for a MatchStatus of UsedInFit."};

m_dzSinTheta_cut

Gaudi::Property<float> CP::TrackVertexAssociationTool::m_dzSinTheta_cut

private

Initial value:

{this, "dzSinTheta_cut", -1.,
                                          "Cut on |dz*sinTheta| (in mm). Not applied if set to -1." }

Definition at line 122 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

                                         {this, "dzSinTheta_cut", -1.,
                                          "Cut on |dz*sinTheta| (in mm). Not applied if set to -1." };

m_eventInfo

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

private

EventInfo key.

Definition at line 149 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

{this, "EventInfo", "EventInfo", "EventInfo key"};

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_hardScatterDeco

Gaudi::Property<std::string> CP::TrackVertexAssociationTool::m_hardScatterDeco {this, "HardScatterLinkDeco", "hardScatterVertexLink"}

private

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

Definition at line 136 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

{this, "HardScatterLinkDeco", "hardScatterVertexLink"};

m_hardScatterDecoKey

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

private

Initial value:

{this, "HardScatterLinkDecoKey" ,"" , 
                                            "Will be overwritten with the <HardScatterLinkDeco> property"}

Hardscatter vertex link key.

Definition at line 166 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

                                                            {this, "HardScatterLinkDecoKey" ,"" , 
                                            "Will be overwritten with the <HardScatterLinkDeco> property"};

m_requirePriVtx

Gaudi::Property<bool> CP::TrackVertexAssociationTool::m_requirePriVtx

private

Initial value:

{this, "requirePriVtx", false,
      "Control whether a vertex must be VxType::PriVtx in order for a track (not UsedInFit) to be uniquely matched to it."}

Definition at line 132 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

                                       {this, "requirePriVtx", false,
      "Control whether a vertex must be VxType::PriVtx in order for a track (not UsedInFit) to be uniquely matched to it."};

m_trkKey

SG::ReadHandleKey<xAOD::TrackParticleContainer> CP::TrackVertexAssociationTool::m_trkKey {this, "TrackContName", "InDetTrackParticles"}

private

The name of the xAOD::TrackParticleContainer to access the AMVF vertices+weights for (not actually read).

Definition at line 139 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

{this, "TrackContName", "InDetTrackParticles"};

m_use_d0sig

Gaudi::Property<bool> CP::TrackVertexAssociationTool::m_use_d0sig

private

Initial value:

{this, "use_d0sig", false, 
                                      "Flag to cut on d0sig instead of d0."}

Definition at line 116 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

                                   {this, "use_d0sig", false, 
                                      "Flag to cut on d0sig instead of d0."};

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_vtxDecoAcc

std::unique_ptr<AMVFVerticesAcc> CP::TrackVertexAssociationTool::m_vtxDecoAcc {nullptr}

private

AMVF vertices decoration accessor.

Definition at line 156 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

{nullptr};

m_vtxDecoKey

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> CP::TrackVertexAssociationTool::m_vtxDecoKey {this, "AMVFVerticesKey", "" , "Overwritten with the <AMVFVerticesDeco> property"}

private

Definition at line 154 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

{this, "AMVFVerticesKey", "" , "Overwritten with the <AMVFVerticesDeco> property"};

m_vtxDecoName

Gaudi::Property<std::string> CP::TrackVertexAssociationTool::m_vtxDecoName

private

Initial value:

{this, "AMVFVerticesDeco", "TTVA_AMVFVertices",
                                  "The per-track decoration name of the vector of AMVF used-in-fit vertex ElementLinks."}

AMVF vertices decoration key.

Definition at line 152 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

                                          {this, "AMVFVerticesDeco", "TTVA_AMVFVertices",
                                  "The per-track decoration name of the vector of AMVF used-in-fit vertex ElementLinks."};

m_wgtDecoAcc

std::unique_ptr<AMVFWeightsAcc> CP::TrackVertexAssociationTool::m_wgtDecoAcc {nullptr}

private

AMVF weights decoration accessor.

Definition at line 163 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

{nullptr};

m_wgtDecoKey

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> CP::TrackVertexAssociationTool::m_wgtDecoKey {this, "MVWeightKey", "" , "Overwritten with the <AMVFWeightsDeco> property"}

private

Definition at line 161 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

{this, "MVWeightKey", "" , "Overwritten with the <AMVFWeightsDeco> property"};

m_wgtDecoName

Gaudi::Property<std::string> CP::TrackVertexAssociationTool::m_wgtDecoName

private

Initial value:

{this, "AMVFWeightsDeco", "TTVA_AMVFWeights",
                              "The per-track decoration name of the vector of AMVF used-in-fit annealing weights." }

AMVF weights decoration key.

Definition at line 159 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

                                          {this, "AMVFWeightsDeco", "TTVA_AMVFWeights",
                              "The per-track decoration name of the vector of AMVF used-in-fit annealing weights." };

m_wp

Gaudi::Property<std::string> CP::TrackVertexAssociationTool::m_wp

private

Initial value:

{this, "WorkingPoint", "Old_Nominal", 
                                      "Working point to operate on."}

Definition at line 110 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.

                                 {this, "WorkingPoint", "Old_Nominal", 
                                      "Working point to operate on."};

---

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

• InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h
• InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx