Salome HOME
Documentation improvements and post analysis
[modules/adao.git] / doc / fr / ref_algorithm_ExtendedKalmanFilter.rst
index 991ad1c2d1c3917ec346a7a7495293773e84de70..9fc7dbe2a448fd07b7c0a74fe8c963f2c543225a 100644 (file)
@@ -1,5 +1,5 @@
 ..
-   Copyright (C) 2008-2018 EDF R&D
+   Copyright (C) 2008-2021 EDF R&D
 
    This file is part of SALOME ADAO module.
 
 Algorithme de calcul "*ExtendedKalmanFilter*"
 ---------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation de l'état d'un système dynamique par un
 filtre de Kalman étendu, utilisant un calcul non linéaire de l'état et de
 l'évolution incrémentale (processus).
 
+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 et **P** la covariance d'erreur d'état :
+
+  .. _schema_temporel_KF:
+  .. image:: images/schema_temporel_KF.png
+    :align: center
+    :width: 100%
+  .. centered::
+    **Schéma temporel des étapes en assimilation par filtre de Kalman étendu**
+
+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.
+
 Dans le cas d'opérateurs réellement non-linéaires, on peut aisément utiliser
 l':ref:`section_ref_algorithm_EnsembleKalmanFilter` ou
 l':ref:`section_ref_algorithm_UnscentedKalmanFilter`, qui sont souvent
@@ -41,97 +58,143 @@ largement plus adaptés aux comportements non-linéaires mais plus coûteux. On
 peut vérifier la linéarité des opérateurs à l'aide de
 l':ref:`section_ref_algorithm_LinearityTest`.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. index::
+    pair: Variant ; EKF
+    pair: Variant ; CEKF
+
+On fait une différence entre le filtre de Kalman étendu tenant compte de
+bornes sur les états (la variante nommée "CEKF", qui est recommandée et qui est
+utilisée par défaut), et le filtre de Kalman étendu conduit sans
+aucune contrainte (la variante nommée "EKF", qui n'est pas recommandée).
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
+
+.. include:: snippets/Background.rst
+
+.. include:: snippets/BackgroundError.rst
+
+.. include:: snippets/EvolutionError.rst
+
+.. include:: snippets/EvolutionModel.rst
+
+.. include:: snippets/Observation.rst
+
+.. include:: snippets/ObservationError.rst
+
+.. include:: snippets/ObservationOperator.rst
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
+
+.. include:: snippets/BoundsWithNone.rst
+
+.. include:: snippets/ConstrainedBy.rst
+
+.. include:: snippets/EstimationOf.rst
+
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+  *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. 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 sauf les variables inconditionnelles. Les noms possibles
+  sont dans la liste suivante : [
+  "Analysis",
+  "APosterioriCorrelations",
+  "APosterioriCovariance",
+  "APosterioriStandardDeviations",
+  "APosterioriVariances",
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJb",
+  "CostFunctionJbAtCurrentOptimum",
+  "CostFunctionJo",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentIterationNumber",
+  "CurrentOptimum",
+  "CurrentState",
+  "ForecastCovariance",
+  "ForecastState",
+  "IndexOfOptimum",
+  "InnovationAtCurrentAnalysis",
+  "InnovationAtCurrentState",
+  "SimulatedObservationAtCurrentAnalysis",
+  "SimulatedObservationAtCurrentOptimum",
+  "SimulatedObservationAtCurrentState",
+  ].
 
-  .. include:: snippets/Background.rst
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
-  .. include:: snippets/BackgroundError.rst
+.. include:: snippets/Variant_EKF.rst
 
-  .. include:: snippets/EvolutionError.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-  .. include:: snippets/EvolutionModel.rst
+.. include:: snippets/Analysis.rst
 
-  .. include:: snippets/Observation.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/Analysis.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. include:: snippets/APosterioriCorrelations.rst
 
-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.
+.. include:: snippets/APosterioriCovariance.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/APosterioriStandardDeviations.rst
 
-  .. include:: snippets/BoundsWithExtremes.rst
+.. include:: snippets/APosterioriVariances.rst
 
-  .. include:: snippets/ConstrainedBy.rst
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/EstimationOf.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+.. include:: snippets/CostFunctionJAtCurrentOptimum.rst
 
-    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", "CostFunctionJb",
-    "CostFunctionJo", "CurrentState", "Innovation"].
+.. include:: snippets/CostFunctionJb.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. include:: snippets/CostFunctionJo.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/CostFunctionJoAtCurrentOptimum.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/CurrentIterationNumber.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/CurrentOptimum.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/APosterioriCorrelations.rst
+.. include:: snippets/ForecastCovariance.rst
 
-  .. include:: snippets/APosterioriCovariance.rst
+.. include:: snippets/ForecastState.rst
 
-  .. include:: snippets/APosterioriStandardDeviations.rst
+.. include:: snippets/IndexOfOptimum.rst
 
-  .. include:: snippets/APosterioriVariances.rst
+.. include:: snippets/InnovationAtCurrentAnalysis.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/InnovationAtCurrentState.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/SimulatedObservationAtCurrentAnalysis.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-  .. include:: snippets/CurrentState.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-  .. include:: snippets/Innovation.rst
+- :ref:`section_ref_algorithm_KalmanFilter`
+- :ref:`section_ref_algorithm_EnsembleKalmanFilter`
+- :ref:`section_ref_algorithm_UnscentedKalmanFilter`
 
-Voir aussi
-++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
 
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_KalmanFilter`
-  - :ref:`section_ref_algorithm_EnsembleKalmanFilter`
-  - :ref:`section_ref_algorithm_UnscentedKalmanFilter`
+- [WikipediaEKF]_