Salome HOME
Merge branch 'BR_PORTING_OCCT_7' into pre/V8_3_BR
[modules/hydro.git] / doc / salome / tutorial / english / english_importBathy.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 Bathymetry import
21 #######################
22
23 .. |import_bathy1| image:: /../_static/bathy1.png
24    :align: middle
25
26 The HYDRO module enables bathymetry file types that have .xyz or .asc extensions to be imported.
27 These are ASCII text files. The .xyz files contain one point per line, with the x y z coordinates,
28 whereas the .asc files are formatted in a Cartesian x, y grid structure. The .asc files contain a header
29 which lists the number of lines and columns, the coordinates of the south western corner and the cell-size in x and in y,
30 below which is a matrix of the z altitude values. It is also possible to import bathymetries contained
31 in SinusX-format files, as will be described later. 
32
33 Two files need to be imported for the purposes of this study. 
34 They are found in the installation directory of the SALOME HYDRO application::
35
36   <appli_xxx>/bin/salome/test/HYDRO/cloud_02.xyz 
37
38   <appli_xxx>/bin/salome/test/HYDRO/garonne_point_L93.xyz 
39
40 The *cloud_02.xyz* file is an extract of IGN data on a regular grid with one point every 75 m, freely available. 
41 The *garonne_point_L93.xyz* file corresponds to an earlier study, covers the major bed of the river over the region
42 and is potentially more precise than the previous file, at least on the minor bed. 
43
44 These files are imported using the context menu of the *BATHYMETRIES* folder in the SALOME study tree.
45 The import dialog box permits the user to select the file to be imported and to change its name in the study tree.
46 The import instructions are confirmed by clicking on the *Apply and Close* button. 
47
48 To display the bathymetry, click on the eye opposite its name and re-centre the image using the *fit all* button.
49  
50 The points are coloured according to their altitudes and the colour ranges are adjusted according to the minimum
51 and maximum of all the displayed fields. The corresponding legend is always displayed. 
52
53 You should obtain a view that looks like this:
54
55   |import_bathy1|
56
57
58 .. only:: html
59
60    :ref:`ref_exempleInondation`