.. _tui_create_hypothese:

L'hypothse
===========

.. index:: single: itration
.. index:: single: hypothse
.. index:: single: zone

Les variables sont dcrites dans :ref:`gui_create_hypothese`.

Mthodes de la classe homard
""""""""""""""""""""""""""""

+---------------------------------------------------------------+
+===============================================================+
| .. module:: CreateHypothesis                                  |
|                                                               |
| **CreateHypothesis(hypo_name)**                               |
|     Retourne une instance de la classe hypothese              |
|                                                               |
|     - ``hypo_name`` : le nom de l'hypothse                   |
+---------------------------------------------------------------+
| .. module:: AssociateHypoZone                                 |
|                                                               |
| **AssociateHypoZone(hypo_name, zone_name)**                   |
|                                                               |
|     - ``hypo_name`` : le nom de l'hypothse                   |
|     - ``zone_name`` : le nom de la zone  associer            |
+---------------------------------------------------------------+

Mthodes de la classe hypothese
"""""""""""""""""""""""""""""""

Gnralits
^^^^^^^^^^^

+---------------------------------------------------------------+
+===============================================================+
| .. module:: GetName                                           |
|                                                               |
| **GetName()**                                                 |
|     Retourne le nom de l'hypothse                            |
+---------------------------------------------------------------+
| .. module:: SetAdapRefinUnRef                                 |
|                                                               |
| **SetAdapRefinUnRef(Adap, Refin, UnRef)**                     |
|                                                               |
|     - ``Adap`` : entier prcisant le type d'adaptation        |
|                                                               |
|         * -1 : uniforme                                       |
|         * 0 : selon des zones                                 |
|         * 1 : selon un champ                                  |
|                                                               |
|     - ``Refin`` : entier prcisant si le raffinement est actif|
|                                                               |
|         0. inactif                                            |
|         1. actif                                              |
|                                                               |
|     - ``UnRef`` : entier prcisant si draffinement est actif |
|                                                               |
|         0. inactif                                            |
|         1. actif                                              |
|                                                               |
+---------------------------------------------------------------+
| .. module:: GetAdapType                                       |
|                                                               |
| **GetAdapType()**                                             |
|     Retourne le type d'adaptation                             |
+---------------------------------------------------------------+
| .. module:: GetRefinType                                      |
|                                                               |
| **GetRefinType()**                                            |
|     Retourne le type de raffinement                           |
+---------------------------------------------------------------+
| .. module:: GetUnRefType                                      |
|                                                               |
| **GetUnRefType()**                                            |
|     Retourne le type de draffinement                         |
+---------------------------------------------------------------+

Le champ et les seuils
^^^^^^^^^^^^^^^^^^^^^^

+---------------------------------------------------------------+
+===============================================================+
| .. module:: SetField                                          |
|                                                               |
| **SetField(field_name)**                                      |
|                                                               |
|     - ``field_name`` : le nom du champ                        |
+---------------------------------------------------------------+
| .. module:: GetFieldName                                      |
|                                                               |
| **GetFieldName()**                                            |
|     Retourne le nom du champ                                  |
+---------------------------------------------------------------+
| .. module:: SetUseField                                       |
|                                                               |
| **SetUseField(use_field)**                                    |
|                                                               |
|     - ``use_field`` : entier prcisant l'usage du champ       |
|                                                               |
|         0. valeur par maille (dfaut)                         |
|         1. saut entre une maille et ses voisines              |
+---------------------------------------------------------------+
| .. module:: SetRefinThr                                       |
|                                                               |
| **SetRefinThr(type_thres, threshold)**                        |
|                                                               |
|     - ``type_thres`` : entier prcisant le type de seuil en   |
|       raffinement                                             |
|                                                               |
|         1. valeur absolue                                     |
|         2. valeur relative en %                               |
|         3. fraction des mailles en %                          |
|                                                               |
|     - ``threshold`` : valeur du seuil                         |
+---------------------------------------------------------------+
| .. module:: GetRefinThrType                                   |
|                                                               |
| **GetRefinThrType()**                                         |
|     Retourne le type de seuil de raffinement                  |
+---------------------------------------------------------------+
| .. module:: SetUnRefThr                                       |
|                                                               |
| **SetUnRefThr(type_thres, threshold)**                        |
|                                                               |
|     - ``type_thres`` : entier prcisant le type de seuil en   |
|       draffinement                                           |
|                                                               |
|         1. valeur absolue                                     |
|         2. valeur relative en %                               |
|         3. fraction des mailles en %                          |
|                                                               |
|     - ``threshold`` : valeur du seuil                         |
+---------------------------------------------------------------+
| .. module:: GetUnRefThrType                                   |
|                                                               |
| **GetUnRefThrType()**                                         |
|     Retourne le type de seuil de draffinement                |
+---------------------------------------------------------------+


Les composantes du champ
^^^^^^^^^^^^^^^^^^^^^^^^

+---------------------------------------------------------------+
+===============================================================+
| .. module:: AddComp                                           |
|                                                               |
| **AddComp(comp_name)**                                        |
|                                                               |
|     - ``comp_name`` : nom d'une composante  prendre en       |
|       compte                                                  |
+---------------------------------------------------------------+
| .. module:: SetUseComp                                        |
|                                                               |
| **SetUseComp(use_comp)**                                      |
|                                                               |
|     - ``use_comp`` : entier prcisant l'usage des composantes |
|                                                               |
|         0. norme L2 (dfaut)                                  |
|         1. norme infinie                                      |
|         2. valeur relative, uniquement si une seule composante|
+---------------------------------------------------------------+
| .. module:: GetListComp                                       |
|                                                               |
| **GetListComp()**                                             |
|     Retourne la liste des composantes utilises               |
+---------------------------------------------------------------+

Le filtrage par les groupes
^^^^^^^^^^^^^^^^^^^^^^^^^^^

+---------------------------------------------------------------+
+===============================================================+
| .. module:: AddGroup                                          |
|                                                               |
| **AddGroup(group_name)**                                      |
|                                                               |
|     - ``group_name`` : nom du groupe  prendre en compte      |
+---------------------------------------------------------------+
| .. module:: GetGroups                                         |
|                                                               |
| **GetGroups()**                                               |
|     Retourne la liste des groupes utiliss pour le filtrage   |
+---------------------------------------------------------------+

Exemple
"""""""
La cration de l'objet hypo_1 se fait ainsi : ::

    hypo_1 = homard.CreateHypothesis("HypoField")
    hypo_1.SetAdapRefinUnRef(1, 1, 0)
    hypo_1.SetField("INDICATEUR")
    hypo_1.AddComp("INDX")
    hypo_1.AddComp("INDZ")
    hypo_1.SetRefinThr(1, 80.)


