doc/salome/gui/HYDRO/import_profile.h

   1
   2 /**
   3   @file
   4   \brief Help for the import profile
   5 */
   6
   7 /**
   8   \page import_profile  Import profile
   9
  10   <a href="index.html"><b>Back to Main page.</b></a>
  11
  12   Import profiles in HYDROGUI module from external file is accessible via:<ul>
  13   <li>The main menu <b>HYDRO => Profile => Import profiles</b>;</li>
  14   <li>Context menu of PROFILES in Object browser - <b>Import profiles</b>;</li>
  15   <li><b>Import profiles from file(s)</b> toolar button.</li>
  16
  17 \image html import_profile_toolbar_button.png "Import profiles from file(s) toolbar button"
  18   </ul>
  19
  20   <b>Import profile</b> dialog box appears:
  21    \image html import_profile_dialog_box.png "Import profile dialog box"
  22
  23
  24 The user selects folder in <b>Look in</b> filed and one or several desired file in this folder.
  25
  26 The user clicks <b>Open</b> button.
  27
  28 <b>Open File</b> dialog box is closed. Selected profile(s) appear(s) in Object browser. 2D profiles names are colored in red, 3D profile names with georteferncement are colored in black.
  29
  30 \image html imported_profiles.png "Imported profiles in Object browser"
  31
  32 The profile file format is text where each line corresponds to one point in the profile.
  33
  34 Depending on number of values in line two use cases can be distinguished: <ul>
  35
  36 <li>    2D case -  each line contains 2 double values  (parametric case).  Note, that the X values should increase so if the current value is less than previous it can be  interpreted as start of new profile.</li>
  37 <li>    3D case - each line contains 3 double values. First and last points are interpreted as points of georeferencement: first point is G (left bank), last point is D (right bank). The intermediate points should be recalculated to parametric presentation according to rule: the profile is straight segment on plan, and for each point U is equal to distance from the current point to the first point and Z is taken as is from the file.</li>
  38  </ul>
  39
  40  <a href="index.html"><b>Back to Main page.</b></a>
  41 */