source: sasview/src/sas/sasgui/guiframe/media/graph_help.copy @ 65dfa99

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 65dfa99 was 65dfa99, checked in by smk78, 6 years ago

Restore accidentally deleted files - 2

  • Property mode set to 100644
File size: 11.7 KB
Line 
1.. graph_help.rst
2
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
6.. |delta| unicode:: U+03B4
7.. |phi| unicode:: U+03C6
8
9
10Plotting Data/Models
11====================
12
13SasView generates three different types of graph window: one that displays *1D data*
14(ie, I(Q) vs Q), one that displays *1D residuals* (ie, the difference between the
15experimental data and the theory at the same Q values), and *2D color maps*.
16
17Graph window options
18--------------------
19
20.. _Invoking_the_graph_menu:
21
22Invoking the graph menu
23^^^^^^^^^^^^^^^^^^^^^^^
24
25To invoke the *Graph Menu* simply right-click on a data/theory plot, or click
26the *Graph Menu* (bullet list) icon in the toolbar at the bottom of the plot.
27Then select a menu item.
28
29How to Hide-Show-Delete a graph
30^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
31
32To expand a plot window, click the *Maximise* (square) icon in the top-right
33corner.
34
35To shrink a plot window, click the *Restore down* (square-on-square) icon in
36the top-right corner.
37
38To hide a plot, click the *Minimise* (-) icon in the top-right corner of the
39plot window.
40
41To show a hidden plot, select the *Restore up* (square-on-square) icon on the
42minimised window.
43
44To delete a plot, click the *Close* (x) icon in the top-right corner of the
45plot window.
46
47*NOTE! If a residuals graph (when fitting data) is hidden, it will not show up
48after computation.*
49
50Dragging a plot
51^^^^^^^^^^^^^^^
52
53Select the *Pan* (crossed arrows) icon in the toolbar at the bottom of the plot
54to activate this option. Move the mouse pointer to the plot. It will change to
55a hand. Then left-click and drag the plot around. The axis values will adjust
56accordingly.
57 
58To disable dragging mode, unselect the *crossed arrows* icon on the toolbar.
59
60Zooming In-Out on a plot
61^^^^^^^^^^^^^^^^^^^^^^^^
62
63Select the *Zoom* (magnifying glass) button in the toolbar at the bottom of
64the plot to activate this option. Move the mouse pointer to the plot. It will
65change to a cross-hair. Then left-click and drag the pointer around to generate
66a region of interest. Release the mouse button to generate the new view.
67
68To disable zoom mode, unselect the *Zoom* button on the toolbar.
69
70After zooming in on a a region, the *left arrow* or *right arrow* buttons on
71the toolbar will switch between recent views.
72
73*NOTE! If a wheel mouse is available scrolling the wheel will zoom in/out
74on the current plot (changing both axes). Alternatively, point at the numbers
75on one axis and scroll the wheel to zoom in/out on just that axis.*
76
77To return to the original view of the data, click the the *Reset* (home) icon
78in the toolbar at the bottom of the plot (see Resetting_the_graph_ for further details).
79
80Saving a plot image
81^^^^^^^^^^^^^^^^^^^
82
83To save the current plot as an image file, right click on the plot to bring up
84the *Graph Menu* (see Invoking_the_graph_menu_) and select *Save Image*.
85Alternatively, click on the *Save* (floppy disk) icon in the toolbar at the
86bottom of the plot.
87 
88A dialog window will open. Select a folder, enter a filename, choose an output
89image type, and click *Save*.
90
91The currently supported image types are:
92
93*  EPS (encapsulated postscript)
94*  EMF (enhanced metafile)
95*  JPG/JPEG (joint photographics experts group)
96*  PDF (portable documant format)
97*  PNG (portable network graphics)
98*  PS (postscript)
99*  RAW/RGBA (bitmap)
100*  SVG/SVGA (scalable vector graphics)
101*  TIF/TIFF (tagged iamge file)
102
103Printing a plot
104^^^^^^^^^^^^^^^
105
106To send the current plot to a printer, click on the *Print* (printer) icon in
107the toolbar at the bottom of the plot.
108
109.. _Resetting_the_graph:
110
111Resetting the graph
112^^^^^^^^^^^^^^^^^^^
113
114To reset the axis range of a graph to its initial values select *Reset Graph
115Range* on the *Graph Menu* (see Invoking_the_graph_menu_). Alternatively, use
116the *Reset* (home) icon in the toolbar at the bottom of the plot.
117
118Modifying the graph
119^^^^^^^^^^^^^^^^^^^
120
121From the *Graph Menu* (see Invoking_the_graph_menu_) it is also possible to
122make some custom modifications to plots, including:
123
124*  changing the plot window title
125*  changing the axis legend locations
126*  changing the axis legend label text
127*  changing the axis legend label units
128*  changing the axis legend label font & font colour
129*  adding/removing a text string
130*  adding a grid overlay
131
132Changing scales
133^^^^^^^^^^^^^^^
134
135This menu option is only available with 1D data.
136
137From the *Graph Menu* (see Invoking_the_graph_menu_) select *Change Scale*. A
138dialog window will appear in which it is possible to choose different
139transformations of the x (usually Q) or y (usually I(Q)) axes, including:
140
141*  x, x^2, x^4, ln(x), log10(x), log10(x^4)
142*  y, 1/y, ln(y), y^2, y.(x^4), 1/sqrt(y),
143*  log10(y), ln(y.x), ln(y.x^2), ln(y.x^4), log10(y.x^4)
144 
145A *View* option includes short-cuts to common SAS transformations, such as:
146
147*  linear
148*  Guinier
149*  X-sectional Guinier
150*  Porod
151*  Kratky
152
153For properly corrected and scaled data, these SAS transformations can be used
154to estimate, for example, Rg, rod diameter, or SANS incoherent background
155levels, via a linear fit (see Making_a_linear_fit_).
156
157Toggling scales
158^^^^^^^^^^^^^^^
159
160This menu option is only available with 2D data.
161
162From the *Graph Menu* (see Invoking_the_graph_menu_) select *Toggle Linear/Log
163Scale* to switch between a linear to log intensity scale. The type of scale
164selected is written alongside the colour scale.
165
1662D color maps
167^^^^^^^^^^^^^
168
169This menu option is only available with 2D data.
170
171From the *Graph Menu* (see Invoking_the_graph_menu_) select *2D Color Map* to
172choose a different color scale for the image and/or change the maximum or
173minimum limits of the scale.
174
175Getting data coordinates
176^^^^^^^^^^^^^^^^^^^^^^^^
177
178Clicking anywhere in the plot window will cause the current coordinates to be
179displayed in the status bar at the very bottom-left of the SasView window.
180 
181.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
182
183Dataset menu options
184--------------------
185
186.. _Invoking_the_dataset_menu:
187
188Invoking the dataset menu
189^^^^^^^^^^^^^^^^^^^^^^^^^
190
191From the *Graph Menu* (see Invoking_the_graph_menu_) highlight a plotted
192dataset.
193
194Getting data info
195^^^^^^^^^^^^^^^^^
196
197In the *Dataset Menu* (see Invoking_the_dataset_menu_), highlight a data set
198and select *DataInfo* to bring up a data information dialog panel for that
199data set.
200
201Saving data
202^^^^^^^^^^^
203
204In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Save Points as
205a File* (if 1D data) or *Save as a file(DAT)* (if 2D data). A save dialog will
206appear.
207
2081D data can be saved in either ASCII text (.TXT) or CanSAS/SASXML (.XML)
209formats (see :ref:`Formats`).
210
2112D data can only be saved in the NIST 2D format (.DAT) (see :ref:`Formats`).
212
213.. _Making_a_linear_fit:
214
215Making a linear fit
216^^^^^^^^^^^^^^^^^^^
217
218Linear fit performs a simple ( y(x)=ax+b ) linear fit within the plot window.
219
220In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Linear Fit*. A
221fitting dialog will appear. Set some initial parameters and data limits and
222click *Fit*. The fitted parameter values are displayed and the resulting line
223calculated from them is added to the plot.
224
225This option is most useful for performing simple Guinier, XS Guinier, and
226Porod type analyses, for example, to estimate Rg, a rod diameter, or incoherent
227background level, respectively.
228
229The following figure shows an example of a Guinier analysis using this option
230
231.. image:: guinier_fit.png
232
233Removing data from the plot
234^^^^^^^^^^^^^^^^^^^^^^^^^^^
235
236In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Remove*. The
237selected data will be removed from the plot.
238
239*NOTE! This action cannot be undone.*
240
241Show-Hide error bars
242^^^^^^^^^^^^^^^^^^^^
243
244In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Show Error Bar*
245or *Hide Error Bar* to switch between showing/hiding the errors associated
246with the chosen dataset.
247
248Modify plot properties
249^^^^^^^^^^^^^^^^^^^^^^
250
251In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Modify Plot
252Property* to change the size, color, or shape of the displayed marker for the
253chosen dataset, or to change the dataset label that appears on the plot.
254
255.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
256
2572D data averaging
258-----------------
259
260Purpose
261^^^^^^^
262
263This feature is only available with 2D data.
264
2652D data averaging allows you to perform different types of averages on your
266data. The region to be averaged is displayed in the plot window and its limits
267can be modified by dragging the boundaries around.
268
269How to average
270^^^^^^^^^^^^^^
271
272In the *Dataset Menu* (see Invoking_the_dataset_menu_), select one of the
273following averages
274
275*  Perform Circular Average
276*  Sector [Q view]
277*  Annulus [Phi view]
278*  Box sum
279*  Box averaging in Qx
280*  Box averaging on Qy
281
282A 'slicer' will appear (except for *Perform Circular Average*) in the plot that
283you can drag by clicking on a slicer's handle. When the handle is highlighted
284in red, it means that the slicer can move/change size.
285
286*NOTE! The slicer size will reset if you try to select a region greater than
287the size of the data.*
288
289Alternatively, once a 'slicer' is active you can also select the region to
290average by bringing back the *Dataset Menu* and selecting *Edit Slicer
291Parameters*. A dialog window will appear in which you can enter values to
292define a region or select the number of points to plot (*nbins*).
293
294A separate plot window will also have appeared, displaying the requested
295average.
296
297*NOTE! The displayed average only updates when input focus is moved back to
298that window; ie, when the mouse pointer is moved onto that plot.*
299
300Selecting *Box Sum* automatically brings up the 'Slicer Parameters' dialog in
301order to display the average numerically, rather than graphically.
302
303To remove a 'slicer', bring back the *Dataset menu* and select *Clear Slicer*.
304
305Unmasked circular average
306^^^^^^^^^^^^^^^^^^^^^^^^^
307
308This operation will perform an average in constant Q-rings around the (x,y)
309pixel location of the beam center.
310
311Masked circular average
312^^^^^^^^^^^^^^^^^^^^^^^
313
314This operation is the same as 'Unmasked Circular Average' except that any
315masked region is excluded.
316
317Sector average [Q View]
318^^^^^^^^^^^^^^^^^^^^^^^
319
320This operation averages in constant Q-arcs.
321
322The width of the sector is specified in degrees (+/- |delta|\|phi|\) each side
323of the central angle (|phi|\).
324
325Annular average [|phi| View]
326^^^^^^^^^^^^^^^^^^^^^^^^^^^^
327
328This operation performs an average between two Q-values centered on (0,0),
329and averaged over a specified number of pixels.
330
331The data is returned as a function of angle (|phi|\) in degrees with zero
332degrees at the 3 O'clock position.
333
334Box sum
335^^^^^^^
336
337This operation performs a sum of counts in a 2D region of interest.
338
339When editing the slicer parameters, the user can enter the length and the width
340the rectangular slicer and the coordinates of the center of the rectangle.
341
342Box Averaging in Qx
343^^^^^^^^^^^^^^^^^^^
344
345This operation computes an average I(Qx) for the region of interest.
346
347When editing the slicer parameters, the user can control the length and the
348width the rectangular slicer. The averaged output is calculated from constant
349bins with rectangular shape. The resultant Q values are nominal values, that
350is, the central value of each bin on the x-axis.
351
352Box Averaging in Qy
353^^^^^^^^^^^^^^^^^^^
354
355This operation computes an average I(Qy) for the region of interest.
356
357When editing the slicer parameters, the user can control the length and the
358width the rectangular slicer. The averaged output is calculated from constant
359bins with rectangular shape. The resultant Q values are nominal values, that
360is, the central value of each bin on the x-axis.
361
362.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
363
364.. note::  This help document was last changed by Steve King, 01May2015
Note: See TracBrowser for help on using the repository browser.