Salome HOME
Merge branch 'BR_2018_V8_5' into BR_PY3
[modules/hydro.git] / doc / salome / tutorial / import.rst
1 ..
2    Copyright (C) 2015-2016 EDF
3
4    This file is part of SALOME HYDRO module.
5
6    SALOME HYDRO module is free software: you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation, either version 3 of the License, or
9    (at your option) any later version.
10
11    SALOME HYDRO module is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
18
19 #########################################
20 Import des images et fonds de plan
21 #########################################
22
23 .. |Hydro_module_button| image:: /_static/HYDRO.png
24    :align: middle
25    :width: 16pt
26    :height: 16pt
27
28 .. |Hydro_module_launch| image:: /_static/LaunchHYDRO.png
29    :align: middle
30
31 .. |import_image| image:: /_static/importImage.png
32    :align: middle
33
34 .. |import_image2| image:: /_static/importImage2.png
35    :align: middle
36
37 .. |selection_A| image:: /_static/selectionA.png
38    :align: middle
39
40 .. |selection_B| image:: /_static/selectionB.png
41    :align: middle
42
43 .. |selection_B2| image:: /_static/selectionB2.png
44    :align: middle
45
46 .. |fit_all| image:: /_static/fitall.png
47    :align: middle
48
49 .. |import_image_B| image:: /_static/importImageB.png
50    :align: middle
51
52 .. |deux_images| image:: /_static/deuxImages.png
53    :align: middle
54
55 .. |zoom_style| image:: /_static/zoomStyle.png
56    :align: middle
57
58 Chargement du module HYDRO
59 ==========================
60
61 Pour activer le module HYDRO, il faut le sélectionner dans la liste défilante des modules 
62 ou cliquer sur son icône dans le bandeau : |Hydro_module_button|.
63
64   |Hydro_module_launch|
65
66
67 Import et géoréférencement d'une première image
68 ===============================================
69
70 Pour construire le contour de la rivière, nous allons importer plusieurs images.
71 Ici il s'agit de cartes que l'on peut télécharger à partir de sites comme `Géoportail`_ 
72 ou le site de l'IGN. Géoportail offre la possibilité de trouver les coordonnées de points dans
73 une image, nécessaires au géoréférencement. 
74
75 .. _Géoportail: http://www.geoportail.gouv.fr/accueil
76
77 Pour importer une image, nous utilisons le menu contextuel (clic droit) de la rubrique *IMAGES* dans l'arbre de
78 l'étude SALOME: 
79
80   |import_image|
81   
82 La première image se trouve dans le répertoire d'installation de l'application SALOME HYDRO ::
83
84   <appli_xxx>/bin/salome/test/HYDRO/garonne_ign_01.png
85
86 L'image est affichée, avec deux points *A* et *B* qui vont être repositionnés à des emplacements
87 dont on connaît les coordonnées dans le repère Lambert 93, choisis assez éloignés l'un de l'autre
88 pour garder une bonne précision.
89
90   |import_image2|
91  
92 Voici les deux points particuliers dont on a préalablement repéré les coordonnées avec Géoportail :
93
94   |selection_A|
95
96 coordonnées (471562, 6367750): un point en dessous à gauche de la marque *92*.
97
98   |selection_B|
99
100 coordonnées (489400, 6377020): le centre de la croix à coté de *Hautevignes*.
101
102  * **remarque** : Pour contrôler le zoom sur la carte, on utilise la touche <Ctrl> avec le bouton gauche 
103    de la souris. Pour se déplacer sur la carte, il faut utiliser la touche <Ctrl> avec le bouton du milieu 
104    de la souris.
105
106 Nous sélectionnons successivement le point A, puis le point B, en utilisant les boutons 
107 *Activate point A selection* puis *Activate point B selection*.
108 Après avoir sélectionné les deux points, le dialogue de géoréférencement ressemble à ceci :
109
110   |selection_B2|
111
112 Pour les coordonnées x,y de chaque point, la première colonne donne les coordonnées du pixel de l'image, 
113 la deuxième colonne donne les coordonnées géographiques.
114
115 Nous validons le géoréférencement avec le bouton *Apply and Close*.
116 Il faut s'assurer que l'icône "oeil" à gauche du nom de l'image dans l'arbre est bien active, et recentrer l'image
117 à l'aide du bouton *fit all* : |fit_all|. 
118
119 L'image obtenue est légèrement inclinée vers la droite.
120
121  * **remarque** : dans cette vue, le zoom peut se faire à l'aide de la molette de la souris.
122    Le zoom peut être centré sur la position de la souris, ou au centre de l'image. C'est une option accessible dans le menu 
123    *File/préférences* sous la rubrique *SALOME*, onglet *3D viewer*, *zooming style* :
124
125   |zoom_style|
126
127 Quand on promène la souris sur la carte, les coordonnées du curseur s'affichent dans la barre d'état
128 en bas à gauche de l'application.
129
130  * **remarque** : il faut prendre l'habitude de **sauver l'étude en cours régulièrement**
131    (menu *File/Save* ou *File/Save as*). Il est également conseillé de sauvegarder les différentes
132    étapes de l'étude dans des fichiers différents : *il est arrivé, dans certaines circonstances difficiles
133    à reproduire, que l'étude soit sauvée de manière incomplète.* Les cas où ce problème est survenu
134    correspondent à des rechargements d'études comprenant des données de plusieurs modules, et pour lesquels
135    le module HYDRO n'a pas été activé avant la sauvegarde. On se prémunit contre se risque de sauvegarde
136    incomplète en activant le module HYDRO avant de sauvegarder l'étude. 
137
138 Import d'une deuxième image, géoréférencée à partir la première
139 ===============================================================
140
141 La deuxième image est au même endroit que la première ::
142
143   <appli_xxx>/bin/salome/test/HYDRO/garonne_ign_02.png
144
145 Pour la géoréférencer, nous utilisons l'option *choose points on the reference image* du dialogue.
146 Après avoir sélectionné la première image comme référence, nous voyons les deux images l'une en dessus de l'autre.
147 Nous sélectionnons d'abord un point A au même emplacement sur les deux images, puis un point B.
148 Il faut prendre deux points les plus éloignés possible, et zoomer suffisamment pour être précis.
149 Le dialogue ressemble alors à ceci :
150
151   |import_image_B|
152
153 Après avoir validé le dialogue, puis affiché les deux images et recentré la vue, nous obtenons :
154
155   |deux_images|
156
157 Définition d'un repère local
158 ============================
159
160 Le repère local permet la manipulation de petits nombres. **Le changement de repère améliore
161 beaucoup la précision des étapes de géométrie, de maillage et de calcul**. Notamment, le fait 
162 de garder des grands nombres peut rendre impossible l'obtention d'un maillage de bonne qualité.
163
164 Dans le menu *HYDRO/Change Local CS*, nous saisissons les coordonnées de la nouvelle origine.
165
166 Pour notre exemple, nous prenons pour origine le point (430 000, 6 350 000) situé
167 au sud ouest de notre domaine d'étude.
168
169 Après avoir validé le changement de repère, nous constatons que les coordonnées du curseur 
170 qui s'affichent dans la barre d'état en bas à gauche de l'application sont fournies dans
171 les deux repères (local et global).
172
173   * **remarque** : ce changement de repère peut être fait plusieurs fois, à différents moments
174     de l'étude, car tout ce qui a déjà été importé est transposé par l'application,
175     mais il est préférable de le faire assez tôt pour minimiser les risques d'erreur ou d'incohérence,
176     et, en tous cas, avant d'exporter des éléments du module HYDRO, notamment la géométrie de calcul.
177     **Il est recommandé de fixer le repère local tôt dans l'étude, dès que l'étendue du domaine de calcul
178     est connue**.
179     
180   * Après un changement de repère local, if faut mettre à jour les données de l'arbre qui apparaissent en bleu italique
181     avec le menu contextuel *update*, puis recentrer la vue avec la commande *Fit All*.
182
183 Dump Python
184 ===========
185
186 Toutes les opérations effectuées à l'interface graphique ont leur équivalent en script Python.
187 On peut faire un dump de l'étude dans un script avec le menu *File/Dump Study*.
188 Le script Python obtenu permet, en partant d'une étude SALOME vierge, de reconstruire les données
189 de l'étude. ce script est, bien sûr, éditable.
190
191 On peut faire le dump après la définition du repère local, et comparer le fichier obtenu avec ::
192
193   <appli_xxx>/bin/salome/test/HYDRO/h003_changeLCS.py
194
195 On pourra vérifier la bonne exécution du dump en repartant d'une étude vierge (redémarrer SALOME,
196 *new document*, ou seulement *new document*), puis menu *File/Load Script* et activation du module HYDRO.
197
198 .. only:: html
199
200    :ref:`ref_exempleInondation`