creates a jet::TrackVertexAssociation object More...

#include <TrackVertexAssociationTool.h>

Inheritance diagram for TrackVertexAssociationTool:

Collaboration diagram for TrackVertexAssociationTool:

Public Member Functions
	TrackVertexAssociationTool (const std::string &t)

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

int	execute () const
	Method to be called for each event. 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

virtual int	inputContainerNames (std::vector< std::string > &connames)
	Method to return the list of input containers. More...

virtual int	outputContainerNames (std::vector< std::string > &connames)
	Method to return the list of output containers. More...

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
std::unique_ptr< jet::TrackVertexAssociation >	buildTrackVertexAssociation_withTool (const xAOD::TrackParticleContainer , const xAOD::VertexContainer ) const

std::unique_ptr< jet::TrackVertexAssociation >	buildTrackVertexAssociation_custom (const xAOD::TrackParticleContainer , const xAOD::VertexContainer ) const

std::unique_ptr< jet::TrackVertexAssociation >	makeTrackVertexAssociation (const xAOD::TrackParticleContainer , const xAOD::VertexContainer , bool useCustom) 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
ToolHandle< CP::ITrackVertexAssociationTool >	m_tvaTool

float	m_transDistMax

float	m_longDistMax

float	m_maxZ0SinTheta

SG::ReadHandleKey< xAOD::TrackParticleContainer >	m_trackContainer_key

SG::ReadHandleKey< xAOD::VertexContainer >	m_vertexContainer_key

SG::WriteHandleKey< jet::TrackVertexAssociation >	m_tva_key

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

creates a jet::TrackVertexAssociation object

Creates a jet::TrackVertexAssociation map. The tool expects a ITrackVertexAssociationTool which it uses to create the map from a TrackParticleContainer and a VertexContainer. The map is recorded in the evtStore.

Properties :

"TrackParticleContainer" : name of TrackParticleContainer
"VertexContainer" : name of VertexContainer
"TrackVertexAssociation" : name of the output jet::TrackVertexAssociation
"TrackVertexAssoTool" : A ITrackVertexAssociationTool instance

If the TrackVertexAssoTool is left blank, the old custom method is used to build the code using cuts defined by these properties

"MaxTransverseDistance",
"MaxLongitudinalDistance"
"MaxZ0SinTheta" This old part of the code may disappear in the future.

Definition at line 45 of file Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.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

◆ TrackVertexAssociationTool()

TrackVertexAssociationTool::TrackVertexAssociationTool ( const std::string & t )

Definition at line 10 of file Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

     : AsgTool(t)
     , m_tvaTool("",this) // default as empty
     , m_transDistMax(10e6)
     , m_longDistMax(10e6)
     , m_maxZ0SinTheta(10e6)
 {
   declareProperty("TrackVertexAssoTool", m_tvaTool);  // Tool handle
  
   declareProperty("MaxTransverseDistance",m_transDistMax);
   declareProperty("MaxLongitudinalDistance",m_longDistMax);
   declareProperty("MaxZ0SinTheta", m_maxZ0SinTheta);
   
   declareProperty("TrackParticleContainer",m_trackContainer_key);
   declareProperty("VertexContainer",m_vertexContainer_key);
   declareProperty("TrackVertexAssociation",m_tva_key);
     
 }

Member Function Documentation

◆ buildTrackVertexAssociation_custom()

std::unique_ptr< jet::TrackVertexAssociation > TrackVertexAssociationTool::buildTrackVertexAssociation_custom	(	const xAOD::TrackParticleContainer *	trackContainer,
		const xAOD::VertexContainer *	vertexContainer
	)		const

private

