Mercurial > forge
changeset 6702:b8c34004fa45 octave-forge
control-oo: extend documentation
author | paramaniac |
---|---|
date | Sun, 14 Feb 2010 16:53:38 +0000 |
parents | 222365a37492 |
children | f6c72e1e2461 |
files | extra/control-oo/inst/kalman.m |
diffstat | 1 files changed, 40 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/extra/control-oo/inst/kalman.m Sun Feb 14 10:38:51 2010 +0000 +++ b/extra/control-oo/inst/kalman.m Sun Feb 14 16:53:38 2010 +0000 @@ -20,6 +20,46 @@ ## @deftypefnx {Function File} {[@var{est}, @var{g}, @var{x}] =} kalman (@var{sys}, @var{q}, @var{r}, @var{s}) ## @deftypefnx {Function File} {[@var{est}, @var{g}, @var{x}] =} kalman (@var{sys}, @var{q}, @var{r}, @var{s}, @var{sensors}, @var{known}) ## Design Kalman estimator for LTI systems. +## +## @example +## @group +## u +-------+ ^ +## +---------------------------->| |-------> y +## | +-------+ y | est | ^ +## u ----+--->| |------>O------->| |-------> x +## | sys | ^ +-------+ +## w -------->| | | +## +-------+ | v +## +## Q = cov (w, w') R = cov (v, v') S = cov (w, v') +## @end group +## @end example +## +## @strong{Inputs} +## @table @var +## @item sys +## Nominal plant model. +## @item Q +## Covariance of white process noise. +## @item R +## Covariance of white measurement noise. +## @item S +## Optional cross term covariance. +## @item sensors +## Indices of measured output signals y from sys. +## @item known +## Indices of known input signals u to sys. +## @end table +## +## @strong{Outputs} +## @table @var +## @item est +## State-space model of the Kalman estimator +## @item G +## Estimator gain. +## @item X +## Solution of the Riccati equation. +## @end table ## @seealso{care, dare, estim, lqr} ## @end deftypefn