Options struct how the Fitter is called. More...

#include <acts/blob/sPHENIX/Core/include/Acts/TrackFitting/KalmanFitter.hpp>

Collaboration diagram for Acts::KalmanFitterOptions< outlier_finder_t >:

Public Types
using	OutlierFinder = outlier_finder_t

Public Member Functions
	KalmanFitterOptions ()=delete
	Deleted default constructor.

	KalmanFitterOptions (std::reference_wrapper< const GeometryContext > gctx, std::reference_wrapper< const MagneticFieldContext > mctx, std::reference_wrapper< const CalibrationContext > cctx, const OutlierFinder &outlierFinder_, LoggerWrapper logger_, const PropagatorPlainOptions &pOptions, const Surface *rSurface=nullptr, bool mScattering=true, bool eLoss=true, bool bwdFiltering=false)

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

OutlierFinder	outlierFinder
	The config for the outlier finder.

PropagatorPlainOptions	propagatorPlainOptions
	The trivial propagator options.

const Surface *	referenceSurface = nullptr
	The reference Surface.

bool	multipleScattering = true
	Whether to consider multiple scattering.

bool	energyLoss = true
	Whether to consider energy loss.

bool	backwardFiltering = false
	Whether to run backward filtering.

LoggerWrapper	logger
	Logger.

Detailed Description

template<typename outlier_finder_t = VoidOutlierFinder>
struct Acts::KalmanFitterOptions< outlier_finder_t >

Options struct how the Fitter is called.

It contains the context of the fitter call, the outlier finder, the optional surface where to express the fit result and configurations for material effects and smoothing options

Note: the context objects must be provided

Definition at line 52 of file KalmanFitter.hpp.

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

Member Typedef Documentation

template<typename outlier_finder_t = VoidOutlierFinder>

using Acts::KalmanFitterOptions< outlier_finder_t >::OutlierFinder = outlier_finder_t

Definition at line 54 of file KalmanFitter.hpp.

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

Constructor & Destructor Documentation

template<typename outlier_finder_t = VoidOutlierFinder>

Acts::KalmanFitterOptions< outlier_finder_t >::KalmanFitterOptions ( )

delete

Deleted default constructor.

template<typename outlier_finder_t = VoidOutlierFinder>

Acts::KalmanFitterOptions< outlier_finder_t >::KalmanFitterOptions	(	std::reference_wrapper< const GeometryContext >	gctx,
		std::reference_wrapper< const MagneticFieldContext >	mctx,
		std::reference_wrapper< const CalibrationContext >	cctx,
		const OutlierFinder &	outlierFinder_,
		LoggerWrapper	logger_,
		const PropagatorPlainOptions &	pOptions,
		const Surface *	rSurface = `nullptr`,
		bool	mScattering = `true`,
		bool	eLoss = `true`,
		bool	bwdFiltering = `false`
	)

inline

PropagatorOptions with context

Parameters

gctx	The goemetry context for this fit
mctx	The magnetic context for this fit
cctx	The calibration context for this fit
outlierFinder_	The outlier finder
logger_	The logger wrapper
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
bwdFiltering	Whether to run backward filtering as smoothing

Definition at line 71 of file KalmanFitter.hpp.

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

Member Data Documentation

template<typename outlier_finder_t = VoidOutlierFinder>

bool Acts::KalmanFitterOptions< outlier_finder_t >::backwardFiltering = false

Whether to run backward filtering.

Definition at line 114 of file KalmanFitter.hpp.

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

template<typename outlier_finder_t = VoidOutlierFinder>

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

context object for the calibration

Definition at line 96 of file KalmanFitter.hpp.

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

template<typename outlier_finder_t = VoidOutlierFinder>

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

Whether to consider energy loss.

Definition at line 111 of file KalmanFitter.hpp.

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

template<typename outlier_finder_t = VoidOutlierFinder>

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

Context object for the geometry.

Definition at line 92 of file KalmanFitter.hpp.

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

template<typename outlier_finder_t = VoidOutlierFinder>

LoggerWrapper Acts::KalmanFitterOptions< outlier_finder_t >::logger

Logger.

Definition at line 117 of file KalmanFitter.hpp.

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

template<typename outlier_finder_t = VoidOutlierFinder>

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

Context object for the magnetic field.

Definition at line 94 of file KalmanFitter.hpp.

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

template<typename outlier_finder_t = VoidOutlierFinder>

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

Whether to consider multiple scattering.

Definition at line 108 of file KalmanFitter.hpp.

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

template<typename outlier_finder_t = VoidOutlierFinder>

OutlierFinder Acts::KalmanFitterOptions< outlier_finder_t >::outlierFinder

The config for the outlier finder.

Definition at line 99 of file KalmanFitter.hpp.

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

template<typename outlier_finder_t = VoidOutlierFinder>

PropagatorPlainOptions Acts::KalmanFitterOptions< outlier_finder_t >::propagatorPlainOptions

The trivial propagator options.

Definition at line 102 of file KalmanFitter.hpp.

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

template<typename outlier_finder_t = VoidOutlierFinder>

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

The reference Surface.

Definition at line 105 of file KalmanFitter.hpp.

View newest version in sPHENIX GitHub at line 105 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 Types

Public Member Functions

Public Attributes

Detailed Description

template<typename outlier_finder_t = VoidOutlierFinder> struct Acts::KalmanFitterOptions< outlier_finder_t >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Data Documentation

template<typename outlier_finder_t = VoidOutlierFinder>
struct Acts::KalmanFitterOptions< outlier_finder_t >