source: sasview/src/sas/sasgui/perspectives/calculator/media/image_viewer_help.rst @ 5251ec6

magnetic_scattrelease-4.2.2ticket-1009ticket-1249
Last change on this file since 5251ec6 was 412e9e8b, checked in by butler, 7 years ago

Fix viewer documentation

Replaced the three images for the image_viewer_help.rst with new ones
that reflect the latest features. Also replaced the bmp with png.
Finaly added a comment in the image_viewer.py code noting the close
error generated by PIL (for any non png images). This should complete
the work on this branch.

  • Property mode set to 100644
File size: 1.6 KB
RevLine 
[920928f]1.. image_viewer_help.rst
[379b87a]2
[78f02c3]3.. This is a port of the original SasView html help file to ReSTructured text
4.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
5
[da456fb]6.. _Image_Viewer_Tool:
7
[379b87a]8Image Viewer Tool
9=================
10
[78f02c3]11Description
12-----------
13
14This tool loads image files and displays them as 2D (x-y coordinate against
15counts per pixel). The plot can then can be saved, printed, and copied. The
16plot can also be resized by dragging the corner of the panel.
17
[1e01486]18The supported input image formats are:
19
20*  BMP (bitmap format)
21*  GIF (graphical interchange format)
22*  JPG (joint photographic experts group format)
23*  PNG (portable network graphics format)
24*  TIF (tagged image format)
[78f02c3]25
26.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
27
[a9dc4eb]28Using the tool
29--------------
[78f02c3]30
[1e01486]311) Select *Image Viewer* from the *Tool* menu on the SasView toolbar.
[78f02c3]32
[80c84b5]332) Select a file and then click *Open*. If the loading is successful the image
34   will be displayed.
[78f02c3]35
[412e9e8b]36.. image:: load_image.png
[78f02c3]37
[1e01486]383) To save, print, or copy the image, or to apply a grid overlay, right-click
39   anywhere in the plot.
[78f02c3]40
[412e9e8b]41.. image:: pic_plot.png
[78f02c3]42
[1e01486]434. If the image is taken from a 2D detector, SasView can attempt to convert
44   the colour/grey scale into pseudo-intensity 2D data using
[78f02c3]45
[1e01486]46   z = (0.299 x R) + (0.587 x G) + (0.114 x B)
[78f02c3]47
[1e01486]48   unless the image is formatted as 8-bit grey-scale TIF.
[78f02c3]49
[1e01486]505. In the *Convert to Data* dialog, set the parameters relevant to the data and
51   then click the OK.
[78f02c3]52
[412e9e8b]53.. image:: pic_convert.png
[1e01486]54
55.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
56
[a9dc4eb]57.. note::  This help document was last changed by Steve King, 01May2015
Note: See TracBrowser for help on using the repository browser.