Skip to content

Commit

Permalink
minor doc correction
Browse files Browse the repository at this point in the history
  • Loading branch information
franckgaga committed Sep 7, 2023
1 parent f729c47 commit 228a191
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions src/estimator/kalman.jl
Original file line number Diff line number Diff line change
Expand Up @@ -382,12 +382,12 @@ is based on the process model :
\mathbf{y^u}(k) &= \mathbf{ĥ^u}\Big(\mathbf{x}(k), \mathbf{d}(k)\Big) \\
\end{aligned}
```
See [`SteadyKalmanFilter`](@ref) for details on ``\mathbf{v}(k), \mathbf{w}(k)`` noises and
``\mathbf{R̂}, \mathbf{Q̂}`` covariances. The functions ``\mathbf{f̂, ĥ}`` are `model`
state-space functions augmented with the stochastic model, which is specified by the numbers
of output integrator `nint_ym` (see Extended Help). The
``\mathbf{ĥ^m}`` function represents the measured outputs of ``\mathbf{ĥ}`` function (and
unmeasured ones, for ``\mathbf{ĥ^u}``).
See [`SteadyKalmanFilter`](@ref) for details on ``\mathbf{v}(k), \mathbf{w}(k)`` noises and
``\mathbf{R̂}, \mathbf{Q̂}`` covariances. The functions ``\mathbf{f̂, ĥ}`` are `model` state-
space functions augmented with the stochastic model, which is specified by the numbers of
integrator `nint_u` and `nint_ym` (see Extended Help). The ``\mathbf{ĥ^m}`` function
represents the measured outputs of ``\mathbf{ĥ}`` function (and unmeasured ones, for
``\mathbf{ĥ^u}``).
# Arguments
- `model::SimModel` : (deterministic) model for the estimations.
Expand All @@ -413,9 +413,8 @@ UnscentedKalmanFilter estimator with a sample time Ts = 10.0 s, NonLinModel and:
# Extended Help
The Extended Help of [`SteadyKalmanFilter`](@ref) details the augmentation with `nint_ym`
and `nint_u` arguments. Note that the constructor does not validate the observability of
the resulting augmented [`NonLinModel`]. In such cases, it is the user's responsibility to
ensure that the augmented model is still observable.
```
the resulting augmented [`NonLinModel`](@ref). In such cases, it is the user's
responsibility to ensure that the augmented model is still observable.
"""
function UnscentedKalmanFilter(
model::M;
Expand Down

0 comments on commit 228a191

Please sign in to comment.