#include <acts/blob/sPHENIX/Core/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 *rSurface=nullptr, bool mScattering=true, bool eLoss=true, bool rFiltering=false, double rfScaling=1.0, const FreeToBoundCorrection &freeToBoundCorrection_=FreeToBoundCorrection(false))

	KalmanFitterOptions ()=delete
	Contexts are required and the options must not be default-constructible.

Public Attributes
std::reference_wrapper< const GeometryContext >	geoContext
	Context object for the geometry.

std::reference_wrapper< const MagneticFieldContext >	magFieldContext
	Context object for the magnetic field.

std::reference_wrapper< const CalibrationContext >	calibrationContext
	context object for the calibration

KalmanFitterExtensions< traj_t >	extensions

PropagatorPlainOptions	propagatorPlainOptions
	The trivial propagator options.

const Surface *	referenceSurface = nullptr
	The reference Surface.

KalmanFitterTargetSurfaceStrategy	referenceSurfaceStrategy
	Strategy to propagate to reference surface.

bool	multipleScattering = true
	Whether to consider multiple scattering.

bool	energyLoss = true
	Whether to consider energy loss.

bool	reversedFiltering = false

double	reversedFilteringCovarianceScaling = 1.0

FreeToBoundCorrection	freeToBoundCorrection

Detailed Description

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

Combined options for the Kalman fitter.

Template Parameters

traj_t The trajectory type

Definition at line 117 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 117 of file KalmanFitter.hpp

Constructor & Destructor Documentation

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 *	rSurface = `nullptr`,
		bool	mScattering = `true`,
		bool	eLoss = `true`,
		bool	rFiltering = `false`,
		double	rfScaling = `1.0`,
		const FreeToBoundCorrection &	freeToBoundCorrection_ = `FreeToBoundCorrection(false)`
	)

inline

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
rSurface	The reference surface for the fit to be expressed at
mScattering	Whether to include multiple scattering
eLoss	Whether to include energy loss
rFiltering	Whether to run filtering in reversed direction as smoothing
rfScaling	Scale factor for the covariance matrix before the backward filtering
freeToBoundCorrection_	Correction for non-linearity effect during transform from free to bound

Definition at line 131 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 131 of file KalmanFitter.hpp

template<typename traj_t>

Acts::KalmanFitterOptions< traj_t >::KalmanFitterOptions ( )

delete

Contexts are required and the options must not be default-constructible.

Member Data Documentation

template<typename traj_t>

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

context object for the calibration

Definition at line 160 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 160 of file KalmanFitter.hpp

template<typename traj_t>

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

Whether to consider energy loss.

Definition at line 178 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 178 of file KalmanFitter.hpp

template<typename traj_t>

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

Definition at line 162 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 162 of file KalmanFitter.hpp

template<typename traj_t>

FreeToBoundCorrection Acts::KalmanFitterOptions< traj_t >::freeToBoundCorrection

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

Definition at line 192 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 192 of file KalmanFitter.hpp

template<typename traj_t>

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

Context object for the geometry.

Definition at line 156 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 156 of file KalmanFitter.hpp

Referenced by BOOST_AUTO_TEST_CASE().

template<typename traj_t>

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

Context object for the magnetic field.

Definition at line 158 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 158 of file KalmanFitter.hpp

template<typename traj_t>

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

Whether to consider multiple scattering.

Definition at line 175 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 175 of file KalmanFitter.hpp

template<typename traj_t>

PropagatorPlainOptions Acts::KalmanFitterOptions< traj_t >::propagatorPlainOptions

The trivial propagator options.

Definition at line 165 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 165 of file KalmanFitter.hpp

template<typename traj_t>

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

The reference Surface.

Definition at line 168 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 168 of file KalmanFitter.hpp

Referenced by BOOST_AUTO_TEST_CASE().

template<typename traj_t>

KalmanFitterTargetSurfaceStrategy Acts::KalmanFitterOptions< traj_t >::referenceSurfaceStrategy

Initial value:

=

KalmanFitterTargetSurfaceStrategy::firstOrLast

Strategy to propagate to reference surface.

Definition at line 171 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 171 of file KalmanFitter.hpp

template<typename traj_t>

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

Whether to run filtering in reversed direction overwrite the ReverseFilteringLogic

Definition at line 182 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 182 of file KalmanFitter.hpp

template<typename traj_t>

double Acts::KalmanFitterOptions< traj_t >::reversedFilteringCovarianceScaling = 1.0

Factor by which the covariance of the input of the reversed filtering is scaled. This is only used in the backwardfiltering (if reversedFiltering is true or if the ReverseFilteringLogic return true for the track of interest)

Definition at line 188 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 188 of file KalmanFitter.hpp

The documentation for this struct was generated from the following file:

acts/blob/sPHENIX/Core/include/Acts/TrackFitting/KalmanFitter.hpp

Public Member Functions

Public Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Data Documentation

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