Salome HOME
Documentation corrections and improvements
[modules/adao.git] / doc / fr / ref_algorithm_ExtendedKalmanFilter.rst
index bd89b9295541eec3ec77988f1dfb0123baf2ce13..38700a83c03c4a3e646e9527c153c4bd6504e1de 100644 (file)
@@ -1,5 +1,5 @@
 ..
-   Copyright (C) 2008-2014 EDF R&D
+   Copyright (C) 2008-2015 EDF R&D
 
    This file is part of SALOME ADAO module.
 
@@ -101,27 +101,97 @@ Les options de l'algorithme sont les suivantes:
     une valeur extrême chaque fois qu'il n'y a pas de borne (``None`` n'est pas
     une valeur autorisée lorsqu'il n'y a pas de borne).
 
-  ConstrainedBy
-    Cette clé permet de définir la méthode pour prendre en compte les bornes. Les
-    méthodes possibles sont dans la liste suivante : ["EstimateProjection"].
+    Exemple : ``{"Bounds":[[2.,5.],[1.e-2,10.],[-30.,1.e99],[-1.e99,1.e99]]}``
 
   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".
 
+    Exemple : ``{"EstimationOf":"Parameters"}``
+
   StoreInternalVariables
     Cette clé booléenne permet de stocker les variables internes par défaut,
     principalement l'état courant lors d'un processus itératif. Attention, cela
     peut être un choix numériquement coûteux dans certains cas de calculs. La
     valeur par défaut est "False".
 
+    Exemple : ``{"StoreInternalVariables":True}``
+
   StoreSupplementaryCalculations
     Cette liste indique les noms des variables supplémentaires qui peuvent être
     disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs 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 : ["APosterioriCovariance", "BMA", "Innovation"].
+    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 : ["APosterioriCovariance", "BMA",
+    "Innovation"].
+
+    Exemple : ``{"StoreSupplementaryCalculations":["BMA","Innovation"]}``
+
+Informations et variables disponibles à la fin de l'algorithme
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+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`.
+
+Les sorties non conditionnelles de l'algorithme sont les suivantes:
+
+  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.
+
+    Exemple : ``Xa = ADD.get("Analysis")[-1]``
+
+Les sorties conditionnelles de l'algorithme sont les suivantes:
+
+  APosterioriCovariance
+    *Liste de matrices*. Chaque élément est une matrice :math:`\mathbf{A}*` de
+    covariances des erreurs *a posteriori* de l'état optimal.
+
+    Exemple : ``A = ADD.get("APosterioriCovariance")[-1]``
+
+  BMA
+    *Liste de vecteurs*. Chaque élément est un vecteur d'écart entre
+    l'ébauche et l'état optimal.
+
+    Exemple : ``bma = ADD.get("BMA")[-1]``
+
+  CostFunctionJ
+    *Liste de valeurs*. Chaque élément est une valeur de fonctionnelle d'écart
+    :math:`J`.
+
+    Exemple : ``J = ADD.get("CostFunctionJ")[:]``
+
+  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.
+
+    Exemple : ``Jb = ADD.get("CostFunctionJb")[:]``
+
+  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.
+
+    Exemple : ``Jo = ADD.get("CostFunctionJo")[:]``
+
+  CurrentState
+    *Liste de vecteurs*. Chaque élément est un vecteur d'état courant utilisé
+    au cours du déroulement de l'algorithme d'optimisation.
+
+    Exemple : ``Xs = ADD.get("CurrentState")[:]``
+
+  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.
+
+    Exemple : ``d = ADD.get("Innovation")[-1]``
 
 Voir aussi
 ++++++++++