Definition at line 141 of file Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

 {
   ATH_MSG_DEBUG("Building track-vertex association trk size="<< trackContainer->size() 
                 << "  vtx size="<< vertexContainer->size());
   
   auto tva = std::make_unique<jet::TrackVertexAssociation>(trackContainer);
  
   for (size_t iTrack = 0; iTrack < trackContainer->size(); ++iTrack)
     {
       const xAOD::TrackParticle* track = trackContainer->at(iTrack);
       
       // Apply track transverse distance cut
       const float transverseDistance = track->d0();//perigeeParameters().parameters()[Trk::d0];
       if (transverseDistance > m_transDistMax) continue;
         
       
       // Get track longitudinal distance offset
       const float longitudinalDistance = track->z0()+track->vz();
       
       double sinTheta = std::sin(track->theta());
  
       // For each track, find the vertex with highest sum pt^2 within z0 cut
       size_t matchedIndex = 0;
       bool foundMatch = false;
       for (size_t iVertex = 0; iVertex < vertexContainer->size(); ++iVertex)
         {
           const xAOD::Vertex* vertex = vertexContainer->at(iVertex);
             
           double deltaz = longitudinalDistance - vertex->z();
  
           // Check longitudinal distance between track and vertex
           if ( fabs(deltaz)  > m_longDistMax)
             continue;
  
           // Check z0*sinThetha between track and vertex
           if (fabs(deltaz*sinTheta) > m_maxZ0SinTheta)
             continue;
  
           // If it passed the cuts, then this is the vertex we want
           // This does make the assumption that the container is sorted in sum pT^2 order
           foundMatch = true;
           matchedIndex = iVertex;
           break;
         }
  
       // If we matched a vertex, then associate that vertex to the track
       if (foundMatch)
         tva->associate(trackContainer->at(iTrack),vertexContainer->at(matchedIndex));
     }
  
  
   // Return the TVA object
   return tva;
 }

◆ buildTrackVertexAssociation_withTool()

std::unique_ptr< jet::TrackVertexAssociation > TrackVertexAssociationTool::buildTrackVertexAssociation_withTool	(	const xAOD::TrackParticleContainer *	trackContainer,
		const xAOD::VertexContainer *	vertexContainer
	)		const

private

Definition at line 119 of file Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

 {
  
   ATH_MSG_DEBUG("Building track-vertex association USING InDet tool. trk size="<< trackContainer->size() 
                 << "  vtx size="<< vertexContainer->size());
  
   auto tva = std::make_unique<jet::TrackVertexAssociation>(trackContainer);
  
   std::vector<const xAOD::Vertex*> vecVert;
   vecVert.assign(vertexContainer->begin(), vertexContainer->end());
  
   for( const xAOD::TrackParticle* track : *trackContainer) {
     
     const xAOD::Vertex * v =  m_tvaTool->getUniqueMatchVertex(*track, vecVert) ;
     tva->associate( track, v );
   }
   return tva;
 }

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

◆ execute()

int TrackVertexAssociationTool::execute ( ) const

virtual

Method to be called for each event.

Returns 0 for success.

Implements IJetExecuteTool.

Definition at line 46 of file Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

                                               {
   // Get input track collection
  
   auto handle_tracks = SG::makeHandle(m_trackContainer_key);
  
   if(!handle_tracks.isValid()){
     ATH_MSG_ERROR("Error retrieving TrackParticleContainer from evtStore: " 
                   << m_trackContainer_key.key());
     return 1;
   }
  
   const auto *trackContainer = handle_tracks.cptr();
  
  
   // If this is a view container, then we assume that it contains elements from only one owning container
   if ( trackContainer->ownPolicy() != SG::OWN_ELEMENTS ) {
     bool oneOwningContainer(true);
     for(const xAOD::TrackParticle* track : *trackContainer) {
       if(track->container() != trackContainer->front()->container()) {
     oneOwningContainer=false;
     break;
       }
     }
     if(!oneOwningContainer) {
       ATH_MSG_ERROR("Track view container holds track from multiple owning containers.");
       ATH_MSG_ERROR("Problem is this container: " << m_trackContainer_key.key());
       return 11;
     }
   }
  
   // Get input vertex collection
   auto handle_vert = SG::makeHandle(m_vertexContainer_key);
  
   if(!handle_vert.isValid()){
     ATH_MSG_ERROR("Error retrieving VertexContainer from evtStore: " 
                   << m_vertexContainer_key.key());
     return 2;
   }
  
   const auto *vertexContainer = handle_vert.cptr();
  
   auto useCustom = m_tvaTool.empty();
   auto tva = makeTrackVertexAssociation(trackContainer,
                                         vertexContainer,
                                         useCustom);
   // Check the result.
   // if ( tva  == nullptr ) {
   if (!tva){
     ATH_MSG_ERROR("Could not build the TrackVertexAssociation");
     return 3;
   }
   
   // Store it
  
   auto handle_tva = SG::makeHandle(m_tva_key);
   if(!handle_tva.record(std::move(tva))){
     ATH_MSG_ERROR("Unable to write new TrackVertexAssociation to evtStore: "
                   << m_tva_key.key());
     return 4;
   }
  
   // Success
   ATH_MSG_DEBUG("Wrote new TrackVertexAssociation to evtStore: " 
                 << m_tva_key.key());
   return 0;
 }

