Salome HOME
Extending sampling control and output
[modules/adao.git] / doc / fr / ref_algorithm_SamplingTest.rst
1 ..
2    Copyright (C) 2008-2023 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: SamplingTest
25 .. _section_ref_algorithm_SamplingTest:
26
27 Algorithme de vérification "*SamplingTest*"
28 -------------------------------------------
29
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo01.rst
32
33 Cet algorithme permet d'établir les valeurs, liées à un état :math:`\mathbf{x}`,
34 d'une fonctionnelle d'erreur :math:`J` quelconque de type :math:`L^1`,
35 :math:`L^2` ou :math:`L^{\infty}`, avec ou sans pondérations, et de l'opérateur
36 d'observation, pour un échantillon d'états donné a priori. La fonctionnelle
37 d'erreur par défaut est celle de moindres carrés pondérés augmentés,
38 classiquement utilisée en assimilation de données.
39
40 Il est utile pour tester la sensibilité, de la fonctionnelle :math:`J`, en
41 particulier, aux variations de l'état :math:`\mathbf{x}`. Lorsque un état n'est
42 pas observable, une valeur *"NaN"* est retournée.
43
44 L'échantillon des états :math:`\mathbf{x}` peut être fourni explicitement ou
45 sous la forme d'hyper-cubes, explicites ou échantillonnés selon des lois
46 courantes. Attention à la taille de l'hyper-cube (et donc au nombre de calculs)
47 qu'il est possible d'atteindre, elle peut rapidement devenir importante.
48
49 Pour apparaître pour l'utilisateur, les résultats de l'échantillonnage doivent
50 être demandés explicitement. On utilise pour cela, sur la variable désirée, la
51 sauvegarde finale à l'aide du mot-clé "*UserPostAnalysis*" ou le traitement en
52 cours de calcul à l'aide des "*observer*" adaptés.
53
54 Pour effectuer un échantillonnage distribué ou plus complexe, voir le module
55 OPENTURNS disponible dans SALOME.
56
57 .. ------------------------------------ ..
58 .. include:: snippets/Header2Algo02.rst
59
60 .. include:: snippets/CheckingPoint.rst
61
62 .. include:: snippets/BackgroundError.rst
63
64 .. include:: snippets/Observation.rst
65
66 .. include:: snippets/ObservationError.rst
67
68 .. include:: snippets/ObservationOperator.rst
69
70 .. ------------------------------------ ..
71 .. include:: snippets/Header2Algo03Chck.rst
72
73 .. include:: snippets/QualityCriterion.rst
74
75 .. include:: snippets/SampleAsExplicitHyperCube.rst
76
77 .. include:: snippets/SampleAsIndependantRandomVariables.rst
78
79 .. include:: snippets/SampleAsMinMaxStepHyperCube.rst
80
81 .. include:: snippets/SampleAsnUplet.rst
82
83 .. include:: snippets/SetDebug.rst
84
85 .. include:: snippets/SetSeed.rst
86
87 StoreSupplementaryCalculations
88   .. index:: single: StoreSupplementaryCalculations
89
90   *Liste de noms*. Cette liste indique les noms des variables supplémentaires,
91   qui peuvent être disponibles au cours du déroulement ou à la fin de
92   l'algorithme, si elles sont initialement demandées par l'utilisateur. Leur
93   disponibilité implique, potentiellement, des calculs ou du stockage coûteux.
94   La valeur par défaut est donc une liste vide, aucune de ces variables n'étant
95   calculée et stockée par défaut (sauf les variables inconditionnelles). Les
96   noms possibles pour les variables supplémentaires sont dans la liste suivante
97   (la description détaillée de chaque variable nommée est donnée dans la suite
98   de cette documentation par algorithme spécifique, dans la sous-partie
99   "*Informations et variables disponibles à la fin de l'algorithme*") : [
100   "CostFunctionJ",
101   "CostFunctionJb",
102   "CostFunctionJo",
103   "CurrentState",
104   "EnsembleOfSimulations",
105   "EnsembleOfStates",
106   "InnovationAtCurrentState",
107   "SimulatedObservationAtCurrentState",
108   ].
109
110   Exemple :
111   ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
112
113 .. ------------------------------------ ..
114 .. include:: snippets/Header2Algo04.rst
115
116 .. include:: snippets/CostFunctionJ.rst
117
118 .. include:: snippets/CostFunctionJb.rst
119
120 .. include:: snippets/CostFunctionJo.rst
121
122 .. ------------------------------------ ..
123 .. include:: snippets/Header2Algo05.rst
124
125 .. include:: snippets/CostFunctionJ.rst
126
127 .. include:: snippets/CostFunctionJb.rst
128
129 .. include:: snippets/CostFunctionJo.rst
130
131 .. include:: snippets/CurrentState.rst
132
133 .. include:: snippets/EnsembleOfSimulations.rst
134
135 .. include:: snippets/EnsembleOfStates.rst
136
137 .. include:: snippets/InnovationAtCurrentState.rst
138
139 .. include:: snippets/SimulatedObservationAtCurrentState.rst
140
141 .. ------------------------------------ ..
142 .. _section_ref_algorithm_SamplingTest_examples:
143 .. include:: snippets/Header2Algo06.rst
144
145 - :ref:`section_ref_algorithm_FunctionTest`
146 - :ref:`section_ref_algorithm_LocalSensitivityTest`
147
148 .. ------------------------------------ ..
149 .. include:: snippets/Header2Algo08.rst
150
151 - OPENTURNS, voir le *Guide utilisateur du module OPENTURNS* dans le menu principal *Aide* de l'environnement SALOME