Template Struct CombinatorialKalmanFilterOptions

Struct Documentation

template<typename source_link_selector_t>
struct Acts::CombinatorialKalmanFilterOptions

Options struct how the CombinatorialKalmanFilter (CKF) is called.

It contains the context of the CKF call, the source link selector config, the optional surface where to express the track finding/fitting result, config for material effects and whether to run smoothing to get fitted parameters

Template Parameters

  • source_link_selector_t: The source link selector type

Note

the context objects must be provided

Public Types

using SourceLinkSelector = source_link_selector_t
using SourceLinkSelectorConfig = typename SourceLinkSelector::Config

Public Functions

CombinatorialKalmanFilterOptions() = delete

Deleted default constructor.

CombinatorialKalmanFilterOptions(std::reference_wrapper<const GeometryContext> gctx, std::reference_wrapper<const MagneticFieldContext> mctx, std::reference_wrapper<const CalibrationContext> cctx, const SourceLinkSelectorConfig &slsCfg, const Surface *rSurface = nullptr, bool mScattering = true, bool eLoss = true, bool rSmoothing = true)

PropagatorOptions with context.

Parameters

  • gctx: The goemetry context for this track finding/fitting

  • mctx: The magnetic context for this track finding/fitting

  • cctx: The calibration context for this track finding/fitting

  • slsCfg: The config for the source link selector for this track finding/fitting

  • rSurface: The reference surface for the eventual track fitting to be expressed at

  • mScattering: Whether to include multiple scattering

  • eLoss: Whether to include energy loss

  • rSmoothing: Whether to run smoothing to get fitted parameter

Public Members

std::reference_wrapper<const CalibrationContext> calibrationContext

context object for the calibration

bool energyLoss = true

Whether to consider energy loss.

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.

const Surface *referenceSurface = nullptr

The reference Surface.

bool smoothing = true

Whether to run smoothing to get fitted parameter.

SourceLinkSelectorConfig sourcelinkSelectorConfig

The config for the source link selector.