Acts::VertexingOptions Struct Reference

Vertex Finder Options. More...

#include <Acts/Vertexing/VertexingOptions.hpp>

Collaboration diagram for Acts::VertexingOptions:

Public Member Functions
	VertexingOptions ()=delete
	Default constructor is deleted.
	VertexingOptions (const GeometryContext &gctx, const MagneticFieldContext &mctx)
	VertexingOptions with context and without vertex constraint.
	VertexingOptions (const GeometryContext &gctx, const MagneticFieldContext &mctx, const Vertex &constr, const bool useConstr=true)
	VertexingOptions with context and vertex constraint.

Public Attributes
Vertex	constraint
	Vertex constraint.
std::reference_wrapper< const GeometryContext >	geoContext
	Context object for the geometry.
std::reference_wrapper< const MagneticFieldContext >	magFieldContext
	Context object for the magnetic field.
bool	useConstraintInFit
	Boolean indicating whether we use the constraint information during the vertex fit.

Detailed Description

Vertex Finder Options.

Constructor & Destructor Documentation

VertexingOptions() [1/3]

Acts::VertexingOptions::VertexingOptions ( )

delete

Default constructor is deleted.

VertexingOptions() [2/3]

Acts::VertexingOptions::VertexingOptions	(	const GeometryContext &	gctx,
		const MagneticFieldContext &	mctx,
		const Vertex &	constr,
		const bool	useConstr = true )

VertexingOptions with context and vertex constraint.

Parameters

gctx	Geometry context
mctx	Magnetic field context
constr	Vertex constraint
useConstr	Boolean indicating whether vertex constraint should be used during the vertex fit

VertexingOptions() [3/3]

Acts::VertexingOptions::VertexingOptions	(	const GeometryContext &	gctx,
		const MagneticFieldContext &	mctx )

VertexingOptions with context and without vertex constraint.

Parameters

gctx	Geometry context
mctx	Magnetic field context

Member Data Documentation

constraint

Vertex Acts::VertexingOptions::constraint

Vertex constraint.

Important note: While this variable is not used during the vertex fit if useConstraintInFit is set to false, it is always used during vertex finding.

geoContext

std::reference_wrapper<const GeometryContext> Acts::VertexingOptions::geoContext

Context object for the geometry.

magFieldContext

std::reference_wrapper<const MagneticFieldContext> Acts::VertexingOptions::magFieldContext

Context object for the magnetic field.

useConstraintInFit

bool Acts::VertexingOptions::useConstraintInFit

Boolean indicating whether we use the constraint information during the vertex fit.

If set to true, the covariance matrix of constraint must be invertible.