doc/salome/gui/HYDRO/input/bathymetry.doc

   1
   2 /**
   3   @file
   4   \brief Help for the bathymetry
   5 */
   6
   7 /**
   8   \page bathymetry Bathymetry
   9
  10   <a href="index.html"><b>Back to Main page.</b></a>
  11
  12   Bathymetry is an altitude object. It associates an altitude value to each point on the 2D plane.
  13
  14   <b>Import bathymetry</b> input panel can be opened via:<ol>
  15   <li> The main menu <b>HYDRO => Import bathymetry</b>;
  16   <li> Context menu of <b>BATHYMETRIES</b> in Object browser => <b>Import bathymetry</b>;
  17   <li> <b>CTRL + B</b> buttons combination;
  18   <li> <b>Import bathymetry</b> toolar button.\image html import_bathymetry_toolbar_button.png "Import bathymetry toolbar button"
  19   </ol>
  20
  21   Arguments of the input panel:
  22
  23   \image html import_bathymetry_input_panel.png "Import bathymetry input panel"
  24
  25 <b>File name</b> - field to select file to import. Supported format: <b>.XYZ</b>(Bathymetry files);<br>
  26 <b>Name</b> - field to define bathymetry object name;<br>
  27 <b>Invert altitude object</b> -  if this checkbox is ON, Z-coordinates of imported bathymetry become inverted. If checkbox is OFF, file is imported without modification.<br>
  28 <b>Apply</b> - button to create bathymetry object;<br>
  29 <b>Apply and Close</b> - button to create bathymetry object and close input panel;<br>
  30 <b>Close</b> - button to close input panel.
  31
  32 <b>Example</b>:<br>
  33
  34 \image html bathymetry_example.png "Bathymetry zone example"
  35
  36 <a href="index.html"><b>Back to Main page.</b></a>
  37 */