Template Class KalmanFitter::Actor¶
Defined in File KalmanFitter.hpp
Nested Relationships¶
This class is a nested type of Template Class KalmanFitter.
Class Documentation¶
-
template<typename
source_link_t
, typenameparameters_t
, typenamecalibrator_t
, typenameoutlier_finder_t
>
classActs::KalmanFitter
::
Actor
¶ Propagator Actor plugin for the KalmanFilter.
The KalmanActor does not rely on the measurements to be sorted along the track.
- Template Parameters
source_link_t
: is an type fulfilling theSourceLinkConcept
parameters_t
: The type of parameters used for “local” paremeters.calibrator_t
: The type of calibratoroutlier_finder_t
: Type of the outlier finder class
Public Types
-
using
result_type
= KalmanFitterResult<source_link_t>¶ Broadcast the result_type.
Public Functions
-
template<typename
propagator_state_t
, typenamestepper_t
>
Result<void>filter
(const Surface *surface, propagator_state_t &state, const stepper_t &stepper, result_type &result) const¶ Kalman actor operation : update.
- Template Parameters
propagator_state_t
: is the type of Propagagor statestepper_t
: Type of the stepper
- Parameters
surface
: The surface where the update happensstate
: The mutable propagator state objectstepper
: The stepper in useresult
: The mutable result state object
-
template<typename
propagator_state_t
, typenamestepper_t
>
Result<void>finalize
(propagator_state_t &state, const stepper_t &stepper, result_type &result) const¶ Kalman actor operation : finalize.
- Template Parameters
propagator_state_t
: is the type of Propagagor statestepper_t
: Type of the stepper
- Parameters
state
: is the mutable propagator state objectstepper
: The stepper in useresult
: is the mutable result state object
-
template<typename
propagator_state_t
, typenamestepper_t
>
voidmaterialInteractor
(const Surface *surface, propagator_state_t &state, stepper_t &stepper, const MaterialUpdateStage &updateStage = fullUpdate) const¶ Kalman actor operation : material interaction.
- Template Parameters
propagator_state_t
: is the type of Propagagor statestepper_t
: Type of the stepper
- Parameters
surface
: The surface where the material interaction happensstate
: The mutable propagator state objectstepper
: The stepper in useupdateStage
: The materal update stage
-
template<typename
propagator_state_t
, typenamestepper_t
>
voidoperator()
(propagator_state_t &state, const stepper_t &stepper, result_type &result) const¶ Kalman actor operation.
- Template Parameters
propagator_state_t
: is the type of Propagagor statestepper_t
: Type of the stepper
- Parameters
state
: is the mutable propagator state objectstepper
: The stepper in useresult
: is the mutable result state object
-
template<typename
propagator_state_t
, typenamestepper_t
>
voidreverse
(propagator_state_t &state, stepper_t &stepper, result_type &result) const¶ Kalman actor operation : reverse direction.
- Template Parameters
propagator_state_t
: is the type of Propagagor statestepper_t
: Type of the stepper
- Parameters
state
: is the mutable propagator state objectstepper
: The stepper in useresult
: is the mutable result state objecte
-
template<typename
propagator_state_t
, typenamestepper_t
>
Result<void>reversedFilter
(const Surface *surface, propagator_state_t &state, const stepper_t &stepper, result_type &result) const¶ Kalman actor operation : update in reversed direction.
- Template Parameters
propagator_state_t
: is the type of Propagagor statestepper_t
: Type of the stepper
- Parameters
surface
: The surface where the update happensstate
: The mutable propagator state objectstepper
: The stepper in useresult
: The mutable result state object
Public Members
-
bool
energyLoss
= true¶ Whether to consider energy loss.
-
std::map<GeometryIdentifier, source_link_t>
inputMeasurements
¶ Allows retrieving measurements for a surface.
-
calibrator_t
m_calibrator
¶ The measurement calibrator.
-
outlier_finder_t
m_outlierFinder
¶ The outlier finder.
-
smoother_t
m_smoother
¶ The Kalman smoother.
-
updater_t
m_updater
¶ The Kalman updater.
-
bool
multipleScattering
= true¶ Whether to consider multiple scattering.
-
bool
reversedFiltering
= false¶ Whether run reversed filtering.
-
SurfaceReached
targetReached
¶ The Surface beeing.