Changes in src/sas/sasgui/guiframe/media/graph_help.rst [f93b473f:e68c9bf] in sasview

File:

• src/sas/sasgui/guiframe/media/graph_help.rst (modified) (28 diffs)

src/sas/sasgui/guiframe/media/graph_help.rst

@@ -20 +20 @@
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-To invoke the *Graph Menu* simply right-click on a data/theory plot, or click 
-the *Graph Menu* (bullet list) icon in the toolbar at the bottom of the plot. 
+To invoke the *Graph Menu* simply right-click on a data/theory plot, or click
+the *Graph Menu* (bullet list) icon in the toolbar at the bottom of the plot.
 Then select a menu item.
 
@@ -27 +27 @@
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-To expand a plot window, click the *Maximise* (square) icon in the top-right 
+To expand a plot window, click the *Maximise* (square) icon in the top-right
 corner.
 
-To shrink a plot window, click the *Restore down* (square-on-square) icon in 
+To shrink a plot window, click the *Restore down* (square-on-square) icon in
 the top-right corner.
 
-To hide a plot, click the *Minimise* (-) icon in the top-right corner of the 
+To hide a plot, click the *Minimise* (-) icon in the top-right corner of the
 plot window.
 
-To show a hidden plot, select the *Restore up* (square-on-square) icon on the 
+To show a hidden plot, select the *Restore up* (square-on-square) icon on the
 minimised window.
 
-To delete a plot, click the *Close* (x) icon in the top-right corner of the 
+To delete a plot, click the *Close* (x) icon in the top-right corner of the
 plot window.
 
-*NOTE! If a residuals graph (when fitting data) is hidden, it will not show up 
+*NOTE! If a residuals graph (when fitting data) is hidden, it will not show up
 after computation.*
 
@@ -48 +48 @@
 ^^^^^^^^^^^^^^^
 
-Select the *Pan* (crossed arrows) icon in the toolbar at the bottom of the plot 
-to activate this option. Move the mouse pointer to the plot. It will change to 
-a hand. Then left-click and drag the plot around. The axis values will adjust 
+Select the *Pan* (crossed arrows) icon in the toolbar at the bottom of the plot
+to activate this option. Move the mouse pointer to the plot. It will change to
+a hand. Then left-click and drag the plot around. The axis values will adjust
 accordingly.
- 
+
 To disable dragging mode, unselect the *crossed arrows* icon on the toolbar.
 
@@ -58 +58 @@
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-Select the *Zoom* (magnifying glass) button in the toolbar at the bottom of 
-the plot to activate this option. Move the mouse pointer to the plot. It will 
-change to a cross-hair. Then left-click and drag the pointer around to generate 
+Select the *Zoom* (magnifying glass) button in the toolbar at the bottom of
+the plot to activate this option. Move the mouse pointer to the plot. It will
+change to a cross-hair. Then left-click and drag the pointer around to generate
 a region of interest. Release the mouse button to generate the new view.
 
 To disable zoom mode, unselect the *Zoom* button on the toolbar.
 
-After zooming in on a a region, the *left arrow* or *right arrow* buttons on 
+After zooming in on a a region, the *left arrow* or *right arrow* buttons on
 the toolbar will switch between recent views.
 
-*NOTE! If a wheel mouse is available scrolling the wheel will zoom in/out 
-on the current plot (changing both axes). Alternatively, point at the numbers 
+*NOTE! If a wheel mouse is available scrolling the wheel will zoom in/out
+on the current plot (changing both axes). Alternatively, point at the numbers
 on one axis and scroll the wheel to zoom in/out on just that axis.*
 
-To return to the original view of the data, click the the *Reset* (home) icon 
+To return to the original view of the data, click the the *Reset* (home) icon
 in the toolbar at the bottom of the plot (see Resetting_the_graph_ for further details).
 
@@ -78 +78 @@
 ^^^^^^^^^^^^^^^^^^^
 
-To save the current plot as an image file, right click on the plot to bring up 
+To save the current plot as an image file, right click on the plot to bring up
 the *Graph Menu* (see Invoking_the_graph_menu_) and select *Save Image*.
-Alternatively, click on the *Save* (floppy disk) icon in the toolbar at the 
+Alternatively, click on the *Save* (floppy disk) icon in the toolbar at the
 bottom of the plot.
- 
-A dialog window will open. Select a folder, enter a filename, choose an output 
+
+A dialog window will open. Select a folder, enter a filename, choose an output
 image type, and click *Save*.
 
@@ -94 +94 @@
 *  PNG (portable network graphics)
 *  PS (postscript)
