..
- Copyright (C) 2008-2015 EDF R&D
+ Copyright (C) 2008-2023 EDF R&D
This file is part of SALOME ADAO module.
Algorithme de calcul "*KalmanFilter*"
-------------------------------------
-Description
-+++++++++++
-
-Cet algorithme réalise une estimation de l'état d'un système dynamique par un
-filtre de Kalman.
-
-Il est théoriquement réservé aux cas d'opérateurs d'observation et d'évolution
-incrémentale (processus) linéaires, même s'il fonctionne parfois dans les cas "faiblement"
-non-linéaire. On peut vérifier la linéarité de l'opérateur d'observation à
-l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
-
-En cas de non-linéarité, même peu marquée, on lui préférera
-l':ref:`section_ref_algorithm_ExtendedKalmanFilter` ou
-l':ref:`section_ref_algorithm_UnscentedKalmanFilter`.
-
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
-
-.. index:: single: AlgorithmParameters
-.. index:: single: Background
-.. index:: single: BackgroundError
-.. index:: single: Observation
-.. index:: single: ObservationError
-.. index:: single: ObservationOperator
-.. index:: single: EstimationOf
-.. index:: single: StoreSupplementaryCalculations
-
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
-
- Background
- *Commande obligatoire*. Elle définit le vecteur d'ébauche ou
- d'initialisation, noté précédemment :math:`\mathbf{x}^b`. Sa valeur est
- définie comme un objet de type "*Vector*" ou de type "*VectorSerie*".
-
- BackgroundError
- *Commande obligatoire*. Elle définit la matrice de covariance des erreurs
- d'ébauche, notée précédemment :math:`\mathbf{B}`. Sa valeur est définie
- comme un objet de type "*Matrix*", de type "*ScalarSparseMatrix*", ou de
- type "*DiagonalSparseMatrix*".
-
- Observation
- *Commande obligatoire*. Elle définit le vecteur d'observation utilisé en
- assimilation de données ou en optimisation, et noté précédemment
- :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de type "*Vector*"
- ou de type "*VectorSerie*".
-
- ObservationError
- *Commande obligatoire*. Elle définit la matrice de covariance des erreurs
- d'ébauche, notée précédemment :math:`\mathbf{R}`. Sa valeur est définie
- comme un objet de type "*Matrix*", de type "*ScalarSparseMatrix*", ou de
- type "*DiagonalSparseMatrix*".
-
- ObservationOperator
- *Commande obligatoire*. Elle indique l'opérateur d'observation, noté
- précédemment :math:`H`, qui transforme les paramètres d'entrée
- :math:`\mathbf{x}` en résultats :math:`\mathbf{y}` qui sont à comparer aux
- observations :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de
- type "*Function*" ou de type "*Matrix*". Dans le cas du type "*Function*",
- différentes formes fonctionnelles peuvent être utilisées, comme décrit dans
- la section :ref:`section_ref_operator_requirements`. Si un contrôle
- :math:`U` est inclus dans le modèle d'observation, l'opérateur doit être
- appliqué à une paire :math:`(X,U)`.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
+
+Cet algorithme réalise une estimation de l'état d'un système dynamique par un
+filtre de Kalman. Sous forme discrète, c'est un estimateur itératif (ou
+récursif) de l'état courant à l'aide de l'état précédent et des observations
+actuelles. Le temps (ou pseudo-temps) entre deux pas est celui qui sépare les
+observations successives. Chaque pas d'itération est composé de deux étapes
+successives dites classiquement de "*prédiction*" puis de "*correction*".
+L'étape de prédiction utilise un opérateur d'évolution incrémentale pour
+établir une estimation de l'état courant à partir de l'état estimé au pas
+précédent. L'étape de correction (ou de *mise à jour*) utilise les observations
+courantes pour améliorer l'estimation en corrigeant l'état prédit.
+
+Il est théoriquement réservé aux cas d'opérateurs d'observation et d'évolution
+incrémentale (processus) linéaires, même s'il fonctionne parfois dans les cas
+"faiblement" non-linéaire. On peut vérifier la linéarité de l'opérateur
+d'observation à l'aide d'un :ref:`section_ref_algorithm_LinearityTest`.
+
+Conceptuellement, on peut représenter le schéma temporel d'action des
+opérateurs d'évolution et d'observation dans cet algorithme de la manière
+suivante, avec **x** l'état, **P** la covariance d'erreur d'état, *t* le temps
+itératif discret :
+
+ .. _schema_temporel_KF:
+ .. image:: images/schema_temporel_KF.png
+ :align: center
+ :width: 100%
+ .. centered::
+ **Schéma temporel des étapes en assimilation de données par filtre de Kalman**
+
+Dans ce schéma, l'analyse **(x,P)** est obtenue à travers la "*correction*" par
+l'observation de la "*prévision*" de l'état précédent. On remarque qu'il n'y a
+pas d'analyse effectuée au pas de temps initial (numéroté 0 dans l'indexage
+temporel) car il n'y a pas de prévision à cet instant (l'ébauche est stockée
+comme pseudo-analyse au pas initial). Si les observations sont fournies en
+série par l'utilisateur, la première n'est donc pas utilisée.
+
+Ce filtre peut aussi être utilisé pour estimer (conjointement ou uniquement)
+des paramètres et non pas l'état, auquel cas ni le temps ni l'évolution n'ont
+plus de signification. Les pas d'itération sont alors liés à l'insertion d'une
+nouvelle observation dans l'estimation récursive. On consultera la section
+:ref:`section_theory_dynamique` pour les concepts de mise en oeuvre.
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les options
-particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+En cas de non-linéarité des opérateurs, même peu marquée, on lui préférera un
+:ref:`section_ref_algorithm_ExtendedKalmanFilter`, ou un
+:ref:`section_ref_algorithm_EnsembleKalmanFilter` et un
+:ref:`section_ref_algorithm_UnscentedKalmanFilter` qui sont plus stables,
+supportent des bornes sur l'état, etc. On peut vérifier la linéarité des
+opérateurs à l'aide d'un :ref:`section_ref_algorithm_LinearityTest`.
-Les options de l'algorithme sont les suivantes:
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
- EstimationOf
- Cette clé permet de choisir le type d'estimation à réaliser. Cela peut être
- soit une estimation de l'état, avec la valeur "State", ou une estimation de
- paramètres, avec la valeur "Parameters". Le choix par défaut est "State".
+.. include:: snippets/Background.rst
- Exemple : ``{"EstimationOf":"Parameters"}``
+.. include:: snippets/BackgroundError.rst
- StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme. Cela implique potentiellement des
- calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
- aucune de ces variables n'étant calculée et stockée par défaut. Les noms
- possibles sont dans la liste suivante : ["APosterioriCorrelations",
- "APosterioriCovariance", "APosterioriStandardDeviations",
- "APosterioriVariances", "BMA", "CostFunctionJ", "CurrentState",
- "Innovation"].
+.. include:: snippets/EvolutionError.rst
- Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+.. include:: snippets/EvolutionModel.rst
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. include:: snippets/Observation.rst
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/ObservationError.rst
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/ObservationOperator.rst
- Analysis
- *Liste de vecteurs*. Chaque élément est un état optimal :math:`\mathbf{x}*`
- en optimisation ou une analyse :math:`\mathbf{x}^a` en assimilation de
- données.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
- Exemple : ``Xa = ADD.get("Analysis")[-1]``
+.. include:: snippets/EstimationOf_State.rst
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+StoreSupplementaryCalculations
+ .. index:: single: StoreSupplementaryCalculations
- APosterioriCorrelations
- *Liste de matrices*. Chaque élément est une matrice de corrélation des
- erreurs *a posteriori* de l'état optimal.
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires,
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Leur
+ disponibilité implique, potentiellement, des calculs ou du stockage coûteux.
+ La valeur par défaut est donc une liste vide, aucune de ces variables n'étant
+ calculée et stockée par défaut (sauf les variables inconditionnelles). Les
+ noms possibles pour les variables supplémentaires sont dans la liste suivante
+ (la description détaillée de chaque variable nommée est donnée dans la suite
+ de cette documentation par algorithme spécifique, dans la sous-partie
+ "*Informations et variables disponibles à la fin de l'algorithme*") : [
+ "Analysis",
+ "APosterioriCorrelations",
+ "APosterioriCovariance",
+ "APosterioriStandardDeviations",
+ "APosterioriVariances",
+ "BMA",
+ "CostFunctionJ",
+ "CostFunctionJAtCurrentOptimum",
+ "CostFunctionJb",
+ "CostFunctionJbAtCurrentOptimum",
+ "CostFunctionJo",
+ "CostFunctionJoAtCurrentOptimum",
+ "CurrentOptimum",
+ "CurrentState",
+ "CurrentStepNumber",
+ "ForecastCovariance",
+ "ForecastState",
+ "IndexOfOptimum",
+ "InnovationAtCurrentAnalysis",
+ "InnovationAtCurrentState",
+ "SimulatedObservationAtCurrentAnalysis",
+ "SimulatedObservationAtCurrentOptimum",
+ "SimulatedObservationAtCurrentState",
+ ].
- Exemple : ``C = ADD.get("APosterioriCorrelations")[-1]``
+ Exemple :
+ ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
- APosterioriCovariance
- *Liste de matrices*. Chaque élément est une matrice :math:`\mathbf{A}*` de
- covariances des erreurs *a posteriori* de l'état optimal.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
- Exemple : ``A = ADD.get("APosterioriCovariance")[-1]``
+.. include:: snippets/Analysis.rst
- APosterioriStandardDeviations
- *Liste de matrices*. Chaque élément est une matrice d'écart-types des
- erreurs *a posteriori* de l'état optimal.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
- Exemple : ``E = ADD.get("APosterioriStandardDeviations")[-1]``
+.. include:: snippets/Analysis.rst
- APosterioriVariances
- *Liste de matrices*. Chaque élément est une matrice de variances des erreurs
- *a posteriori* de l'état optimal.
+.. include:: snippets/APosterioriCorrelations.rst
- Exemple : ``V = ADD.get("APosterioriVariances")[-1]``
+.. include:: snippets/APosterioriCovariance.rst
- BMA
- *Liste de vecteurs*. Chaque élément est un vecteur d'écart entre
- l'ébauche et l'état optimal.
+.. include:: snippets/APosterioriStandardDeviations.rst
- Exemple : ``bma = ADD.get("BMA")[-1]``
+.. include:: snippets/APosterioriVariances.rst
- CostFunctionJ
- *Liste de valeurs*. Chaque élément est une valeur de fonctionnelle d'écart
- :math:`J`.
+.. include:: snippets/BMA.rst
- Exemple : ``J = ADD.get("CostFunctionJ")[:]``
+.. include:: snippets/CostFunctionJ.rst
- CostFunctionJb
- *Liste de valeurs*. Chaque élément est une valeur de fonctionnelle d'écart
- :math:`J^b`, c'est-à-dire de la partie écart à l'ébauche.
+.. include:: snippets/CostFunctionJAtCurrentOptimum.rst
- Exemple : ``Jb = ADD.get("CostFunctionJb")[:]``
+.. include:: snippets/CostFunctionJb.rst
- CostFunctionJo
- *Liste de valeurs*. Chaque élément est une valeur de fonctionnelle d'écart
- :math:`J^o`, c'est-à-dire de la partie écart à l'observation.
+.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
- Exemple : ``Jo = ADD.get("CostFunctionJo")[:]``
+.. include:: snippets/CostFunctionJo.rst
- CurrentState
- *Liste de vecteurs*. Chaque élément est un vecteur d'état courant utilisé
- au cours du déroulement de l'algorithme d'optimisation.
+.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
- Exemple : ``Xs = ADD.get("CurrentState")[:]``
+.. include:: snippets/CurrentOptimum.rst
- Innovation
- *Liste de vecteurs*. Chaque élément est un vecteur d'innovation, qui est
- en statique l'écart de l'optimum à l'ébauche, et en dynamique l'incrément
- d'évolution.
+.. include:: snippets/CurrentState.rst
- Exemple : ``d = ADD.get("Innovation")[-1]``
+.. include:: snippets/CurrentStepNumber.rst
-Voir aussi
-++++++++++
+.. include:: snippets/ForecastCovariance.rst
-Références vers d'autres sections :
- - :ref:`section_ref_algorithm_ExtendedKalmanFilter`
- - :ref:`section_ref_algorithm_UnscentedKalmanFilter`
+.. include:: snippets/ForecastState.rst
+
+.. include:: snippets/IndexOfOptimum.rst
+
+.. include:: snippets/InnovationAtCurrentAnalysis.rst
+
+.. include:: snippets/InnovationAtCurrentState.rst
+
+.. include:: snippets/SimulatedObservationAtCurrentAnalysis.rst
+
+.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
+
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
+
+.. ------------------------------------ ..
+.. _section_ref_algorithm_KalmanFilter_examples:
+
+.. include:: snippets/Header2Algo09.rst
+
+.. --------- ..
+.. include:: scripts/simple_KalmanFilter1.rst
+
+.. literalinclude:: scripts/simple_KalmanFilter1.py
+
+.. include:: snippets/Header2Algo10.rst
+
+.. literalinclude:: scripts/simple_KalmanFilter1.res
+ :language: none
+
+.. include:: snippets/Header2Algo11.rst
+
+.. _simple_KalmanFilter1_state:
+.. image:: scripts/simple_KalmanFilter1_state.png
+ :align: center
+ :width: 90%
+
+.. _simple_KalmanFilter1_variance:
+.. image:: scripts/simple_KalmanFilter1_variance.png
+ :align: center
+ :width: 90%
+
+.. --------- ..
+.. include:: scripts/simple_KalmanFilter2.rst
+
+.. literalinclude:: scripts/simple_KalmanFilter2.py
+
+.. include:: snippets/Header2Algo10.rst
+
+.. literalinclude:: scripts/simple_KalmanFilter2.res
+ :language: none
+
+.. include:: snippets/Header2Algo11.rst
+
+.. _simple_KalmanFilter2_state:
+.. image:: scripts/simple_KalmanFilter2_state.png
+ :align: center
+ :width: 90%
+
+.. _simple_KalmanFilter2_variance:
+.. image:: scripts/simple_KalmanFilter2_variance.png
+ :align: center
+ :width: 90%
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
+
+- :ref:`section_ref_algorithm_ExtendedKalmanFilter`
+- :ref:`section_ref_algorithm_EnsembleKalmanFilter`
+- :ref:`section_ref_algorithm_UnscentedKalmanFilter`
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
+
+- [Welch06]_
+- [WikipediaKF]_
