1 .. _tui_create_hypothese:
6 .. index:: single: itération
7 .. index:: single: hypothèse
8 .. index:: single: zone
10 Les variables sont décrites dans :ref:`gui_create_hypothese`.
12 Méthodes de la classe homard
13 """"""""""""""""""""""""""""
15 +---------------------------------------------------------------+
16 +===============================================================+
17 | .. module:: CreateHypothesis |
19 | **CreateHypothesis(hypo_name)** |
20 | Retourne une instance de la classe hypothese |
22 | - ``hypo_name`` : le nom de l'hypothèse |
23 +---------------------------------------------------------------+
24 | .. module:: AssociateHypoZone |
26 | **AssociateHypoZone(hypo_name, zone_name)** |
28 | - ``hypo_name`` : le nom de l'hypothèse |
29 | - ``zone_name`` : le nom de la zone à associer |
30 +---------------------------------------------------------------+
32 Méthodes de la classe hypothese
33 """""""""""""""""""""""""""""""
38 +---------------------------------------------------------------+
39 +===============================================================+
40 | .. module:: GetName |
43 | Retourne le nom de l'hypothèse |
44 +---------------------------------------------------------------+
45 | .. module:: SetAdapRefinUnRef |
47 | **SetAdapRefinUnRef(Adap, Refin, UnRef)** |
49 | - ``Adap`` : entier précisant le type d'adaptation |
52 | * 0 : selon des zones |
53 | * 1 : selon un champ |
55 | - ``Refin`` : entier précisant si le raffinement est actif|
60 | - ``UnRef`` : entier précisant si déraffinement est actif |
65 +---------------------------------------------------------------+
66 | .. module:: GetAdapType |
69 | Retourne le type d'adaptation |
70 +---------------------------------------------------------------+
71 | .. module:: GetRefinType |
73 | **GetRefinType()** |
74 | Retourne le type de raffinement |
75 +---------------------------------------------------------------+
76 | .. module:: GetUnRefType |
78 | **GetUnRefType()** |
79 | Retourne le type de déraffinement |
80 +---------------------------------------------------------------+
82 Le champ et les seuils
83 ^^^^^^^^^^^^^^^^^^^^^^
85 +---------------------------------------------------------------+
86 +===============================================================+
87 | .. module:: SetField |
89 | **SetField(field_name)** |
91 | - ``field_name`` : le nom du champ |
92 +---------------------------------------------------------------+
93 | .. module:: GetFieldName |
95 | **GetFieldName()** |
96 | Retourne le nom du champ |
97 +---------------------------------------------------------------+
98 | .. module:: SetUseField |
100 | **SetUseField(use_field)** |
102 | - ``use_field`` : entier précisant l'usage du champ |
104 | 0. valeur par maille (défaut) |
105 | 1. saut entre une maille et ses voisines |
106 +---------------------------------------------------------------+
107 | .. module:: SetRefinThr |
109 | **SetRefinThr(type_thres, threshold)** |
111 | - ``type_thres`` : entier précisant le type de seuil en |
114 | 1. valeur absolue |
115 | 2. valeur relative en % |
116 | 3. fraction des mailles en % |
118 | - ``threshold`` : valeur du seuil |
119 +---------------------------------------------------------------+
120 | .. module:: GetRefinThrType |
122 | **GetRefinThrType()** |
123 | Retourne le type de seuil de raffinement |
124 +---------------------------------------------------------------+
125 | .. module:: SetUnRefThr |
127 | **SetUnRefThr(type_thres, threshold)** |
129 | - ``type_thres`` : entier précisant le type de seuil en |
132 | 1. valeur absolue |
133 | 2. valeur relative en % |
134 | 3. fraction des mailles en % |
136 | - ``threshold`` : valeur du seuil |
137 +---------------------------------------------------------------+
138 | .. module:: GetUnRefThrType |
140 | **GetUnRefThrType()** |
141 | Retourne le type de seuil de déraffinement |
142 +---------------------------------------------------------------+
145 Les composantes du champ
146 ^^^^^^^^^^^^^^^^^^^^^^^^
148 +---------------------------------------------------------------+
149 +===============================================================+
150 | .. module:: AddComp |
152 | **AddComp(comp_name)** |
154 | - ``comp_name`` : nom d'une composante à prendre en |
156 +---------------------------------------------------------------+
157 | .. module:: SetUseComp |
159 | **SetUseComp(use_comp)** |
161 | - ``use_comp`` : entier précisant l'usage des composantes |
163 | 0. norme L2 (défaut) |
165 | 2. valeur relative, uniquement si une seule composante|
166 +---------------------------------------------------------------+
167 | .. module:: GetListComp |
169 | **GetListComp()** |
170 | Retourne la liste des composantes utilisées |
171 +---------------------------------------------------------------+
173 Le filtrage par les groupes
174 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
176 +---------------------------------------------------------------+
177 +===============================================================+
178 | .. module:: AddGroup |
180 | **AddGroup(group_name)** |
182 | - ``group_name`` : nom du groupe à prendre en compte |
183 +---------------------------------------------------------------+
184 | .. module:: GetGroups |
187 | Retourne la liste des groupes utilisés pour le filtrage |
188 +---------------------------------------------------------------+
192 La création de l'objet hypo_1 se fait ainsi : ::
194 hypo_1 = homard.CreateHypothesis("HypoField")
195 hypo_1.SetAdapRefinUnRef(1, 1, 0)
196 hypo_1.SetField("INDICATEUR")
197 hypo_1.AddComp("INDX")
198 hypo_1.AddComp("INDZ")
199 hypo_1.SetRefinThr(1, 80.)