◆ extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

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

◆ getKey()

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

inherited

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

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

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

See also: asg::AsgTool::getName

Parameters

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

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

Definition at line 119 of file AsgTool.cxx.

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

◆ getName()

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

inherited

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

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

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

See also: asg::AsgTool::getKey

Parameters

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

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

Definition at line 106 of file AsgTool.cxx.

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

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode TrackVertexAssociationTool::initialize ( )

virtual

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 29 of file Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

                                                  {
   ATH_MSG_INFO("Initializing tool " << name() << "...");
   ATH_MSG_DEBUG("initializing version with data handles");
   
   ATH_CHECK(m_trackContainer_key.initialize());
   ATH_CHECK(m_vertexContainer_key.initialize());
   ATH_CHECK(m_tva_key.initialize());
  
   if(! m_tvaTool.empty() ) {
     ATH_MSG_INFO("Intialized using ITrackVertexAssociationTool");
     return m_tvaTool.retrieve();
   }
  
   ATH_MSG_INFO("Intialized using custom track-vertex association");
   return StatusCode::SUCCESS;
 }

◆ inputContainerNames()

int IJetExecuteTool::inputContainerNames ( std::vector< std::string > & connames )

virtualinherited

Method to return the list of input containers.

The names of required input containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented in JetRecTool.

Definition at line 11 of file IJetExecuteTool.cxx.

                                                               {
   return 0;
 }

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

◆ makeTrackVertexAssociation()

std::unique_ptr< jet::TrackVertexAssociation > TrackVertexAssociationTool::makeTrackVertexAssociation	(	const xAOD::TrackParticleContainer *	,
		const xAOD::VertexContainer *	,
		bool	useCustom
	)		const

private

Definition at line 199 of file Reconstruction/Jet/JetRecTools/Root/TrackVertexAssociationTool.cxx.

                                                                              {
   if (useCustom) {
     return buildTrackVertexAssociation_custom(trackContainer,
                                               vertexContainer);
   } else {
     return buildTrackVertexAssociation_withTool(trackContainer,
                                                 vertexContainer);
   }
 }

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

◆ outputContainerNames()

int IJetExecuteTool::outputContainerNames ( std::vector< std::string > & connames )

virtualinherited

Method to return the list of output containers.

The names of produced output containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented in JetRecTool.

Definition at line 17 of file IJetExecuteTool.cxx.

                                                                {
   return 0;
 }

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

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

float TrackVertexAssociationTool::m_longDistMax

private

Definition at line 80 of file Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h.

◆ m_maxZ0SinTheta

float TrackVertexAssociationTool::m_maxZ0SinTheta

private

Definition at line 81 of file Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h.

◆ m_trackContainer_key

SG::ReadHandleKey<xAOD::TrackParticleContainer> TrackVertexAssociationTool::m_trackContainer_key

private

Definition at line 83 of file Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h.

◆ m_transDistMax

float TrackVertexAssociationTool::m_transDistMax

private

Definition at line 79 of file Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h.

◆ m_tva_key

SG::WriteHandleKey<jet::TrackVertexAssociation> TrackVertexAssociationTool::m_tva_key

private

Definition at line 85 of file Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h.

◆ m_tvaTool

ToolHandle<CP::ITrackVertexAssociationTool> TrackVertexAssociationTool::m_tvaTool

private

Definition at line 75 of file Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexContainer_key

SG::ReadHandleKey<xAOD::VertexContainer> TrackVertexAssociationTool::m_vertexContainer_key

private

Definition at line 84 of file Reconstruction/Jet/JetRecTools/JetRecTools/TrackVertexAssociationTool.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TrackVertexAssociationTool()

Member Function Documentation

◆ buildTrackVertexAssociation_custom()

◆ buildTrackVertexAssociation_withTool()

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

◆ execute()

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputContainerNames()

◆ inputHandles()

◆ makeTrackVertexAssociation()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputContainerNames()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_longDistMax

◆ m_maxZ0SinTheta

◆ m_trackContainer_key

◆ m_transDistMax

◆ m_tva_key

◆ m_tvaTool

◆ m_varHandleArraysDeclared

◆ m_vertexContainer_key

◆ m_vhka