Acts::IVertexFinder Class Reference

Common interface for both vertex finders and vertex seed finders. More...

#include <Acts/Vertexing/IVertexFinder.hpp>

Inheritance diagram for Acts::IVertexFinder:

Public Types
using	State = Acts::AnyBase<128>
	Type-erased wrapper for concrete state objects.

Public Member Functions
virtual	~IVertexFinder ()=default
	Virtual destructor.
virtual Result< std::vector< Vertex > >	find (const std::vector< InputTrack > &trackVector, const VertexingOptions &vertexingOptions, State &state) const =0
	The main finder method that will return a set of found vertex candidates.
virtual State	makeState (const MagneticFieldContext &mctx) const =0
	Function to create a state object for this concrete vertex finder.
virtual void	setTracksToRemove (State &anyState, const std::vector< InputTrack > &removedTracks) const =0
	For vertex finders that have an internal state of active tracks, this method instructs them to mark used tracks for removal.

Detailed Description

Common interface for both vertex finders and vertex seed finders.

Member Typedef Documentation

State

using Acts::IVertexFinder::State = Acts::AnyBase<128>

Type-erased wrapper for concrete state objects.

Constructor & Destructor Documentation

~IVertexFinder()

virtual Acts::IVertexFinder::~IVertexFinder ( )

virtualdefault

Virtual destructor.

Member Function Documentation

find()

virtual Result< std::vector< Vertex > > Acts::IVertexFinder::find ( const std::vector< InputTrack > & trackVector, const VertexingOptions & vertexingOptions, State & state ) const

pure virtual

The main finder method that will return a set of found vertex candidates.

Parameters

trackVector	The input track collection
vertexingOptions	The vertexing options
state	The state object (needs to be created via makeState)

Returns

The found vertex candidates

Implemented in Acts::AdaptiveGridDensityVertexFinder, Acts::AdaptiveMultiVertexFinder, Acts::GridDensityVertexFinder, Acts::IterativeVertexFinder, Acts::TrackDensityVertexFinder, and Acts::ZScanVertexFinder.

makeState()

virtual State Acts::IVertexFinder::makeState ( const MagneticFieldContext & mctx ) const

pure virtual

Function to create a state object for this concrete vertex finder.

Parameters

mctx	The magnetic field context

Returns

The state object

Implemented in Acts::AdaptiveGridDensityVertexFinder, Acts::AdaptiveMultiVertexFinder, Acts::GridDensityVertexFinder, Acts::IterativeVertexFinder, Acts::TrackDensityVertexFinder, and Acts::ZScanVertexFinder.

setTracksToRemove()

virtual void Acts::IVertexFinder::setTracksToRemove ( State & anyState, const std::vector< InputTrack > & removedTracks ) const

pure virtual

For vertex finders that have an internal state of active tracks, this method instructs them to mark used tracks for removal.

Parameters

anyState	The state object
removedTracks	The tracks to be removed

Implemented in Acts::AdaptiveGridDensityVertexFinder, Acts::AdaptiveMultiVertexFinder, Acts::GridDensityVertexFinder, Acts::IterativeVertexFinder, Acts::TrackDensityVertexFinder, and Acts::ZScanVertexFinder.