doc/en/ref_algorithm_UnscentedKalmanFilter.rst

   1 ..
   2    Copyright (C) 2008-2014 EDF R&D
   3
   4    This file is part of SALOME ADAO module.
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with this library; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19
  20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  23
  24 .. index:: single: UnscentedKalmanFilter
  25 .. _section_ref_algorithm_UnscentedKalmanFilter:
  26
  27 Calculation algorithm "*UnscentedKalmanFilter*"
  28 -----------------------------------------------
  29
  30 Description
  31 +++++++++++
  32
  33 This algorithm realizes an estimation of the state of a dynamic system by a
  34 "unscented" Kalman Filter, avoiding to have to perform the tangent and adjoint
  35 operators for the observation and evolution operators, as in the simple or
  36 extended Kalman filter.
  37
  38 Optional and required commands
  39 ++++++++++++++++++++++++++++++
  40
  41 .. index:: single: Background
  42 .. index:: single: BackgroundError
  43 .. index:: single: Observation
  44 .. index:: single: ObservationError
  45 .. index:: single: ObservationOperator
  46 .. index:: single: Bounds
  47 .. index:: single: ConstrainedBy
  48 .. index:: single: EstimationOf
  49 .. index:: single: Alpha
  50 .. index:: single: Beta
  51 .. index:: single: Kappa
  52 .. index:: single: Reconditioner
  53 .. index:: single: StoreInternalVariables
  54 .. index:: single: StoreSupplementaryCalculations
  55
  56 The general required commands, available in the editing user interface, are the
  57 following:
  58
  59   Background
  60     *Required command*. This indicates the background or initial vector used,
  61     previously noted as :math:`\mathbf{x}^b`. Its value is defined as a
  62     "*Vector*" or a *VectorSerie*" type object.
  63
  64   BackgroundError
  65     *Required command*. This indicates the background error covariance matrix,
  66     previously noted as :math:`\mathbf{B}`. Its value is defined as a "*Matrix*"
  67     type object, a "*ScalarSparseMatrix*" type object, or a
  68     "*DiagonalSparseMatrix*" type object.
  69
  70   Observation
  71     *Required command*. This indicates the observation vector used for data
  72     assimilation or optimization, previously noted as :math:`\mathbf{y}^o`. It
  73     is defined as a "*Vector*" or a *VectorSerie* type object.
  74
  75   ObservationError
  76     *Required command*. This indicates the observation error covariance matrix,
  77     previously noted as :math:`\mathbf{R}`. It is defined as a "*Matrix*" type
  78     object, a "*ScalarSparseMatrix*" type object, or a "*DiagonalSparseMatrix*"
  79     type object.
  80
  81   ObservationOperator
  82     *Required command*. This indicates the observation operator, previously
  83     noted :math:`H`, which transforms the input parameters :math:`\mathbf{x}` to
  84     results :math:`\mathbf{y}` to be compared to observations
  85     :math:`\mathbf{y}^o`. Its value is defined as a "*Function*" type object or
  86     a "*Matrix*" type one. In the case of "*Function*" type, different
  87     functional forms can be used, as described in the section
  88     :ref:`section_ref_operator_requirements`. If there is some control :math:`U`
  89     included in the observation, the operator has to be applied to a pair
  90     :math:`(X,U)`.
  91
  92 The general optional commands, available in the editing user interface, are
  93 indicated in :ref:`section_ref_assimilation_keywords`. In particular, the
  94 optional command "*AlgorithmParameters*" allows to choose the specific options,
  95 described hereafter, of the algorithm. See
  96 :ref:`section_ref_options_AlgorithmParameters` for the good use of this command.
  97
  98 The options of the algorithm are the following:
  99
 100   Bounds
 101     This key allows to define upper and lower bounds for every state variable
 102     being optimized. Bounds have to be given by a list of list of pairs of
 103     lower/upper bounds for each variable, with extreme values every time there
 104     is no bound (``None`` is not allowed when there is no bound).
 105
 106     Example : ``{"Bounds":[[2.,5.],[1.e-2,10.],[-30.,1.e99],[-1.e99,1.e99]]}``
 107
 108   EstimationOf
 109     This key allows to choose the type of estimation to be performed. It can be
 110     either state-estimation, with a value of "State", or parameter-estimation,
 111     with a value of "Parameters". The default choice is "State".
 112
 113     Example : ``{"EstimationOf":"Parameters"}``
 114
 115   Alpha, Beta, Kappa, Reconditioner
 116     These keys are internal scaling parameters. "Alpha" requires a value between
 117     1.e-4 and 1. "Beta" has an optimal value of 2 for Gaussian *a priori*
 118     distribution. "Kappa" requires an integer value, and the right default is
 119     obtained by setting it to 0. "Reconditioner" requires a value between 1.e-3
 120     and 10, it defaults to 1.
 121
 122     Example : ``{"Alpha":1,"Beta":2,"Kappa":0,"Reconditioner":1}``
 123
 124   StoreInternalVariables
 125     This Boolean key allows to store default internal variables, mainly the
 126     current state during iterative optimization process. Be careful, this can be
 127     a numerically costly choice in certain calculation cases. The default is
 128     "False".
 129
 130     Example : ``{"StoreInternalVariables":True}``
 131
 132   StoreSupplementaryCalculations
 133     This list indicates the names of the supplementary variables that can be
 134     available at the end of the algorithm. It involves potentially costly
 135     calculations or memory consumptions. The default is a void list, none of
 136     these variables being calculated and stored by default. The possible names
 137     are in the following list: ["APosterioriCovariance", "BMA", "Innovation"].
 138
 139     Example : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
 140
 141 See also
 142 ++++++++
 143
 144 References to other sections:
 145   - :ref:`section_ref_algorithm_KalmanFilter`
 146   - :ref:`section_ref_algorithm_ExtendedKalmanFilter`
 147
 148 Bibliographical references:
 149   - [WikipediaUKF]_