Salome HOME
refs #676: repairing of the documentation system and help
[modules/hydro.git] / doc / salome / gui / HYDRO / input / import_image.doc
diff --git a/doc/salome/gui/HYDRO/input/import_image.doc b/doc/salome/gui/HYDRO/input/import_image.doc
new file mode 100644 (file)
index 0000000..553c26b
--- /dev/null
@@ -0,0 +1,54 @@
+
+/**
+  @file
+  \brief Help for the import image
+*/
+
+/**
+  \page impimage Import image
+
+  <a href="index.html"><b>Back to Main page.</b></a>
+  
+  <b>Import image</b> input panel can be opened via:<ol>
+  <li> The main menu <b>HYDRO => Import image</b>;
+  <li> Context menu of <b>IMAGES</b> in Object browser => <b>Import image</b>;
+  <li> <b>CTRL + I</b> buttons combination;
+  <li> <b>Import image</b> toolar button. \image html import_image_toolbar_button.png "Import image toolbar button"
+  </ol> 
+   
+   Arguments of the input panel: 
+
+  \image html impot_image_dialog.png "Import image input panel"
+  
+<b>File name</b> - field for defining file to import. Supported formats are .bmp, .jpg, .jpeg, .png, .tif.<br>
+<b>Name</b> - field for defining the name of image after import. By default - the name of the file;<br>
+<b>Apply</b> - button to create image object;<br>
+<b>Apply and Close</b> - button to create image object and close input panel;<br>
+<b>Close</b> - button to close input panel.<br>
+  Another fields become enabled:
+  
+  \image html import_image_enabled.png "Enabled Import image input panel"
+  
+  By default, two points should be used for the image positioning. The corresponding transformation should be built using the rules: only panning, rotation and scaling are allowed; the scaling is same along X, Y; all angles are kept.<br>
+  An additional check box allows the user to activate usage of the 3-rd point (unchecked by default). When user activates it he can select the 3-rd point exactly as previous two and in this case the complete affine transformation is applied (note that angles can be not kept and scaling along X, Y may be different in this case).<br>
+  
+  Coordinates of points can be defined via:<ol>
+  
+  <li> <b>Manually input Geographic coordinates</b>
+       <br>It's necessary to to input latitude and longitude of points.
+       \image html geographic_coordinates.png "Geographic coordinates"
+  
+  <li> <b>Manually input Plane coordinates(Lambert93)</b>
+       <br>It's necessary to input lambert coordinates of points.
+       \image html lambert_coordinates.png "Lambert coordinates"
+  
+  <li> <b>Get Plane coordinates (Lambert93) from file</b>
+       <br>It's necessary to load file with lambert coordinates. Supported format - <b>.GRF</b> (image georeferencement file)
+  
+  <li> <b>Choose points on reference image</b>
+       <br>It's necessary to choose reference image from combo box
+       \image html reference_image.png "Combo-box for defining reference image"
+</ol> 
+
+<a href="index.html"><b>Back to Main page.</b></a>
+*/