src/daComposant/daDiagnostics/ReduceVariance.py

   1 #-*-coding:iso-8859-1-*-
   2 #
   3 #  Copyright (C) 2008-2009  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 __doc__ = """
  22     Diagnostic sur la reduction de la variance lors de l'analyse
  23 """
  24 __author__ = "Jean-Philippe ARGAUD - Septembre 2008"
  25
  26 import sys ; sys.path.insert(0, "../daCore")
  27
  28 import numpy
  29 import Persistence
  30 from BasicObjects import Diagnostic
  31 from AssimilationStudy import AssimilationStudy
  32
  33 # ==============================================================================
  34 class ElementaryDiagnostic(Diagnostic,Persistence.OneScalar):
  35     def __init__(self, name = "", unit = "", basetype = None, parameters = {}):
  36         Diagnostic.__init__(self, name, parameters)
  37         Persistence.OneScalar.__init__( self, name, unit, basetype = bool )
  38
  39     def _formula(self, V1, V2):
  40         """
  41         Vérification de la reduction de variance sur les écarts entre OMB et OMA
  42         lors de l'analyse
  43         """
  44         varianceOMB = V1.var()
  45         varianceOMA = V2.var()
  46         #
  47         if varianceOMA > varianceOMB:
  48             reducevariance = False
  49         else :
  50             reducevariance = True
  51         #
  52         return reducevariance
  53
  54     def calculate(self, vectorOMB = None, vectorOMA = None, step = None):
  55         """
  56         Teste les arguments, active la formule de calcul et stocke le résultat
  57         Arguments :
  58             - vectorOMB : vecteur d'écart entre les observations et l'ébauche
  59             - vectorOMA : vecteur d'écart entre les observations et l'analyse
  60         """
  61         if ( (vectorOMB is None) or (vectorOMA is None) ):
  62             raise ValueError("Two vectors must be given to test the reduction of the variance after analysis")
  63         V1 = numpy.array(vectorOMB)
  64         V2 = numpy.array(vectorOMA)
  65         if V1.size < 1 or V2.size < 1:
  66             raise ValueError("The given vectors must not be empty")
  67         if V1.size != V2.size:
  68             raise ValueError("The two given vectors must have the same size")
  69         #
  70         value = self._formula( V1, V2 )
  71         #
  72         self.store( value = value,  step = step )
  73
  74 #===============================================================================
  75 if __name__ == "__main__":
  76     print '\n AUTODIAGNOSTIC \n'
  77     #
  78     # Instanciation de l'objet diagnostic
  79     # -----------------------------------
  80     D = ElementaryDiagnostic("Mon ReduceVariance")
  81     #
  82     # Vecteur de type matrix
  83     # ----------------------
  84     x1 = numpy.matrix(([3. , 4., 5. ]))
  85     x2 = numpy.matrix(([1.5, 2., 2.5]))
  86     print " L'écart entre les observations et l'ébauche est OMB :", x1
  87     print " La moyenne de OMB (i.e. le biais) est de............:", x1.mean()
  88     print " La variance de OMB est de...........................:", x1.var()
  89     print " L'écart entre les observations et l'analyse est OMA :", x2
  90     print " La moyenne de OMA (i.e. le biais) est de............:", x2.mean()
  91     print " La variance de OMA est de...........................:", x2.var()
  92     #
  93     D.calculate( vectorOMB = x1,  vectorOMA = x2)
  94     if not D.valueserie(0) :
  95             print " Résultat : l'analyse NE RÉDUIT PAS la variance"
  96     else :
  97             print " Résultat : l'analyse RÉDUIT la variance"
  98     print
  99     #
 100     # Vecteur de type array
 101     # ---------------------
 102     x1 = numpy.array(range(11))
 103     x2 = numpy.matrix(range(-10,12,2))
 104     print " L'écart entre les observations et l'ébauche est OMB :", x1
 105     print " La moyenne de OMB (i.e. le biais) est de............:", x1.mean()
 106     print " La variance de OMB est de...........................:", x1.var()
 107     print " L'écart entre les observations et l'analyse est OMA :", x2
 108     print " La moyenne de OMA (i.e. le biais) est de............:", x2.mean()
 109     print " La variance de OMA est de...........................:", x2.var()
 110     #
 111     D.calculate( vectorOMB = x1,  vectorOMA = x2)
 112     if not D.valueserie(1) :
 113             print " Résultat : l'analyse NE RÉDUIT PAS la variance"
 114     else :
 115             print " Résultat : l'analyse RÉDUIT la variance"
 116     print