src/daComposant/daAlgorithms/NonLinearLeastSquares.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, "NONLINEARLEASTSQUARES")
  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  = ["BMA", "OMA", "OMB", "Innovation"]
  88             )
  89
  90     def run(self, Xb=None, Y=None, H=None, M=None, R=None, B=None, Q=None, Parameters=None):
  91         """
  92         Calcul de l'estimateur moindres carrés pondérés non linéaires
  93         (assimilation variationnelle sans ébauche)
  94         """
  95         logging.debug("%s Lancement"%self._name)
  96         logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("M")))
  97         #
  98         # Paramètres de pilotage
  99         # ----------------------
 100         self.setParameters(Parameters)
 101         #
 102         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):
 103             Bounds = self._parameters["Bounds"]
 104             logging.debug("%s Prise en compte des bornes effectuee"%(self._name,))
 105         else:
 106             Bounds = None
 107         #
 108         # Correction pour pallier a un bug de TNC sur le retour du Minimum
 109         if self._parameters.has_key("Minimizer") is "TNC":
 110             self.setParameterValue("StoreInternalVariables",True)
 111         #
 112         # Opérateur d'observation
 113         # -----------------------
 114         Hm = H["Direct"].appliedTo
 115         Ha = H["Adjoint"].appliedInXTo
 116         #
 117         # Utilisation éventuelle d'un vecteur H(Xb) précalculé
 118         # ----------------------------------------------------
 119         if H["AppliedToX"] is not None and H["AppliedToX"].has_key("HXb"):
 120             logging.debug("%s Utilisation de HXb"%self._name)
 121             HXb = H["AppliedToX"]["HXb"]
 122         else:
 123             logging.debug("%s Calcul de Hm(Xb)"%self._name)
 124             HXb = Hm( Xb )
 125         HXb = numpy.asmatrix(HXb).flatten().T
 126         #
 127         # Calcul de l'innovation
 128         # ----------------------
 129         if Y.size != HXb.size:
 130             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))
 131         if max(Y.shape) != max(HXb.shape):
 132             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))
 133         d  = Y - HXb
 134         logging.debug("%s Innovation d = %s"%(self._name, d))
 135         #
 136         # Précalcul des inversions de B et R
 137         # ----------------------------------
 138         # if B is not None:
 139         #     BI = B.I
 140         # elif self._parameters["B_scalar"] is not None:
 141         #     BI = 1.0 / self._parameters["B_scalar"]
 142         # else:
 143         #     raise ValueError("Background error covariance matrix has to be properly defined!")
 144         #
 145         if R is not None:
 146             RI = R.I
 147         elif self._parameters["R_scalar"] is not None:
 148             RI = 1.0 / self._parameters["R_scalar"]
 149         else:
 150             raise ValueError("Observation error covariance matrix has to be properly defined!")
 151         #
 152         # Définition de la fonction-coût
 153         # ------------------------------
 154         def CostFunction(x):
 155             _X  = numpy.asmatrix(x).flatten().T
 156             logging.debug("%s CostFunction X  = %s"%(self._name, numpy.asmatrix( _X ).flatten()))
 157             _HX = Hm( _X )
 158             _HX = numpy.asmatrix(_HX).flatten().T
 159             Jb  = 0.
 160             Jo  = 0.5 * (Y - _HX).T * RI * (Y - _HX)
 161             J   = float( Jb ) + float( Jo )
 162             logging.debug("%s CostFunction Jb = %s"%(self._name, Jb))
 163             logging.debug("%s CostFunction Jo = %s"%(self._name, Jo))
 164             logging.debug("%s CostFunction J  = %s"%(self._name, J))
 165             if self._parameters["StoreInternalVariables"]:
 166                 self.StoredVariables["CurrentState"].store( _X.A1 )
 167             self.StoredVariables["CostFunctionJb"].store( Jb )
 168             self.StoredVariables["CostFunctionJo"].store( Jo )
 169             self.StoredVariables["CostFunctionJ" ].store( J )
 170             return float( J )
 171         #
 172         def GradientOfCostFunction(x):
 173             _X      = numpy.asmatrix(x).flatten().T
 174             logging.debug("%s GradientOfCostFunction X      = %s"%(self._name, numpy.asmatrix( _X ).flatten()))
 175             _HX     = Hm( _X )
 176             _HX     = numpy.asmatrix(_HX).flatten().T
 177             GradJb  = 0.
 178             GradJo  = - Ha( (_X, RI * (Y - _HX)) )
 179             GradJ   = numpy.asmatrix( GradJb ).flatten().T + numpy.asmatrix( GradJo ).flatten().T
 180             logging.debug("%s GradientOfCostFunction GradJb = %s"%(self._name, numpy.asmatrix( GradJb ).flatten()))
 181             logging.debug("%s GradientOfCostFunction GradJo = %s"%(self._name, numpy.asmatrix( GradJo ).flatten()))
 182             logging.debug("%s GradientOfCostFunction GradJ  = %s"%(self._name, numpy.asmatrix( GradJ  ).flatten()))
 183             return GradJ.A1
 184         #
 185         # Point de démarrage de l'optimisation : Xini = Xb
 186         # ------------------------------------
 187         if type(Xb) is type(numpy.matrix([])):
 188             Xini = Xb.A1.tolist()
 189         else:
 190             Xini = list(Xb)
 191         logging.debug("%s Point de démarrage Xini = %s"%(self._name, Xini))
 192         #
 193         # Minimisation de la fonctionnelle
 194         # --------------------------------
 195         if self._parameters["Minimizer"] == "LBFGSB":
 196             Minimum, J_optimal, Informations = scipy.optimize.fmin_l_bfgs_b(
 197                 func        = CostFunction,
 198                 x0          = Xini,
 199                 fprime      = GradientOfCostFunction,
 200                 args        = (),
 201                 bounds      = Bounds,
 202                 maxfun      = self._parameters["MaximumNumberOfSteps"]-1,
 203                 factr       = self._parameters["CostDecrementTolerance"]*1.e14,
 204                 pgtol       = self._parameters["ProjectedGradientTolerance"],
 205                 iprint      = iprint,
 206                 )
 207             nfeval = Informations['funcalls']
 208             rc     = Informations['warnflag']
 209         elif self._parameters["Minimizer"] == "TNC":
 210             Minimum, nfeval, rc = scipy.optimize.fmin_tnc(
 211                 func        = CostFunction,
 212                 x0          = Xini,
 213                 fprime      = GradientOfCostFunction,
 214                 args        = (),
 215                 bounds      = Bounds,
 216                 maxfun      = self._parameters["MaximumNumberOfSteps"],
 217                 pgtol       = self._parameters["ProjectedGradientTolerance"],
 218                 ftol        = self._parameters["CostDecrementTolerance"],
 219                 messages    = message,
 220                 )
 221         elif self._parameters["Minimizer"] == "CG":
 222             Minimum, fopt, nfeval, grad_calls, rc = scipy.optimize.fmin_cg(
 223                 f           = CostFunction,
 224                 x0          = Xini,
 225                 fprime      = GradientOfCostFunction,
 226                 args        = (),
 227                 maxiter     = self._parameters["MaximumNumberOfSteps"],
 228                 gtol        = self._parameters["GradientNormTolerance"],
 229                 disp        = disp,
 230                 full_output = True,
 231                 )
 232         elif self._parameters["Minimizer"] == "NCG":
 233             Minimum, fopt, nfeval, grad_calls, hcalls, rc = scipy.optimize.fmin_ncg(
 234                 f           = CostFunction,
 235                 x0          = Xini,
 236                 fprime      = GradientOfCostFunction,
 237                 args        = (),
 238                 maxiter     = self._parameters["MaximumNumberOfSteps"],
 239                 avextol     = self._parameters["CostDecrementTolerance"],
 240                 disp        = disp,
 241                 full_output = True,
 242                 )
 243         elif self._parameters["Minimizer"] == "BFGS":
 244             Minimum, fopt, gopt, Hopt, nfeval, grad_calls, rc = scipy.optimize.fmin_bfgs(
 245                 f           = CostFunction,
 246                 x0          = Xini,
 247                 fprime      = GradientOfCostFunction,
 248                 args        = (),
 249                 maxiter     = self._parameters["MaximumNumberOfSteps"],
 250                 gtol        = self._parameters["GradientNormTolerance"],
 251                 disp        = disp,
 252                 full_output = True,
 253                 )
 254         else:
 255             raise ValueError("Error in Minimizer name: %s"%self._parameters["Minimizer"])
 256         #
 257         StepMin = numpy.argmin( self.StoredVariables["CostFunctionJ"].valueserie() )
 258         MinJ    = self.StoredVariables["CostFunctionJ"].valueserie(step = StepMin)
 259         #
 260         # Correction pour pallier a un bug de TNC sur le retour du Minimum
 261         # ----------------------------------------------------------------
 262         if self._parameters["StoreInternalVariables"]:
 263             Minimum = self.StoredVariables["CurrentState"].valueserie(step = StepMin)
 264         #
 265         logging.debug("%s %s Step of min cost  = %s"%(self._name, self._parameters["Minimizer"], StepMin))
 266         logging.debug("%s %s Minimum cost      = %s"%(self._name, self._parameters["Minimizer"], MinJ))
 267         logging.debug("%s %s Minimum state     = %s"%(self._name, self._parameters["Minimizer"], Minimum))
 268         logging.debug("%s %s Nb of F           = %s"%(self._name, self._parameters["Minimizer"], nfeval))
 269         logging.debug("%s %s RetCode           = %s"%(self._name, self._parameters["Minimizer"], rc))
 270         #
 271         # Obtention de l'analyse
 272         # ----------------------
 273         Xa = numpy.asmatrix(Minimum).flatten().T
 274         logging.debug("%s Analyse Xa = %s"%(self._name, Xa))
 275         #
 276         self.StoredVariables["Analysis"].store( Xa.A1 )
 277         #
 278         # Calculs et/ou stockages supplémentaires
 279         # ---------------------------------------
 280         if "Innovation" in self._parameters["StoreSupplementaryCalculations"]:
 281             self.StoredVariables["Innovation"].store( numpy.asmatrix(d).flatten().A1 )
 282         if "BMA" in self._parameters["StoreSupplementaryCalculations"]:
 283             self.StoredVariables["BMA"].store( numpy.asmatrix(Xb - Xa).flatten().A1 )
 284         if "OMA" in self._parameters["StoreSupplementaryCalculations"]:
 285             self.StoredVariables["OMA"].store( numpy.asmatrix(Y - Hm(Xa)).flatten().A1 )
 286         if "OMB" in self._parameters["StoreSupplementaryCalculations"]:
 287             self.StoredVariables["OMB"].store( numpy.asmatrix(d).flatten().A1 )
 288         #
 289         logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("M")))
 290         logging.debug("%s Terminé"%self._name)
 291         #
 292         return 0
 293
 294 # ==============================================================================
 295 if __name__ == "__main__":
 296     print '\n AUTODIAGNOSTIC \n'