src/daComposant/daAlgorithms/3DVAR.py

   1 #-*-coding:iso-8859-1-*-
   2 #
   3 #  Copyright (C) 2008-2012 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, PlatformInfo
  25 m = PlatformInfo.SystemUsage()
  26
  27 import numpy
  28 import scipy.optimize
  29
  30 if logging.getLogger().level < logging.WARNING:
  31     iprint  = 1
  32     message = scipy.optimize.tnc.MSG_ALL
  33     disp    = 1
  34 else:
  35     iprint  = -1
  36     message = scipy.optimize.tnc.MSG_NONE
  37     disp    = 0
  38
  39 # ==============================================================================
  40 class ElementaryAlgorithm(BasicObjects.Algorithm):
  41     def __init__(self):
  42         BasicObjects.Algorithm.__init__(self, "3DVAR")
  43         self.defineRequiredParameter(
  44             name     = "Minimizer",
  45             default  = "LBFGSB",
  46             typecast = str,
  47             message  = "Minimiseur utilisé",
  48             listval  = ["LBFGSB","TNC", "CG", "NCG", "BFGS"],
  49             )
  50         self.defineRequiredParameter(
  51             name     = "MaximumNumberOfSteps",
  52             default  = 15000,
  53             typecast = int,
  54             message  = "Nombre maximal de pas d'optimisation",
  55             minval   = -1,
  56             )
  57         self.defineRequiredParameter(
  58             name     = "CostDecrementTolerance",
  59             default  = 1.e-7,
  60             typecast = float,
  61             message  = "Diminution relative minimale du cout lors de l'arrêt",
  62             )
  63         self.defineRequiredParameter(
  64             name     = "ProjectedGradientTolerance",
  65             default  = -1,
  66             typecast = float,
  67             message  = "Maximum des composantes du gradient projeté lors de l'arrêt",
  68             minval   = -1,
  69             )
  70         self.defineRequiredParameter(
  71             name     = "GradientNormTolerance",
  72             default  = 1.e-05,
  73             typecast = float,
  74             message  = "Maximum des composantes du gradient lors de l'arrêt",
  75             )
  76         self.defineRequiredParameter(
  77             name     = "StoreInternalVariables",
  78             default  = False,
  79             typecast = bool,
  80             message  = "Stockage des variables internes ou intermédiaires du calcul",
  81             )
  82         self.defineRequiredParameter(
  83             name     = "StoreSupplementaryCalculations",
  84             default  = [],
  85             typecast = tuple,
  86             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
  87             listval  = ["APosterioriCovariance", "BMA", "OMA", "OMB", "Innovation", "SigmaObs2", "MahalanobisConsistency"]
  88             )
  89
  90     def run(self, Xb=None, Y=None, H=None, M=None, R=None, B=None, Q=None, Parameters=None):
  91         logging.debug("%s Lancement"%self._name)
  92         logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("M")))
  93         #
  94         # Paramètres de pilotage
  95         # ----------------------
  96         self.setParameters(Parameters)
  97         #
  98         if self._parameters.has_key("Bounds") and (type(self._parameters["Bounds"]) is type([]) or type(self._parameters["Bounds"]) is type(())) and (len(self._parameters["Bounds"]) > 0):
  99             Bounds = self._parameters["Bounds"]
 100             logging.debug("%s Prise en compte des bornes effectuee"%(self._name,))
 101         else:
 102             Bounds = None
 103         #
 104         # Correction pour pallier a un bug de TNC sur le retour du Minimum
 105         if self._parameters.has_key("Minimizer") is "TNC":
 106             self.setParameterValue("StoreInternalVariables",True)
 107         #
 108         # Opérateur d'observation
 109         # -----------------------
 110         Hm = H["Direct"].appliedTo
 111         Ha = H["Adjoint"].appliedInXTo
 112         #
 113         # Utilisation éventuelle d'un vecteur H(Xb) précalculé
 114         # ----------------------------------------------------
 115         if H["AppliedToX"] is not None and H["AppliedToX"].has_key("HXb"):
 116             HXb = H["AppliedToX"]["HXb"]
 117         else:
 118             HXb = Hm( Xb )
 119         HXb = numpy.asmatrix(numpy.ravel( HXb )).T
 120         #
 121         # Calcul de l'innovation
 122         # ----------------------
 123         if Y.size != HXb.size:
 124             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))
 125         if max(Y.shape) != max(HXb.shape):
 126             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))
 127         d  = Y - HXb
 128         #
 129         # Précalcul des inversions de B et R
 130         # ----------------------------------
 131         if B is not None:
 132             BI = B.I
 133         elif self._parameters["B_scalar"] is not None:
 134             BI = 1.0 / self._parameters["B_scalar"]
 135         else:
 136             raise ValueError("Background error covariance matrix has to be properly defined!")
 137         #
 138         if R is not None:
 139             RI = R.I
 140         elif self._parameters["R_scalar"] is not None:
 141             RI = 1.0 / self._parameters["R_scalar"]
 142         else:
 143             raise ValueError("Observation error covariance matrix has to be properly defined!")
 144         #
 145         # Définition de la fonction-coût
 146         # ------------------------------
 147         def CostFunction(x):
 148             _X  = numpy.asmatrix(numpy.ravel( x )).T
 149             _HX = Hm( _X )
 150             _HX = numpy.asmatrix(numpy.ravel( _HX )).T
 151             Jb  = 0.5 * (_X - Xb).T * BI * (_X - Xb)
 152             Jo  = 0.5 * (Y - _HX).T * RI * (Y - _HX)
 153             J   = float( Jb ) + float( Jo )
 154             if self._parameters["StoreInternalVariables"]:
 155                 self.StoredVariables["CurrentState"].store( _X.A1 )
 156             self.StoredVariables["CostFunctionJb"].store( Jb )
 157             self.StoredVariables["CostFunctionJo"].store( Jo )
 158             self.StoredVariables["CostFunctionJ" ].store( J )
 159             return J
 160         #
 161         def GradientOfCostFunction(x):
 162             _X      = numpy.asmatrix(numpy.ravel( x )).T
 163             _HX     = Hm( _X )
 164             _HX     = numpy.asmatrix(numpy.ravel( _HX )).T
 165             GradJb  = BI * (_X - Xb)
 166             GradJo  = - Ha( (_X, RI * (Y - _HX)) )
 167             GradJ   = numpy.asmatrix( numpy.ravel( GradJb ) + numpy.ravel( GradJo ) ).T
 168             return GradJ.A1
 169         #
 170         # Point de démarrage de l'optimisation : Xini = Xb
 171         # ------------------------------------
 172         if type(Xb) is type(numpy.matrix([])):
 173             Xini = Xb.A1.tolist()
 174         else:
 175             Xini = list(Xb)
 176         #
 177         # Minimisation de la fonctionnelle
 178         # --------------------------------
 179         if self._parameters["Minimizer"] == "LBFGSB":
 180             Minimum, J_optimal, Informations = scipy.optimize.fmin_l_bfgs_b(
 181                 func        = CostFunction,
 182                 x0          = Xini,
 183                 fprime      = GradientOfCostFunction,
 184                 args        = (),
 185                 bounds      = Bounds,
 186                 maxfun      = self._parameters["MaximumNumberOfSteps"]-1,
 187                 factr       = self._parameters["CostDecrementTolerance"]*1.e14,
 188                 pgtol       = self._parameters["ProjectedGradientTolerance"],
 189                 iprint      = iprint,
 190                 )
 191             nfeval = Informations['funcalls']
 192             rc     = Informations['warnflag']
 193         elif self._parameters["Minimizer"] == "TNC":
 194             Minimum, nfeval, rc = scipy.optimize.fmin_tnc(
 195                 func        = CostFunction,
 196                 x0          = Xini,
 197                 fprime      = GradientOfCostFunction,
 198                 args        = (),
 199                 bounds      = Bounds,
 200                 maxfun      = self._parameters["MaximumNumberOfSteps"],
 201                 pgtol       = self._parameters["ProjectedGradientTolerance"],
 202                 ftol        = self._parameters["CostDecrementTolerance"],
 203                 messages    = message,
 204                 )
 205         elif self._parameters["Minimizer"] == "CG":
 206             Minimum, fopt, nfeval, grad_calls, rc = scipy.optimize.fmin_cg(
 207                 f           = CostFunction,
 208                 x0          = Xini,
 209                 fprime      = GradientOfCostFunction,
 210                 args        = (),
 211                 maxiter     = self._parameters["MaximumNumberOfSteps"],
 212                 gtol        = self._parameters["GradientNormTolerance"],
 213                 disp        = disp,
 214                 full_output = True,
 215                 )
 216         elif self._parameters["Minimizer"] == "NCG":
 217             Minimum, fopt, nfeval, grad_calls, hcalls, rc = scipy.optimize.fmin_ncg(
 218                 f           = CostFunction,
 219                 x0          = Xini,
 220                 fprime      = GradientOfCostFunction,
 221                 args        = (),
 222                 maxiter     = self._parameters["MaximumNumberOfSteps"],
 223                 avextol     = self._parameters["CostDecrementTolerance"],
 224                 disp        = disp,
 225                 full_output = True,
 226                 )
 227         elif self._parameters["Minimizer"] == "BFGS":
 228             Minimum, fopt, gopt, Hopt, nfeval, grad_calls, rc = scipy.optimize.fmin_bfgs(
 229                 f           = CostFunction,
 230                 x0          = Xini,
 231                 fprime      = GradientOfCostFunction,
 232                 args        = (),
 233                 maxiter     = self._parameters["MaximumNumberOfSteps"],
 234                 gtol        = self._parameters["GradientNormTolerance"],
 235                 disp        = disp,
 236                 full_output = True,
 237                 )
 238         else:
 239             raise ValueError("Error in Minimizer name: %s"%self._parameters["Minimizer"])
 240         #
 241         StepMin = numpy.argmin( self.StoredVariables["CostFunctionJ"].valueserie() )
 242         MinJ    = self.StoredVariables["CostFunctionJ"].valueserie(step = StepMin)
 243         #
 244         # Correction pour pallier a un bug de TNC sur le retour du Minimum
 245         # ----------------------------------------------------------------
 246         if self._parameters["StoreInternalVariables"]:
 247             Minimum = self.StoredVariables["CurrentState"].valueserie(step = StepMin)
 248         #
 249         # Obtention de l'analyse
 250         # ----------------------
 251         Xa = numpy.asmatrix(numpy.ravel( Minimum )).T
 252         #
 253         self.StoredVariables["Analysis"].store( Xa.A1 )
 254         #
 255         # Calcul de la covariance d'analyse
 256         # ---------------------------------
 257         if "APosterioriCovariance" in self._parameters["StoreSupplementaryCalculations"]:
 258             Ht = H["Tangent"].asMatrix(ValueForMethodForm = Xa)
 259             Ht = Ht.reshape(-1,len(Xa.A1)) # ADAO
 260             HessienneI = []
 261             nb = len(Xini)
 262             for i in range(nb):
 263                 _ee    = numpy.matrix(numpy.zeros(nb)).T
 264                 _ee[i] = 1.
 265                 _HtEE  = Ht * _ee
 266                 _HtEE  = numpy.asmatrix(numpy.ravel( _HtEE )).T
 267                 HessienneI.append( ( BI*_ee + Ha((Xa,RI*_HtEE)) ).A1 )
 268             HessienneI = numpy.matrix( HessienneI )
 269             A = HessienneI.I
 270             if logging.getLogger().level < logging.WARNING: # La verification n'a lieu qu'en debug
 271                 try:
 272                     L = numpy.linalg.cholesky( A )
 273                 except:
 274                     raise ValueError("The 3DVAR a posteriori covariance matrix A is not symmetric positive-definite. Check your B and R a priori covariances.")
 275             self.StoredVariables["APosterioriCovariance"].store( A )
 276         #
 277         # Calculs et/ou stockages supplémentaires
 278         # ---------------------------------------
 279         if "Innovation" in self._parameters["StoreSupplementaryCalculations"]:
 280             self.StoredVariables["Innovation"].store( numpy.ravel(d) )
 281         if "BMA" in self._parameters["StoreSupplementaryCalculations"]:
 282             self.StoredVariables["BMA"].store( numpy.ravel(Xb - Xa) )
 283         if "OMA" in self._parameters["StoreSupplementaryCalculations"]:
 284             self.StoredVariables["OMA"].store( numpy.ravel(Y - Hm(Xa)) )
 285         if "OMB" in self._parameters["StoreSupplementaryCalculations"]:
 286             self.StoredVariables["OMB"].store( numpy.ravel(d) )
 287         if "SigmaObs2" in self._parameters["StoreSupplementaryCalculations"]:
 288             self.StoredVariables["SigmaObs2"].store( float( (d.T * (Y-Hm(Xa))) / R.trace() ) )
 289         if "MahalanobisConsistency" in self._parameters["StoreSupplementaryCalculations"]:
 290             self.StoredVariables["MahalanobisConsistency"].store( float( 2.*MinJ/len(d) ) )
 291         #
 292         logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("M")))
 293         logging.debug("%s Terminé"%self._name)
 294         #
 295         return 0
 296
 297 # ==============================================================================
 298 if __name__ == "__main__":
 299     print '\n AUTODIAGNOSTIC \n'