Salome HOME
refs #676: repairing of the documentation system and help
[modules/hydro.git] / doc / salome / gui / HYDRO / input / profile_interpolation.doc
diff --git a/doc/salome/gui/HYDRO/input/profile_interpolation.doc b/doc/salome/gui/HYDRO/input/profile_interpolation.doc
new file mode 100644 (file)
index 0000000..7bc9a05
--- /dev/null
@@ -0,0 +1,45 @@
+
+/**
+  @file
+  \brief Help for the find bottom
+*/
+
+/**
+  \page profilesinterpolation Profiles interpolation
+  
+  <a href="index.html"><b>Back to Main page.</b></a>
+
+  <b>Profiles interpolation</b> operation builds additional profiles to get more detailed river bed.
+  
+  <b>Profiles interpolation</b> input panel can be opened via:<ol>
+  <li> The main menu <b>HYDRO => Stream => Profiles interpolation</b>;
+  <li>Context menu of <b>Stream</b> object in Object browser - <b>Profiles interpolation</b>;</li>
+  </ol> 
+   
+ <b>Profiles interpolation</b> input panel looks like: 
+
+  \image html profiles_interpolation_input_panel.png "Profiles interpolation input panel"
+  
+ Arguments of the input panel: <br>  
+<b>Stream object</b> - combo-box to define reference stream object;<br>
+<b>Interpolator</b> - combo-box to define interpolation algorithm used. Currently only linear interpolation is accessible;<br>
+<b>Description</b> - field, describing interpolation method's features;<br> 
+<b>Profile 1</b> - combo-box to define profile, which will be the <b>start</b> of interpolation;<br>
+<b>Profile 1</b> - combo-box to define profile, which will be the <b>end</b> of interpolation;<br>
+<b>Number of profiles</b> - spin-box to define the quantity of profiles which will be created;<br>
+<b>Parameters</b> - field to set additional interpolation parameters (name as string, value as string): <ul>
+<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>
+<li>the sense of such parameters depends on the interpolator implementation;</li>
+<li>parameters are passed to interpolator by several calls of “set” function (for each pair name, value);</li>
+</ul>
+<b>Apply</b> - button to build stream's bottom;<br>
+<b>Apply and Close</b> - button to build stream's bottom and close input panel;<br>
+<b>Close</b> - button to close input panel.
+
+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:
+  
+\image html profile_interpolation_preview.png "Profile interpolation preview"
+
+<a href="index.html"><b>Back to Main page.</b></a>
+*/