Changeset 1e01486 in sasview for src/sas/perspectives/calculator/media

Timestamp:

Feb 18, 2015 4:51:32 PM (10 years ago)

Author:

smk78

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

36819ee

Parents:

ad4d8b4

Message:

Proof read.

Location:

src/sas/perspectives/calculator/media

Files:

• image_viewer_help.rst (modified) (2 diffs)
• kiessig_calculator_help.rst (modified) (2 diffs)

src/sas/perspectives/calculator/media/image_viewer_help.rst

@@ -14 +14 @@
 plot can also be resized by dragging the corner of the panel.
 
-Supported image formats are png, bmp, gif, or jpg. (There is currently a bug in 
-the tif loader)
+The supported input image formats are:
+
+*  BMP (bitmap format)
+*  GIF (graphical interchange format)
+*  JPG (joint photographic experts group format)
+*  PNG (portable network graphics format)
+*  TIF (tagged image format)
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -22 +27 @@
 ------
 
-1. Select 'Image Viewer' under the 'Tool' menu in the menubar.
+1) Select *Image Viewer* from the *Tool* menu on the SasView toolbar.
 
-2. Select a file type from the drop-box at the bottom of the file dialog panel, 
-choose a file of interest, and then click the 'Open' button (see the 
-picture below).
+2) Select a file and then click *Open*.
 
 .. image:: load_image.bmp
 
-3. If the loading is successful, the image will be displayed. The file name 
-will be shown in the title bar (see the picture below).
+   If the loading is successful the image will be displayed.
 
-4. Some options such as saving, printing, and copying are available from the 
-menubar, or in the context-menu (by right-clicking anywhere in the plot).
+3) To save, print, or copy the image, or to apply a grid overlay, right-click 
+   anywhere in the plot.
 
 .. image:: pic_plot.bmp
 
-5. If the image is taken from a 2D detector, it can be converted into 2D data 
-where the z values are computed as 
+4. If the image is taken from a 2D detector, SasView can attempt to convert 
+   the colour/grey scale into pseudo-intensity 2D data using 
 
-z = (0.299 x R) + (0.587 x G) + (0.114 x B)
+   z = (0.299 x R) + (0.587 x G) + (0.114 x B)
 
-unless the picture file is formatted as 8-bit grey-scale tif.
+   unless the image is formatted as 8-bit grey-scale TIF.
 
-In the "Convert to Data" dialog, set the parameters relevant to your data and 
-then click the OK button.
+5. In the *Convert to Data* dialog, set the parameters relevant to the data and 
+   then click the OK.
 
 .. image:: pic_convert.bmp
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. note::  This help document was last changed by Steve King, 18Feb2015

src/sas/perspectives/calculator/media/kiessig_calculator_help.rst

@@ -3 +3 @@
 .. This is a port of the original SasView html help file to ReSTructured text
 .. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
+
+.. |pi| unicode:: U+03C0
+.. |Ang| unicode:: U+212B
 
 Kiessig Thickness Calculator Tool
@@ -10 +13 @@
 -----------
 
-This tool is to approximately estimate the thickness of a layer or the 
-diameter of particles from the Kiessig fringe in SAS/NR data, and using the 
-Kiessig relation
+This tool is approximately estimates the thickness of a layer or the diameter 
+of particles from the position of the Kiessig fringe/Bragg peak in NR/SAS data 
+using the relation
 
-thickness = 2*Pi/fringe_width.
+(thickness *or* size) = 2 * |pi| / (fringe_width *or* peak position)
   
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
-
 
 How To
 ------
 
-To get a rough thickness or particle size, just type the Kiessig fringe width 
-(in units of 1/Angstrom) and click on the 'Compute' button. Then the output 
-value will be show up in the 'Thickness' text box.
+To get a rough thickness or particle size, simply type the fringe or peak 
+position (in units of 1/|Ang|\) and click on the *Compute* button.
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. note::  This help document was last changed by Steve King, 18Feb2015
+