Acts::GridDensityVertexFinder Class Reference

Vertex finder that makes use of a track density grid. More...

#include <Acts/Vertexing/GridDensityVertexFinder.hpp>

Inheritance diagram for Acts::GridDensityVertexFinder:

Collaboration diagram for Acts::GridDensityVertexFinder:

Classes
struct	Config
	The Config struct. More...
struct	State
	The State struct. More...

Public Types
using	MainGridVector = GaussianGridTrackDensity::MainGridVector
	Type alias for main grid vector used in density calculations.
using	TrackGridVector = GaussianGridTrackDensity::TrackGridVector
	Type alias for track grid vector used for individual track density.
Public Types inherited from Acts::IVertexFinder
using	State = Acts::AnyBase<128>
	Type-erased wrapper for concrete state objects.

Public Member Functions
	GridDensityVertexFinder (const Config &cfg)
	Constructor for user-defined InputTrack type.
Result< std::vector< Vertex > >	find (const std::vector< InputTrack > &trackVector, const VertexingOptions &vertexingOptions, IVertexFinder::State &anyState) const override
	Function that finds single vertex candidate.
IVertexFinder::State	makeState (const Acts::MagneticFieldContext &) const override
	Function to create a state object for this concrete vertex finder.
void	setTracksToRemove (IVertexFinder::State &anyState, const std::vector< InputTrack > &removedTracks) const override
	For vertex finders that have an internal state of active tracks, this method instructs them to mark used tracks for removal.
Public Member Functions inherited from Acts::IVertexFinder
virtual	~IVertexFinder ()=default
	Virtual destructor.

Detailed Description

Vertex finder that makes use of a track density grid.

Each single track is modelled as a 2(!)-dim Gaussian distribution grid in the d0-z0 plane, but only the overlap with the z-axis (i.e. a 1-dim density vector) needs to be calculated. All track contributions along the beam axis (main density grid) a superimposed and the z-value of the bin with the highest track density is returned as a vertex candidate.

Member Typedef Documentation

MainGridVector

using Acts::GridDensityVertexFinder::MainGridVector = GaussianGridTrackDensity::MainGridVector

Type alias for main grid vector used in density calculations.

TrackGridVector

using Acts::GridDensityVertexFinder::TrackGridVector = GaussianGridTrackDensity::TrackGridVector

Type alias for track grid vector used for individual track density.

Constructor & Destructor Documentation

GridDensityVertexFinder()

Acts::GridDensityVertexFinder::GridDensityVertexFinder ( const Config & cfg )

explicit

Constructor for user-defined InputTrack type.

Parameters

cfg	Configuration object

Member Function Documentation

find()

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

overridevirtual

Function that finds single vertex candidate.

Parameters

trackVector	Input track collection
vertexingOptions	Vertexing options
anyState	The state object to cache the density grid and density contributions of each track, to be used if cacheGridStateForTrackRemoval == true

Returns

Vector of vertices, filled with a single vertex (for consistent interfaces)

Implements Acts::IVertexFinder.

makeState()

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

overridevirtual

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

Parameters

mctx	The magnetic field context

Returns

The state object

Implements Acts::IVertexFinder.

setTracksToRemove()

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

overridevirtual

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

Implements Acts::IVertexFinder.