-*  RAW/RGBA (bitmap)
+*  RAW/RGBA (bitmap, stored as 935x635 pixels of depth 8)
 *  SVG/SVGA (scalable vector graphics)
 *  TIF/TIFF (tagged iamge file)
@@ -101 +101 @@
 ^^^^^^^^^^^^^^^
 
-To send the current plot to a printer, click on the *Print* (printer) icon in 
+To send the current plot to a printer, click on the *Print* (printer) icon in
 the toolbar at the bottom of the plot.
 
@@ -109 +109 @@
 ^^^^^^^^^^^^^^^^^^^
 
-To reset the axis range of a graph to its initial values select *Reset Graph 
+To reset the axis range of a graph to its initial values select *Reset Graph
 Range* on the *Graph Menu* (see Invoking_the_graph_menu_). Alternatively, use
 the *Reset* (home) icon in the toolbar at the bottom of the plot.
@@ -133 +133 @@
 
 From the *Graph Menu* (see Invoking_the_graph_menu_) select *Change Scale*. A
-dialog window will appear in which it is possible to choose different 
+dialog window will appear in which it is possible to choose different
 transformations of the x (usually Q) or y (usually I(Q)) axes, including:
 
@@ -139 +139 @@
 *  y, 1/y, ln(y), y^2, y.(x^4), 1/sqrt(y),
 *  log10(y), ln(y.x), ln(y.x^2), ln(y.x^4), log10(y.x^4)
- 
+
 A *View* option includes short-cuts to common SAS transformations, such as:
 
@@ -148 +148 @@
 *  Kratky
 
-For properly corrected and scaled data, these SAS transformations can be used 
-to estimate, for example, Rg, rod diameter, or SANS incoherent background 
+For properly corrected and scaled data, these SAS transformations can be used
+to estimate, for example, Rg, rod diameter, or SANS incoherent background
 levels, via a linear fit (see Making_a_linear_fit_).
 
@@ -158 +158 @@
 
 From the *Graph Menu* (see Invoking_the_graph_menu_) select *Toggle Linear/Log
-Scale* to switch between a linear to log intensity scale. The type of scale 
+Scale* to switch between a linear to log intensity scale. The type of scale
 selected is written alongside the colour scale.
 
@@ -167 +167 @@
 
 From the *Graph Menu* (see Invoking_the_graph_menu_) select *2D Color Map* to
-choose a different color scale for the image and/or change the maximum or 
+choose a different color scale for the image and/or change the maximum or
 minimum limits of the scale.
 
@@ -173 +173 @@
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-Clicking anywhere in the plot window will cause the current coordinates to be 
+Clicking anywhere in the plot window will cause the current coordinates to be
 displayed in the status bar at the very bottom-left of the SasView window.
- 
+
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
@@ -193 +193 @@
 
 In the *Dataset Menu* (see Invoking_the_dataset_menu_), highlight a data set
-and select *DataInfo* to bring up a data information dialog panel for that 
+and select *DataInfo* to bring up a data information dialog panel for that
 data set.
 
@@ -200 +200 @@
 
 In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Save Points as
-a File* (if 1D data) or *Save as a file(DAT)* (if 2D data). A save dialog will 
+a File* (if 1D data) or *Save as a file(DAT)* (if 2D data). A save dialog will
 appear.
 
-1D data can be saved in either ASCII text (.TXT) or CanSAS/SASXML (.XML) 
+1D data can be saved in either ASCII text (.TXT) or CanSAS/SASXML (.XML)
 formats (see :ref:`Formats`).
 
@@ -216 +216 @@
 
 In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Linear Fit*. A
-fitting dialog will appear. Set some initial parameters and data limits and 
-click *Fit*. The fitted parameter values are displayed and the resulting line 
-calculated from them is added to the plot. 
+fitting dialog will appear. Set some initial parameters and data limits and
+click *Fit*. The fitted parameter values are displayed and the resulting line
+calculated from them is added to the plot.
 
 This option is most useful for performing simple Guinier, XS Guinier, and
-Porod type analyses, for example, to estimate Rg, a rod diameter, or incoherent 
+Porod type analyses, for example, to estimate Rg, a rod diameter, or incoherent
 background level, respectively.
 
@@ -240 +240 @@
 
 In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Show Error Bar*
-or *Hide Error Bar* to switch between showing/hiding the errors associated 
-with the chosen dataset. 
+or *Hide Error Bar* to switch between showing/hiding the errors associated
+with the chosen dataset.
 
 Modify plot properties
