src/daComposant/daDiagnostics/CompareMeanDependantVectors.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 qui effectue le test d egalite des moyennes de 2 vecteurs
  23     dependants au sens du test de Student.
  24     Ce diagnostic utilise le calcul de la p-value pour le test de Student
  25     pour 2 vecteurs dependants
  26     En input :  la tolerance
  27     En output : le resultat du diagnostic est une reponse booleenne au test :
  28         True si les moyennes sont egales au sens du Test de Student
  29         False dans le cas contraire.
  30 """
  31 __author__ = "Sophie RICCI - Octobre 2008"
  32
  33 import sys ; sys.path.insert(0, "../daCore")
  34
  35 import numpy
  36 import Persistence
  37 from BasicObjects import Diagnostic
  38 from ComputeStudent import DependantVectors
  39 import logging
  40
  41 # ==============================================================================
  42 class ElementaryDiagnostic(Diagnostic,Persistence.OneScalar):
  43     """
  44     Diagnostic qui effectueIndependantVectorsEqualVariance le test d egalite des moyennes de 2 vecteurs
  45     dependants au sens du test de Student.
  46     Ce diagnostic utilise le calcul de la p-value pour le test de Student
  47     pour 2 vecteurs dependants
  48     En input :  la tolerance
  49     En output : le resultat du diagnostic est une reponse booleenne au test :
  50        True si les moyennes sont egales au sens du Test de Student
  51        False dans le cas contraire.
  52     """
  53     def __init__(self, name="", unit="", basetype = None, parameters = {} ):
  54         Diagnostic.__init__(self, name, parameters)
  55         Persistence.OneScalar.__init__( self, name, unit, basetype = bool)
  56         if not self.parameters.has_key("tolerance"):
  57             raise ValueError("A parameter named \"tolerance\" is required.")
  58
  59     def formula(self, V1, V2):
  60         """
  61         Effectue le calcul de la p-value de Student pour deux vecteurs.
  62         """
  63         [aire, Q, reponse, message] = DependantVectors(
  64             vector1 = V1,
  65             vector2 = V2,
  66             tolerance = self.parameters["tolerance"] )
  67         logging.info( message )
  68         answerStudentTest = False
  69         if (aire < (100.*self.parameters["tolerance"])) :
  70             answerStudentTest = False
  71         else:
  72             answerStudentTest = True
  73         return answerStudentTest
  74
  75     def calculate(self, vector1 = None, vector2 = None,  step = None):
  76         """
  77         Active la formule de calcul
  78         """
  79         if (vector1 is None) or (vector2 is None) :
  80             raise ValueError("Two vectors must be given to calculate the Student value")
  81         V1 = numpy.array(vector1)
  82         V2 = numpy.array(vector2)
  83         if (V1.size < 1) or (V2.size < 1):
  84             raise ValueError("The given vectors must not be empty")
  85         if V1.size != V2.size:
  86             raise ValueError("The two given vectors must have the same size, or the vector types are incompatible")
  87         value = self.formula( V1, V2 )
  88         self.store( value = value,  step = step)
  89
  90 # ==============================================================================
  91 if __name__ == "__main__":
  92     print '\n AUTODIAGNOSTIC \n'
  93
  94     print " Test d'égalite des moyennes au sens de Student pour deux vecteurs"
  95     print " dépendants."
  96     print
  97     #
  98     # Initialisation des inputs et appel du diagnostic
  99     # --------------------------------------------------------------------
 100     tolerance = 0.05
 101     D = ElementaryDiagnostic("ComputeMeanStudent_DependVect", parameters = {
 102                  "tolerance":tolerance,
 103                  })
 104     #
 105     # Tirage de l'echantillon aleatoire
 106     # --------------------------------------------------------------------
 107     x1 = numpy.array(([-0.23262176, 1.36065207,  0.32988102, 0.24400551, -0.66765848, -0.19088483, -0.31082575,  0.56849814,  1.21453443,  0.99657516]))
 108     x2 = numpy.array(([-0.23, 1.36,  0.32, 0.24, -0.66, -0.19, -0.31,  0.56,  1.21,  0.99]))
 109     #
 110     # Calcul
 111     # --------------------------------------------------------------------
 112     D.calculate(x1, x2)
 113     #
 114     if D.valueserie(0) :
 115             print " L'hypothèse d'égalité des moyennes est valide."
 116             print
 117     else :
 118             raise ValueError("The egality of the means is NOT valid")