doc/salome/gui/HYDRO/profile_interpolation.h

   1
   2 /**
   3   @file
   4   \brief Help for the find bottom
   5 */
   6
   7 /**
   8   \page profilesinterpolation Profiles interpolation
   9
  10   <a href="index.html"><b>Back to Main page.</b></a>
  11
  12   <b>Profiles interpolation</b> operation builds additional profiles to get more detailed river bed.
  13
  14   <b>Profiles interpolation</b> input panel can be opened via:<ol>
  15   <li> The main menu <b>HYDRO => Stream => Profiles interpolation</b>;
  16   <li>Context menu of <b>Stream</b> object in Object browser - <b>Profiles interpolation</b>;</li>
  17   </ol>
  18
  19  <b>Profiles interpolation</b> input panel looks like:
  20
  21   \image html profiles_interpolation_input_panel.png "Profiles interpolation input panel"
  22
  23  Arguments of the input panel: <br>
  24
  25 <b>Stream object</b> - combo-box to define reference stream object;<br>
  26 <b>Interpolator</b> - combo-box to define interpolation algorithm used. Currently only linear interpolation is accessible;<br>
  27 <b>Description</b> - field, describing interpolation method's features;<br>
  28 <b>Profile 1</b> - combo-box to define profile, which will be the <b>start</b> of interpolation;<br>
  29 <b>Profile 1</b> - combo-box to define profile, which will be the <b>end</b> of interpolation;<br>
  30 <b>Number of profiles</b> - spin-box to define the quantity of profiles which will be created;<br>
  31 <b>Parameters</b> - field to set additional interpolation parameters (name as string, value as string): <ul>
  32 <li>complete line of parameters should be input by user as a single text line and it should be parsed by spaces i.e. for example “len 5 hypothesis linear” will give additional parameters “len” = “5”; “hypothesis” = “linear”;</li>
  33 <li>the sense of such parameters depends on the interpolator implementation;</li>
  34 <li>parameters are passed to interpolator by several calls of “set” function (for each pair name, value);</li>
  35 </ul>
  36 <b>Apply</b> - button to build stream's bottom;<br>
  37 <b>Apply and Close</b> - button to build stream's bottom and close input panel;<br>
  38 <b>Close</b> - button to close input panel.
  39
  40 The input panel built-in viewer shows profiles from selected reference stream object and  profiles to be created during interpolation. The existing profiles are shown as black curves, the new profiles – as red curves:
  41
  42 \image html profile_interpolation_preview.png "Profile interpolation preview"
  43
  44 <a href="index.html"><b>Back to Main page.</b></a>
  45 */