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