src/daComposant/daDiagnostics/ReduceVariance.py

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