Acts::KalmanFitterOptions< traj_t > Struct Template Reference

Combined options for the Kalman fitter. More...

#include <Acts/TrackFitting/KalmanFitter.hpp>

Collaboration diagram for Acts::KalmanFitterOptions< traj_t >:

Public Member Functions
	KalmanFitterOptions (const GeometryContext &gctx, const MagneticFieldContext &mctx, std::reference_wrapper< const CalibrationContext > cctx, KalmanFitterExtensions< traj_t > extensions_, const PropagatorPlainOptions &pOptions, const Surface *tSurface=nullptr, bool mScattering=true, bool eLoss=true, bool rFiltering=false, double rfScaling=1.0, const FreeToBoundCorrection &freeToBoundCorrection_=FreeToBoundCorrection(false))
	PropagatorOptions with context.

Public Attributes
std::reference_wrapper< const CalibrationContext >	calibrationContext
	context object for the calibration
bool	energyLoss = true
	Whether to consider energy loss.
KalmanFitterExtensions< traj_t >	extensions
	Extensions for calibration and outlier finding.
FreeToBoundCorrection	freeToBoundCorrection
	Whether to include non-linear correction during global to local transformation.
std::reference_wrapper< const GeometryContext >	geoContext
	Context object for the geometry.
std::reference_wrapper< const MagneticFieldContext >	magFieldContext
	Context object for the magnetic field.
bool	multipleScattering = true
	Whether to consider multiple scattering.
PropagatorPlainOptions	propagatorPlainOptions
	The trivial propagator options.
const Surface *	referenceSurface = nullptr
	The reference surface.
TrackExtrapolationStrategy	referenceSurfaceStrategy
	Strategy to propagate to reference surface.
bool	reverseFiltering = false
	Whether to run filtering in reversed direction overwrite the ReverseFilteringLogic.
double	reverseFilteringCovarianceScaling = 100.0
	Factor by which the covariance of the input of the reversed filtering is scaled.

Detailed Description

template<typename traj_t>
struct Acts::KalmanFitterOptions< traj_t >

Combined options for the Kalman fitter.

Template Parameters

traj_t

The trajectory type

Constructor & Destructor Documentation

KalmanFitterOptions()

template<typename traj_t>

Acts::KalmanFitterOptions< traj_t >::KalmanFitterOptions	(	const GeometryContext &	gctx,
		const MagneticFieldContext &	mctx,
		std::reference_wrapper< const CalibrationContext >	cctx,
		KalmanFitterExtensions< traj_t >	extensions_,
		const PropagatorPlainOptions &	pOptions,
		const Surface *	tSurface = nullptr,
		bool	mScattering = true,
		bool	eLoss = true,
		bool	rFiltering = false,
		double	rfScaling = 1.0,
		const FreeToBoundCorrection &	freeToBoundCorrection_ = FreeToBoundCorrection(false) )

PropagatorOptions with context.

Parameters

gctx	The geometry context for this fit
mctx	The magnetic context for this fit
cctx	The calibration context for this fit
extensions_	The KF extensions
pOptions	The plain propagator options
tSurface	The target surface for the fit
mScattering	Whether to include multiple scattering
eLoss	Whether to include energy loss
rFiltering	Whether to run reversed filtering
rfScaling	Scaling factor for covariance at input of reversed filtering
freeToBoundCorrection_	Correction for non-linearity effect during transform from free to bound

Member Data Documentation

calibrationContext

template<typename traj_t>

std::reference_wrapper<const CalibrationContext> Acts::KalmanFitterOptions< traj_t >::calibrationContext

context object for the calibration

energyLoss

template<typename traj_t>

bool Acts::KalmanFitterOptions< traj_t >::energyLoss = true

Whether to consider energy loss.

extensions

template<typename traj_t>

KalmanFitterExtensions<traj_t> Acts::KalmanFitterOptions< traj_t >::extensions

Extensions for calibration and outlier finding.

freeToBoundCorrection

template<typename traj_t>

FreeToBoundCorrection Acts::KalmanFitterOptions< traj_t >::freeToBoundCorrection

Whether to include non-linear correction during global to local transformation.

geoContext

template<typename traj_t>

std::reference_wrapper<const GeometryContext> Acts::KalmanFitterOptions< traj_t >::geoContext

Context object for the geometry.

magFieldContext

template<typename traj_t>

std::reference_wrapper<const MagneticFieldContext> Acts::KalmanFitterOptions< traj_t >::magFieldContext

Context object for the magnetic field.

multipleScattering

template<typename traj_t>

bool Acts::KalmanFitterOptions< traj_t >::multipleScattering = true

Whether to consider multiple scattering.

propagatorPlainOptions

template<typename traj_t>

PropagatorPlainOptions Acts::KalmanFitterOptions< traj_t >::propagatorPlainOptions

The trivial propagator options.

referenceSurface

template<typename traj_t>

const Surface* Acts::KalmanFitterOptions< traj_t >::referenceSurface = nullptr

The reference surface.

referenceSurfaceStrategy

template<typename traj_t>

TrackExtrapolationStrategy Acts::KalmanFitterOptions< traj_t >::referenceSurfaceStrategy

Initial value:

=
      TrackExtrapolationStrategy::firstOrLast

Strategy to propagate to reference surface.

reverseFiltering

template<typename traj_t>

bool Acts::KalmanFitterOptions< traj_t >::reverseFiltering = false

Whether to run filtering in reversed direction overwrite the ReverseFilteringLogic.

reverseFilteringCovarianceScaling

template<typename traj_t>

double Acts::KalmanFitterOptions< traj_t >::reverseFilteringCovarianceScaling = 100.0

Factor by which the covariance of the input of the reversed filtering is scaled.

This is only used in the backward filtering (if reverseFiltering is true or if the ReverseFilteringLogic return true for the track of interest). Note that the default value is not tuned and might need adjustment for different use cases.