Code and documentation update for ControledFunctionTest

[modules/adao.git] / doc / fr / ref_algorithm_UnscentedKalmanFilter.rst

diff --git a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst
index 25338d7e137abc6fafe766ad2f7d54da84a4c949..2689ddbd1f6e5906e978466943dfabad01c095e3 100644 (file)
--- a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst
+++ b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst
@@ -1,5 +1,5 @@
 ..
-   Copyright (C) 2008-2021 EDF R&D
+   Copyright (C) 2008-2023 EDF R&D
 
    This file is part of SALOME ADAO module.
 
@@ -53,6 +53,15 @@ l':ref:`section_ref_algorithm_KalmanFilter`, qui sont souvent largement moins
 coûteux en évaluation sur de petits systèmes. On peut vérifier la linéarité des
 opérateurs à l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
 
+.. index::
+    pair: Variant ; UKF
+    pair: Variant ; 2UKF
+
+On fait une différence entre le filtre de Kalman "unscented" tenant compte de
+bornes sur les états (la variante nommée "2UKF", qui est recommandée et qui est
+utilisée par défaut), et le filtre de Kalman "unscented" canonique conduit sans
+aucune contrainte (la variante nommée "UKF", qui n'est pas recommandée).
+
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo02.rst
 
@@ -77,20 +86,23 @@ opérateurs à l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
 
 .. include:: snippets/ConstrainedBy.rst
 
-.. include:: snippets/EstimationOf.rst
+.. include:: snippets/EstimationOf_State.rst
 
 .. include:: snippets/AlphaBeta.rst
 
 StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
-  *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+  *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 : [
+  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",
@@ -103,7 +115,6 @@ StoreSupplementaryCalculations
   "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
   "CostFunctionJoAtCurrentOptimum",
-  "CurrentIterationNumber",
   "CurrentOptimum",
   "CurrentState",
   "ForecastCovariance",
@@ -117,7 +128,9 @@ StoreSupplementaryCalculations
   ].
 
   Exemple :
-  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
+  ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
+
+.. include:: snippets/Variant_UKF.rst
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -151,8 +164,6 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-.. include:: snippets/CurrentIterationNumber.rst
-
 .. include:: snippets/CurrentOptimum.rst
 
 .. include:: snippets/CurrentState.rst
@@ -174,6 +185,8 @@ StoreSupplementaryCalculations
 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 
 .. ------------------------------------ ..
+.. _section_ref_algorithm_UnscentedKalmanFilter_examples:
+
 .. include:: snippets/Header2Algo06.rst
 
 - :ref:`section_ref_algorithm_KalmanFilter`