@@ -247 +247 @@
 
 In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Modify Plot
-Property* to change the size, color, or shape of the displayed marker for the 
+Property* to change the size, color, or shape of the displayed marker for the
 chosen dataset, or to change the dataset label that appears on the plot.
 
@@ -260 +260 @@
 This feature is only available with 2D data.
 
-2D data averaging allows you to perform different types of averages on your 
-data. The region to be averaged is displayed in the plot window and its limits 
+2D data averaging allows you to perform different types of averages on your
+data. The region to be averaged is displayed in the plot window and its limits
 can be modified by dragging the boundaries around.
 
@@ -277 +277 @@
 *  Box averaging on Qy
 
-A 'slicer' will appear (except for *Perform Circular Average*) in the plot that 
-you can drag by clicking on a slicer's handle. When the handle is highlighted 
+A 'slicer' will appear (except for *Perform Circular Average*) in the plot that
+you can drag by clicking on a slicer's handle. When the handle is highlighted
 in red, it means that the slicer can move/change size.
 
-*NOTE! The slicer size will reset if you try to select a region greater than 
+*NOTE! The slicer size will reset if you try to select a region greater than
 the size of the data.*
 
-Alternatively, once a 'slicer' is active you can also select the region to 
-average by bringing back the *Dataset Menu* and selecting *Edit Slicer 
-Parameters*. A dialog window will appear in which you can enter values to 
+Alternatively, once a 'slicer' is active you can also select the region to
+average by bringing back the *Dataset Menu* and selecting *Edit Slicer
+Parameters*. A dialog window will appear in which you can enter values to
 define a region or select the number of points to plot (*nbins*).
 
-A separate plot window will also have appeared, displaying the requested 
+A separate plot window will also have appeared, displaying the requested
 average.
 
-*NOTE! The displayed average only updates when input focus is moved back to 
+*NOTE! The displayed average only updates when input focus is moved back to
 that window; ie, when the mouse pointer is moved onto that plot.*
 
-Selecting *Box Sum* automatically brings up the 'Slicer Parameters' dialog in 
+Selecting *Box Sum* automatically brings up the 'Slicer Parameters' dialog in
 order to display the average numerically, rather than graphically.
 
@@ -303 +303 @@
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-This operation will perform an average in constant Q-rings around the (x,y) 
+This operation will perform an average in constant Q-rings around the (x,y)
 pixel location of the beam center.
 
@@ -309 +309 @@
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-This operation is the same as 'Unmasked Circular Average' except that any 
+This operation is the same as 'Unmasked Circular Average' except that any
 masked region is excluded.
 
@@ -317 +317 @@
 This operation averages in constant Q-arcs.
 
-The width of the sector is specified in degrees (+/- |delta|\|phi|\) each side 
+The width of the sector is specified in degrees (+/- |delta|\|phi|\) each side
 of the central angle (|phi|\).
 
@@ -323 +323 @@
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-This operation performs an average between two Q-values centered on (0,0), 
+This operation performs an average between two Q-values centered on (0,0),
 and averaged over a specified number of pixels.
 
-The data is returned as a function of angle (|phi|\) in degrees with zero 
+The data is returned as a function of angle (|phi|\) in degrees with zero
 degrees at the 3 O'clock position.
 
@@ -334 +334 @@
 This operation performs a sum of counts in a 2D region of interest.
 
-When editing the slicer parameters, the user can enter the length and the width 
+When editing the slicer parameters, the user can enter the length and the width
 the rectangular slicer and the coordinates of the center of the rectangle.
 
@@ -342 +342 @@
 This operation computes an average I(Qx) for the region of interest.
 
-When editing the slicer parameters, the user can control the length and the 
-width the rectangular slicer. The averaged output is calculated from constant 
-bins with rectangular shape. The resultant Q values are nominal values, that 
+When editing the slicer parameters, the user can control the length and the
+width the rectangular slicer. The averaged output is calculated from constant
+bins with rectangular shape. The resultant Q values are nominal values, that
 is, the central value of each bin on the x-axis.
 
@@ -352 +352 @@
 This operation computes an average I(Qy) for the region of interest.
 
-When editing the slicer parameters, the user can control the length and the 
-width the rectangular slicer. The averaged output is calculated from constant 
-bins with rectangular shape. The resultant Q values are nominal values, that 
+When editing the slicer parameters, the user can control the length and the
+width the rectangular slicer. The averaged output is calculated from constant
+bins with rectangular shape. The resultant Q values are nominal values, that
 is, the central value of each bin on the x-axis.