Salome HOME
Documentation and source improvements
[modules/adao.git] / src / daComposant / daAlgorithms / ExtendedBlue.py
1 #-*-coding:iso-8859-1-*-
2 #
3 #  Copyright (C) 2008-2015 EDF R&D
4 #
5 #  This library is free software; you can redistribute it and/or
6 #  modify it under the terms of the GNU Lesser General Public
7 #  License as published by the Free Software Foundation; either
8 #  version 2.1 of the License.
9 #
10 #  This library is distributed in the hope that it will be useful,
11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 #  Lesser General Public License for more details.
14 #
15 #  You should have received a copy of the GNU Lesser General Public
16 #  License along with this library; if not, write to the Free Software
17 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
18 #
19 #  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #
21 #  Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
22
23 import logging
24 from daCore import BasicObjects
25 import numpy
26
27 # ==============================================================================
28 class ElementaryAlgorithm(BasicObjects.Algorithm):
29     def __init__(self):
30         BasicObjects.Algorithm.__init__(self, "EXTENDEDBLUE")
31         self.defineRequiredParameter(
32             name     = "StoreInternalVariables",
33             default  = False,
34             typecast = bool,
35             message  = "Stockage des variables internes ou intermédiaires du calcul",
36             )
37         self.defineRequiredParameter(
38             name     = "StoreSupplementaryCalculations",
39             default  = [],
40             typecast = tuple,
41             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
42             listval  = ["APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", "APosterioriVariances", "BMA", "OMA", "OMB", "CostFunctionJ", "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles", "SimulatedObservationAtBackground", "SimulatedObservationAtOptimum"]
43             )
44         self.defineRequiredParameter(
45             name     = "Quantiles",
46             default  = [],
47             typecast = tuple,
48             message  = "Liste des valeurs de quantiles",
49             minval   = 0.,
50             maxval   = 1.,
51             )
52         self.defineRequiredParameter(
53             name     = "SetSeed",
54             typecast = numpy.random.seed,
55             message  = "Graine fixée pour le générateur aléatoire",
56             )
57         self.defineRequiredParameter(
58             name     = "NumberOfSamplesForQuantiles",
59             default  = 100,
60             typecast = int,
61             message  = "Nombre d'échantillons simulés pour le calcul des quantiles",
62             minval   = 1,
63             )
64         self.defineRequiredParameter(
65             name     = "SimulationForQuantiles",
66             default  = "Linear",
67             typecast = str,
68             message  = "Type de simulation pour l'estimation des quantiles",
69             listval  = ["Linear", "NonLinear"]
70             )
71
72     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
73         self._pre_run()
74         #
75         # Paramètres de pilotage
76         # ----------------------
77         self.setParameters(Parameters)
78         #
79         # Opérateur d'observation
80         # -----------------------
81         Hm = HO["Tangent"].asMatrix(Xb)
82         Hm = Hm.reshape(Y.size,Xb.size) # ADAO & check shape
83         Ha = HO["Adjoint"].asMatrix(Xb)
84         Ha = Ha.reshape(Xb.size,Y.size) # ADAO & check shape
85         H  = HO["Direct"].appliedTo
86         #
87         # Utilisation éventuelle d'un vecteur H(Xb) précalculé
88         # ----------------------------------------------------
89         if HO["AppliedToX"] is not None and HO["AppliedToX"].has_key("HXb"):
90             HXb = HO["AppliedToX"]["HXb"]
91         else:
92             HXb = H( Xb )
93         HXb = numpy.asmatrix(numpy.ravel( HXb )).T
94         #
95         # Précalcul des inversions de B et R
96         # ----------------------------------
97         BI = B.getI()
98         RI = R.getI()
99         #
100         # Calcul de l'innovation
101         # ----------------------
102         if Y.size != HXb.size:
103             raise ValueError("The size %i of observations Y and %i of observed calculation H(X) are different, they have to be identical."%(Y.size,HXb.size))
104         if max(Y.shape) != max(HXb.shape):
105             raise ValueError("The shapes %s of observations Y and %s of observed calculation H(X) are different, they have to be identical."%(Y.shape,HXb.shape))
106         d  = Y - HXb
107         #
108         # Calcul de la matrice de gain et de l'analyse
109         # --------------------------------------------
110         if Y.size <= Xb.size:
111             if Y.size > 100: # len(R)
112                 _A = R + Hm * B * Ha
113                 _u = numpy.linalg.solve( _A , d )
114                 Xa = Xb + B * Ha * _u
115             else:
116                 K  = B * Ha * (R + Hm * B * Ha).I
117                 Xa = Xb + K*d
118         else:
119             if Y.size > 100: # len(R)
120                 _A = BI + Ha * RI * Hm
121                 _u = numpy.linalg.solve( _A , Ha * RI * d )
122                 Xa = Xb + _u
123             else:
124                 K = (BI + Ha * RI * Hm).I * Ha * RI
125                 Xa = Xb + K*d
126         self.StoredVariables["Analysis"].store( Xa.A1 )
127         #
128         # Calcul de la fonction coût
129         # --------------------------
130         if self._parameters["StoreInternalVariables"] or \
131            "CostFunctionJ"                 in self._parameters["StoreSupplementaryCalculations"] or \
132            "OMA"                           in self._parameters["StoreSupplementaryCalculations"] or \
133            "SigmaObs2"                     in self._parameters["StoreSupplementaryCalculations"] or \
134            "MahalanobisConsistency"        in self._parameters["StoreSupplementaryCalculations"] or \
135            "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"] or \
136            "SimulationQuantiles"           in self._parameters["StoreSupplementaryCalculations"]:
137             HXa  = numpy.matrix(numpy.ravel( H( Xa ) )).T
138             oma = Y - HXa
139         if self._parameters["StoreInternalVariables"] or \
140            "CostFunctionJ"                 in self._parameters["StoreSupplementaryCalculations"] or \
141            "MahalanobisConsistency"        in self._parameters["StoreSupplementaryCalculations"]:
142             Jb  = 0.5 * (Xa - Xb).T * BI * (Xa - Xb)
143             Jo  = 0.5 * oma.T * RI * oma
144             J   = float( Jb ) + float( Jo )
145             self.StoredVariables["CostFunctionJb"].store( Jb )
146             self.StoredVariables["CostFunctionJo"].store( Jo )
147             self.StoredVariables["CostFunctionJ" ].store( J )
148         #
149         # Calcul de la covariance d'analyse
150         # ---------------------------------
151         if "APosterioriCovariance" in self._parameters["StoreSupplementaryCalculations"] or \
152            "SimulationQuantiles" in self._parameters["StoreSupplementaryCalculations"]:
153             if   (Y.size <= Xb.size) and (Y.size > 100): K  = B * Ha * (R + Hm * B * Ha).I
154             elif (Y.size >  Xb.size) and (Y.size > 100): K = (BI + Ha * RI * Hm).I * Ha * RI
155             else:                                        pass # K deja calcule
156             A = B - K * Hm * B
157             if min(A.shape) != max(A.shape):
158                 raise ValueError("The %s a posteriori covariance matrix A is of shape %s, despites it has to be a squared matrix. There is an error in the observation operator, please check it."%(self._name,str(A.shape)))
159             if (numpy.diag(A) < 0).any():
160                 raise ValueError("The %s a posteriori covariance matrix A has at least one negative value on its diagonal. There is an error in the observation operator, please check it."%(self._name,))
161             if logging.getLogger().level < logging.WARNING: # La verification n'a lieu qu'en debug
162                 try:
163                     L = numpy.linalg.cholesky( A )
164                 except:
165                     raise ValueError("The %s a posteriori covariance matrix A is not symmetric positive-definite. Please check your a priori covariances and your observation operator."%(self._name,))
166             self.StoredVariables["APosterioriCovariance"].store( A )
167         #
168         # Calculs et/ou stockages supplémentaires
169         # ---------------------------------------
170         if "Innovation" in self._parameters["StoreSupplementaryCalculations"]:
171             self.StoredVariables["Innovation"].store( numpy.ravel(d) )
172         if "BMA" in self._parameters["StoreSupplementaryCalculations"]:
173             self.StoredVariables["BMA"].store( numpy.ravel(Xb) - numpy.ravel(Xa) )
174         if "OMA" in self._parameters["StoreSupplementaryCalculations"]:
175             self.StoredVariables["OMA"].store( numpy.ravel(oma) )
176         if "OMB" in self._parameters["StoreSupplementaryCalculations"]:
177             self.StoredVariables["OMB"].store( numpy.ravel(d) )
178         if "SigmaObs2" in self._parameters["StoreSupplementaryCalculations"]:
179             TraceR = R.trace(Y.size)
180             self.StoredVariables["SigmaObs2"].store( float( (d.T * (numpy.asmatrix(numpy.ravel(oma)).T)) ) / TraceR )
181         if "SigmaBck2" in self._parameters["StoreSupplementaryCalculations"]:
182             self.StoredVariables["SigmaBck2"].store( float( (d.T * Hm * (Xa - Xb))/(Hm * B * Hm.T).trace() ) )
183         if "MahalanobisConsistency" in self._parameters["StoreSupplementaryCalculations"]:
184             self.StoredVariables["MahalanobisConsistency"].store( float( 2.*J/d.size ) )
185         if "SimulationQuantiles" in self._parameters["StoreSupplementaryCalculations"]:
186             Qtls = self._parameters["Quantiles"]
187             nech = self._parameters["NumberOfSamplesForQuantiles"]
188             HtM  = HO["Tangent"].asMatrix(ValueForMethodForm = Xa)
189             HtM  = HtM.reshape(Y.size,Xa.size) # ADAO & check shape
190             YfQ  = None
191             for i in range(nech):
192                 if self._parameters["SimulationForQuantiles"] == "Linear":
193                     dXr = numpy.matrix(numpy.random.multivariate_normal(Xa.A1,A) - Xa.A1).T
194                     dYr = numpy.matrix(numpy.ravel( HtM * dXr )).T
195                     Yr = HXa + dYr
196                 elif self._parameters["SimulationForQuantiles"] == "NonLinear":
197                     Xr = numpy.matrix(numpy.random.multivariate_normal(Xa.A1,A)).T
198                     Yr = numpy.matrix(numpy.ravel( H( Xr ) )).T
199                 if YfQ is None:
200                     YfQ = Yr
201                 else:
202                     YfQ = numpy.hstack((YfQ,Yr))
203             YfQ.sort(axis=-1)
204             YQ = None
205             for quantile in Qtls:
206                 if not (0. <= quantile <= 1.): continue
207                 indice = int(nech * quantile - 1./nech)
208                 if YQ is None: YQ = YfQ[:,indice]
209                 else:          YQ = numpy.hstack((YQ,YfQ[:,indice]))
210             self.StoredVariables["SimulationQuantiles"].store( YQ )
211         if "SimulatedObservationAtBackground" in self._parameters["StoreSupplementaryCalculations"]:
212             self.StoredVariables["SimulatedObservationAtBackground"].store( numpy.ravel(HXb) )
213         if "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"]:
214             self.StoredVariables["SimulatedObservationAtOptimum"].store( numpy.ravel(HXa) )
215         #
216         self._post_run(HO)
217         return 0
218
219 # ==============================================================================
220 if __name__ == "__main__":
221     print '\n AUTODIAGNOSTIC \n'