Salome HOME
Improvement of documentation and variables output for filters
[modules/adao.git] / doc / fr / ref_algorithm_KalmanFilter.rst
1 ..
2    Copyright (C) 2008-2019 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: KalmanFilter
25 .. _section_ref_algorithm_KalmanFilter:
26
27 Algorithme de calcul "*KalmanFilter*"
28 -------------------------------------
29
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo01.rst
32
33 Cet algorithme réalise une estimation de l'état d'un système dynamique par un
34 filtre de Kalman.
35
36 Il est théoriquement réservé aux cas d'opérateurs d'observation et d'évolution
37 incrémentale (processus) linéaires, même s'il fonctionne parfois dans les cas
38 "faiblement" non-linéaire. On peut vérifier la linéarité de l'opérateur
39 d'observation à l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
40
41 En cas de non-linéarité, même peu marquée, on lui préférera
42 l':ref:`section_ref_algorithm_ExtendedKalmanFilter`, ou
43 l':ref:`section_ref_algorithm_EnsembleKalmanFilter` et
44 l':ref:`section_ref_algorithm_UnscentedKalmanFilter` qui sont plus puissants.
45
46 .. ------------------------------------ ..
47 .. include:: snippets/Header2Algo02.rst
48
49 .. include:: snippets/Background.rst
50
51 .. include:: snippets/BackgroundError.rst
52
53 .. include:: snippets/EvolutionError.rst
54
55 .. include:: snippets/EvolutionModel.rst
56
57 .. include:: snippets/Observation.rst
58
59 .. include:: snippets/ObservationError.rst
60
61 .. include:: snippets/ObservationOperator.rst
62
63 .. ------------------------------------ ..
64 .. include:: snippets/Header2Algo03AdOp.rst
65
66 .. include:: snippets/EstimationOf.rst
67
68 StoreSupplementaryCalculations
69   .. index:: single: StoreSupplementaryCalculations
70
71   Cette liste indique les noms des variables supplémentaires qui peuvent être
72   disponibles à la fin de l'algorithme, si elles sont initialement demandées par
73   l'utilisateur. Cela implique potentiellement des calculs ou du stockage
74   coûteux. La valeur par défaut est une liste vide, aucune de ces variables
75   n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
76   Les noms possibles sont dans la liste suivante : [
77   "Analysis",
78   "APosterioriCorrelations",
79   "APosterioriCovariance",
80   "APosterioriStandardDeviations",
81   "APosterioriVariances",
82   "BMA",
83   "CostFunctionJ",
84   "CostFunctionJAtCurrentOptimum",
85   "CostFunctionJb",
86   "CostFunctionJbAtCurrentOptimum",
87   "CostFunctionJo",
88   "CostFunctionJoAtCurrentOptimum",
89   "CurrentOptimum",
90   "CurrentState",
91   "IndexOfOptimum",
92   "InnovationAtCurrentAnalysis",
93   "InnovationAtCurrentState",
94   "PredictedState",
95   "SimulatedObservationAtCurrentAnalysis",
96   "SimulatedObservationAtCurrentOptimum",
97   "SimulatedObservationAtCurrentState",
98   ].
99
100   Exemple :
101   ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
102
103 .. ------------------------------------ ..
104 .. include:: snippets/Header2Algo04.rst
105
106 .. include:: snippets/Analysis.rst
107
108 .. ------------------------------------ ..
109 .. include:: snippets/Header2Algo05.rst
110
111 .. include:: snippets/Analysis.rst
112
113 .. include:: snippets/APosterioriCorrelations.rst
114
115 .. include:: snippets/APosterioriCovariance.rst
116
117 .. include:: snippets/APosterioriStandardDeviations.rst
118
119 .. include:: snippets/APosterioriVariances.rst
120
121 .. include:: snippets/BMA.rst
122
123 .. include:: snippets/CostFunctionJ.rst
124
125 .. include:: snippets/CostFunctionJAtCurrentOptimum.rst
126
127 .. include:: snippets/CostFunctionJb.rst
128
129 .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
130
131 .. include:: snippets/CostFunctionJo.rst
132
133 .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
134
135 .. include:: snippets/CurrentOptimum.rst
136
137 .. include:: snippets/CurrentState.rst
138
139 .. include:: snippets/IndexOfOptimum.rst
140
141 .. include:: snippets/InnovationAtCurrentAnalysis.rst
142
143 .. include:: snippets/InnovationAtCurrentState.rst
144
145 .. include:: snippets/PredictedState.rst
146
147 .. include:: snippets/SimulatedObservationAtCurrentAnalysis.rst
148
149 .. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
150
151 .. include:: snippets/SimulatedObservationAtCurrentState.rst
152
153 .. ------------------------------------ ..
154 .. include:: snippets/Header2Algo06.rst
155
156 - :ref:`section_ref_algorithm_ExtendedKalmanFilter`
157 - :ref:`section_ref_algorithm_EnsembleKalmanFilter`
158 - :ref:`section_ref_algorithm_UnscentedKalmanFilter`