Changeset 78f02c3 in sasview for src/sas/perspectives/calculator/media

Timestamp:

Feb 14, 2015 12:12:40 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:

898a8b9

Parents:

3e2ebbb

Message:

Level 1 sphinx-ready commit of remaining help files

Location:

src/sas/perspectives/calculator/media

Files:

• image_viewer_help.rst (modified) (1 diff)
• python_shell_help.rst (modified) (1 diff)

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

@@ -1 +1 @@
 ..image_viewer_help.rst
+
+.. 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.
 
 Image Viewer Tool
 =================
 
-Placeholder for image viewer help
+Description
+-----------
+
+This tool loads image files and displays them as 2D (x-y coordinate against 
+counts per pixel). The plot can then can be saved, printed, and copied. The 
+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)
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+How To
+------
+
+1. Select 'Image Viewer' under the 'Tool' menu in the menubar.
+
+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).
+
+.. 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).
+
+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).
+
+.. 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 
+
+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.
+
+In the "Convert to Data" dialog, set the parameters relevant to your data and 
+then click the OK button.
+
+.. image:: pic_convert.bmp

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

@@ -1 +1 @@
 ..python_shell_help.rst
+
+.. 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.
 
 Python Shell Tool
 =================
 
-Placeholder for python shell help
+Description 
+-----------
+
+This is a Python shell (PyCrust) provided with WxPython. An editing notebook 
+will show up when a Python file is loaded from the 'New' or 'Open' menu. 
+
+The 'Run' menu is added for the editor to be able to compile and run the Python 
+code.
+
+For the details about the Python, visit the website 
+http://docs.python.org/tutorial/
+
+The numpy, scipy, matplotlib, etc, libraries are shipped with SasView. However, 
+some functionalities of those packages may or may not work.
+
+PyCrust includes its own Help menu in the shell window.
+
+Note: Help() and Credits() do not work on Macs.
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+Example
+-------
+
+An example from the matplotlib gallery:
+
+.. image:: pycrust_example.bmp