src/daComposant/daAlgorithms/QuantileRegression.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
  22 import logging
  23 from daCore import BasicObjects, PlatformInfo
  24 m = PlatformInfo.SystemUsage()
  25
  26 import numpy
  27
  28 # ==============================================================================
  29 class ElementaryAlgorithm(BasicObjects.Algorithm):
  30     def __init__(self):
  31         BasicObjects.Algorithm.__init__(self, "QUANTILEREGRESSION")
  32         self.defineRequiredParameter(
  33             name     = "Quantile",
  34             default  = 0.5,
  35             typecast = float,
  36             message  = "Quantile pour la regression de quantile",
  37             minval   = 0.,
  38             maxval   = 1.,
  39             )
  40         self.defineRequiredParameter(
  41             name     = "Minimizer",
  42             default  = "MMQR",
  43             typecast = str,
  44             message  = "Minimiseur utilisé",
  45             listval  = ["MMQR"],
  46             )
  47         self.defineRequiredParameter(
  48             name     = "MaximumNumberOfSteps",
  49             default  = 15000,
  50             typecast = int,
  51             message  = "Nombre maximal de pas d'optimisation",
  52             minval   = -1
  53             )
  54         self.defineRequiredParameter(
  55             name     = "CostDecrementTolerance",
  56             default  = 1.e-6,
  57             typecast = float,
  58             message  = "Maximum de variation de la fonction d'estimation lors de l'arrêt",
  59             )
  60
  61     def run(self, Xb=None, Y=None, H=None, M=None, R=None, B=None, Q=None, Parameters=None):
  62         """
  63         Calcul des parametres definissant le quantile
  64         """
  65         logging.debug("%s Lancement"%self._name)
  66         logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("Mo")))
  67         #
  68         # Paramètres de pilotage
  69         # ----------------------
  70         self.setParameters(Parameters)
  71         #
  72         # Opérateur d'observation
  73         # -----------------------
  74         Hm = H["Direct"].appliedTo
  75         #
  76         # Utilisation éventuelle d'un vecteur H(Xb) précalculé
  77         # ----------------------------------------------------
  78         if H["AppliedToX"] is not None and H["AppliedToX"].has_key("HXb"):
  79             logging.debug("%s Utilisation de HXb"%self._name)
  80             HXb = H["AppliedToX"]["HXb"]
  81         else:
  82             logging.debug("%s Calcul de Hm(Xb)"%self._name)
  83             HXb = Hm( Xb )
  84         HXb = numpy.asmatrix(HXb).flatten().T
  85         #
  86         # Calcul de l'innovation
  87         # ----------------------
  88         if Y.size != HXb.size:
  89             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))
  90         if max(Y.shape) != max(HXb.shape):
  91             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))
  92         d  = Y - HXb
  93         logging.debug("%s Innovation d = %s"%(self._name, d))
  94         #
  95         # Définition de la fonction-coût
  96         # ------------------------------
  97         def CostFunction(x):
  98             _X  = numpy.asmatrix(x).flatten().T
  99             logging.debug("%s CostFunction X  = %s"%(self._name, numpy.asmatrix( _X ).flatten()))
 100             _HX = Hm( _X )
 101             _HX = numpy.asmatrix(_HX).flatten().T
 102             Jb  = 0.
 103             Jo  = 0.
 104             J   = Jb + Jo
 105             logging.debug("%s CostFunction Jb = %s"%(self._name, Jb))
 106             logging.debug("%s CostFunction Jo = %s"%(self._name, Jo))
 107             logging.debug("%s CostFunction J  = %s"%(self._name, J))
 108             self.StoredVariables["CurrentState"].store( _X.A1 )
 109             self.StoredVariables["CostFunctionJb"].store( Jb )
 110             self.StoredVariables["CostFunctionJo"].store( Jo )
 111             self.StoredVariables["CostFunctionJ" ].store( J )
 112             return _HX
 113         #
 114         def GradientOfCostFunction(x):
 115             _X      = numpy.asmatrix(x).flatten().T
 116             logging.debug("%s GradientOfCostFunction X      = %s"%(self._name, numpy.asmatrix( _X ).flatten()))
 117             Hg = H["Tangent"].asMatrix( _X )
 118             return Hg
 119         #
 120         # Point de démarrage de l'optimisation : Xini = Xb
 121         # ------------------------------------
 122         if type(Xb) is type(numpy.matrix([])):
 123             Xini = Xb.A1.tolist()
 124         else:
 125             Xini = list(Xb)
 126         logging.debug("%s Point de démarrage Xini = %s"%(self._name, Xini))
 127         #
 128         # Minimisation de la fonctionnelle
 129         # --------------------------------
 130         if self._parameters["Minimizer"] == "MMQR":
 131             import mmqr
 132             Minimum, J_optimal, Informations = mmqr.mmqr(
 133                 func        = CostFunction,
 134                 x0          = Xini,
 135                 fprime      = GradientOfCostFunction,
 136                 quantile    = self._parameters["Quantile"],
 137                 maxfun      = self._parameters["MaximumNumberOfSteps"],
 138                 toler       = self._parameters["CostDecrementTolerance"],
 139                 y           = Y,
 140                 )
 141             nfeval = Informations[2]
 142             rc     = Informations[4]
 143         else:
 144             raise ValueError("Error in Minimizer name: %s"%self._parameters["Minimizer"])
 145         #
 146         logging.debug("%s %s Step of min cost  = %s"%(self._name, self._parameters["Minimizer"], nfeval))
 147         logging.debug("%s %s Minimum cost      = %s"%(self._name, self._parameters["Minimizer"], J_optimal))
 148         logging.debug("%s %s Minimum state     = %s"%(self._name, self._parameters["Minimizer"], Minimum))
 149         logging.debug("%s %s Nb of F           = %s"%(self._name, self._parameters["Minimizer"], nfeval))
 150         logging.debug("%s %s RetCode           = %s"%(self._name, self._parameters["Minimizer"], rc))
 151         #
 152         # Obtention de l'analyse
 153         # ----------------------
 154         Xa = numpy.asmatrix(Minimum).T
 155         logging.debug("%s Analyse Xa = %s"%(self._name, Xa))
 156         #
 157         self.StoredVariables["Analysis"].store( Xa.A1 )
 158         self.StoredVariables["Innovation"].store( d.A1 )
 159         #
 160         logging.debug("%s Taille mémoire utilisée de %.1f Mo"%(self._name, m.getUsedMemory("MB")))
 161         logging.debug("%s Terminé"%self._name)
 162         #
 163         return 0
 164
 165 # ==============================================================================
 166 if __name__ == "__main__":
 167     print '\n AUTODIAGNOSTIC \n'