Skip to content

Commit 228a191

Browse files
committed
minor doc correction
1 parent f729c47 commit 228a191

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

src/estimator/kalman.jl

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -382,12 +382,12 @@ is based on the process model :
382382
\mathbf{y^u}(k) &= \mathbf{ĥ^u}\Big(\mathbf{x}(k), \mathbf{d}(k)\Big) \\
383383
\end{aligned}
384384
```
385-
See [`SteadyKalmanFilter`](@ref) for details on ``\mathbf{v}(k), \mathbf{w}(k)`` noises and
386-
``\mathbf{R̂}, \mathbf{Q̂}`` covariances. The functions ``\mathbf{f̂, ĥ}`` are `model`
387-
state-space functions augmented with the stochastic model, which is specified by the numbers
388-
of output integrator `nint_ym` (see Extended Help). The
389-
``\mathbf{ĥ^m}`` function represents the measured outputs of ``\mathbf{ĥ}`` function (and
390-
unmeasured ones, for ``\mathbf{ĥ^u}``).
385+
See [`SteadyKalmanFilter`](@ref) for details on ``\mathbf{v}(k), \mathbf{w}(k)`` noises and
386+
``\mathbf{R̂}, \mathbf{Q̂}`` covariances. The functions ``\mathbf{f̂, ĥ}`` are `model` state-
387+
space functions augmented with the stochastic model, which is specified by the numbers of
388+
integrator `nint_u` and `nint_ym` (see Extended Help). The ``\mathbf{ĥ^m}`` function
389+
represents the measured outputs of ``\mathbf{ĥ}`` function (and unmeasured ones, for
390+
``\mathbf{ĥ^u}``).
391391
392392
# Arguments
393393
- `model::SimModel` : (deterministic) model for the estimations.
@@ -413,9 +413,8 @@ UnscentedKalmanFilter estimator with a sample time Ts = 10.0 s, NonLinModel and:
413413
# Extended Help
414414
The Extended Help of [`SteadyKalmanFilter`](@ref) details the augmentation with `nint_ym`
415415
and `nint_u` arguments. Note that the constructor does not validate the observability of
416-
the resulting augmented [`NonLinModel`]. In such cases, it is the user's responsibility to
417-
ensure that the augmented model is still observable.
418-
```
416+
the resulting augmented [`NonLinModel`](@ref). In such cases, it is the user's
417+
responsibility to ensure that the augmented model is still observable.
419418
"""
420419
function UnscentedKalmanFilter(
421420
model::M;

0 commit comments

Comments
 (0)