Changeset e68c9bf in sasview for src/sas


Ignore:
Timestamp:
Aug 17, 2016 7:19:57 AM (8 years ago)
Author:
lewis
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:
1cecc91
Parents:
e4c897b
git-author:
Lewis O'Driscoll <lewis.o'driscoll@…> (08/17/16 07:19:02)
git-committer:
Lewis O'Driscoll <lewis.o'driscoll@…> (08/17/16 07:19:57)
Message:

Remove option to save plot as PGF format (closes #446)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/sas/sasgui/guiframe/media/graph_help.rst

    r318427a9 re68c9bf  
    2020^^^^^^^^^^^^^^^^^^^^^^^ 
    2121 
    22 To invoke the *Graph Menu* simply right-click on a data/theory plot, or click  
    23 the *Graph Menu* (bullet list) icon in the toolbar at the bottom of the plot.  
     22To invoke the *Graph Menu* simply right-click on a data/theory plot, or click 
     23the *Graph Menu* (bullet list) icon in the toolbar at the bottom of the plot. 
    2424Then select a menu item. 
    2525 
     
    2727^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
    2828 
    29 To expand a plot window, click the *Maximise* (square) icon in the top-right  
     29To expand a plot window, click the *Maximise* (square) icon in the top-right 
    3030corner. 
    3131 
    32 To shrink a plot window, click the *Restore down* (square-on-square) icon in  
     32To shrink a plot window, click the *Restore down* (square-on-square) icon in 
    3333the top-right corner. 
    3434 
    35 To hide a plot, click the *Minimise* (-) icon in the top-right corner of the  
     35To hide a plot, click the *Minimise* (-) icon in the top-right corner of the 
    3636plot window. 
    3737 
    38 To show a hidden plot, select the *Restore up* (square-on-square) icon on the  
     38To show a hidden plot, select the *Restore up* (square-on-square) icon on the 
    3939minimised window. 
    4040 
    41 To delete a plot, click the *Close* (x) icon in the top-right corner of the  
     41To delete a plot, click the *Close* (x) icon in the top-right corner of the 
    4242plot window. 
    4343 
    44 *NOTE! If a residuals graph (when fitting data) is hidden, it will not show up  
     44*NOTE! If a residuals graph (when fitting data) is hidden, it will not show up 
    4545after computation.* 
    4646 
     
    4848^^^^^^^^^^^^^^^ 
    4949 
    50 Select the *Pan* (crossed arrows) icon in the toolbar at the bottom of the plot  
    51 to activate this option. Move the mouse pointer to the plot. It will change to  
    52 a hand. Then left-click and drag the plot around. The axis values will adjust  
     50Select the *Pan* (crossed arrows) icon in the toolbar at the bottom of the plot 
     51to activate this option. Move the mouse pointer to the plot. It will change to 
     52a hand. Then left-click and drag the plot around. The axis values will adjust 
    5353accordingly. 
    54   
     54 
    5555To disable dragging mode, unselect the *crossed arrows* icon on the toolbar. 
    5656 
     
    5858^^^^^^^^^^^^^^^^^^^^^^^^ 
    5959 
    60 Select the *Zoom* (magnifying glass) button in the toolbar at the bottom of  
    61 the plot to activate this option. Move the mouse pointer to the plot. It will  
    62 change to a cross-hair. Then left-click and drag the pointer around to generate  
     60Select the *Zoom* (magnifying glass) button in the toolbar at the bottom of 
     61the plot to activate this option. Move the mouse pointer to the plot. It will 
     62change to a cross-hair. Then left-click and drag the pointer around to generate 
    6363a region of interest. Release the mouse button to generate the new view. 
    6464 
    6565To disable zoom mode, unselect the *Zoom* button on the toolbar. 
    6666 
    67 After zooming in on a a region, the *left arrow* or *right arrow* buttons on  
     67After zooming in on a a region, the *left arrow* or *right arrow* buttons on 
    6868the toolbar will switch between recent views. 
    6969 
    70 *NOTE! If a wheel mouse is available scrolling the wheel will zoom in/out  
    71 on the current plot (changing both axes). Alternatively, point at the numbers  
     70*NOTE! If a wheel mouse is available scrolling the wheel will zoom in/out 
     71on the current plot (changing both axes). Alternatively, point at the numbers 
    7272on one axis and scroll the wheel to zoom in/out on just that axis.* 
    7373 
    74 To return to the original view of the data, click the the *Reset* (home) icon  
     74To return to the original view of the data, click the the *Reset* (home) icon 
    7575in the toolbar at the bottom of the plot (see Resetting_the_graph_ for further details). 
    7676 
     
    7878^^^^^^^^^^^^^^^^^^^ 
    7979 
    80 To save the current plot as an image file, right click on the plot to bring up  
     80To save the current plot as an image file, right click on the plot to bring up 
    8181the *Graph Menu* (see Invoking_the_graph_menu_) and select *Save Image*. 
    82 Alternatively, click on the *Save* (floppy disk) icon in the toolbar at the  
     82Alternatively, click on the *Save* (floppy disk) icon in the toolbar at the 
    8383bottom of the plot. 
    84   
    85 A dialog window will open. Select a folder, enter a filename, choose an output  
     84 
     85A dialog window will open. Select a folder, enter a filename, choose an output 
    8686image type, and click *Save*. 
    8787 
     
    9898*  TIF/TIFF (tagged iamge file) 
    9999 
    100 The PGF image type option requires a LaTeX compiler: xelatex (default),  
    101 lualatex, or pdflatex. These are not shipped with SasView. 
    102  
    103100Printing a plot 
    104101^^^^^^^^^^^^^^^ 
    105102 
    106 To send the current plot to a printer, click on the *Print* (printer) icon in  
     103To send the current plot to a printer, click on the *Print* (printer) icon in 
    107104the toolbar at the bottom of the plot. 
    108105 
     
    112109^^^^^^^^^^^^^^^^^^^ 
    113110 
    114 To reset the axis range of a graph to its initial values select *Reset Graph  
     111To reset the axis range of a graph to its initial values select *Reset Graph 
    115112Range* on the *Graph Menu* (see Invoking_the_graph_menu_). Alternatively, use 
    116113the *Reset* (home) icon in the toolbar at the bottom of the plot. 
     
    136133 
    137134From the *Graph Menu* (see Invoking_the_graph_menu_) select *Change Scale*. A 
    138 dialog window will appear in which it is possible to choose different  
     135dialog window will appear in which it is possible to choose different 
    139136transformations of the x (usually Q) or y (usually I(Q)) axes, including: 
    140137 
     
    142139*  y, 1/y, ln(y), y^2, y.(x^4), 1/sqrt(y), 
    143140*  log10(y), ln(y.x), ln(y.x^2), ln(y.x^4), log10(y.x^4) 
    144   
     141 
    145142A *View* option includes short-cuts to common SAS transformations, such as: 
    146143 
     
    151148*  Kratky 
    152149 
    153 For properly corrected and scaled data, these SAS transformations can be used  
    154 to estimate, for example, Rg, rod diameter, or SANS incoherent background  
     150For properly corrected and scaled data, these SAS transformations can be used 
     151to estimate, for example, Rg, rod diameter, or SANS incoherent background 
    155152levels, via a linear fit (see Making_a_linear_fit_). 
    156153 
     
    161158 
    162159From the *Graph Menu* (see Invoking_the_graph_menu_) select *Toggle Linear/Log 
    163 Scale* to switch between a linear to log intensity scale. The type of scale  
     160Scale* to switch between a linear to log intensity scale. The type of scale 
    164161selected is written alongside the colour scale. 
    165162 
     
    170167 
    171168From the *Graph Menu* (see Invoking_the_graph_menu_) select *2D Color Map* to 
    172 choose a different color scale for the image and/or change the maximum or  
     169choose a different color scale for the image and/or change the maximum or 
    173170minimum limits of the scale. 
    174171 
     
    176173^^^^^^^^^^^^^^^^^^^^^^^^ 
    177174 
    178 Clicking anywhere in the plot window will cause the current coordinates to be  
     175Clicking anywhere in the plot window will cause the current coordinates to be 
    179176displayed in the status bar at the very bottom-left of the SasView window. 
    180   
     177 
    181178.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    182179 
     
    196193 
    197194In the *Dataset Menu* (see Invoking_the_dataset_menu_), highlight a data set 
    198 and select *DataInfo* to bring up a data information dialog panel for that  
     195and select *DataInfo* to bring up a data information dialog panel for that 
    199196data set. 
    200197 
     
    203200 
    204201In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Save Points as 
    205 a File* (if 1D data) or *Save as a file(DAT)* (if 2D data). A save dialog will  
     202a File* (if 1D data) or *Save as a file(DAT)* (if 2D data). A save dialog will 
    206203appear. 
    207204 
    208 1D data can be saved in either ASCII text (.TXT) or CanSAS/SASXML (.XML)  
     2051D data can be saved in either ASCII text (.TXT) or CanSAS/SASXML (.XML) 
    209206formats (see :ref:`Formats`). 
    210207 
     
    219216 
    220217In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Linear Fit*. A 
    221 fitting dialog will appear. Set some initial parameters and data limits and  
    222 click *Fit*. The fitted parameter values are displayed and the resulting line  
    223 calculated from them is added to the plot.  
     218fitting dialog will appear. Set some initial parameters and data limits and 
     219click *Fit*. The fitted parameter values are displayed and the resulting line 
     220calculated from them is added to the plot. 
    224221 
    225222This option is most useful for performing simple Guinier, XS Guinier, and 
    226 Porod type analyses, for example, to estimate Rg, a rod diameter, or incoherent  
     223Porod type analyses, for example, to estimate Rg, a rod diameter, or incoherent 
    227224background level, respectively. 
    228225 
     
    243240 
    244241In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Show Error Bar* 
    245 or *Hide Error Bar* to switch between showing/hiding the errors associated  
    246 with the chosen dataset.  
     242or *Hide Error Bar* to switch between showing/hiding the errors associated 
     243with the chosen dataset. 
    247244 
    248245Modify plot properties 
     
    250247 
    251248In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Modify Plot 
    252 Property* to change the size, color, or shape of the displayed marker for the  
     249Property* to change the size, color, or shape of the displayed marker for the 
    253250chosen dataset, or to change the dataset label that appears on the plot. 
    254251 
     
    263260This feature is only available with 2D data. 
    264261 
    265 2D data averaging allows you to perform different types of averages on your  
    266 data. The region to be averaged is displayed in the plot window and its limits  
     2622D data averaging allows you to perform different types of averages on your 
     263data. The region to be averaged is displayed in the plot window and its limits 
    267264can be modified by dragging the boundaries around. 
    268265 
     
    280277*  Box averaging on Qy 
    281278 
    282 A 'slicer' will appear (except for *Perform Circular Average*) in the plot that  
    283 you can drag by clicking on a slicer's handle. When the handle is highlighted  
     279A 'slicer' will appear (except for *Perform Circular Average*) in the plot that 
     280you can drag by clicking on a slicer's handle. When the handle is highlighted 
    284281in red, it means that the slicer can move/change size. 
    285282 
    286 *NOTE! The slicer size will reset if you try to select a region greater than  
     283*NOTE! The slicer size will reset if you try to select a region greater than 
    287284the size of the data.* 
    288285 
    289 Alternatively, once a 'slicer' is active you can also select the region to  
    290 average by bringing back the *Dataset Menu* and selecting *Edit Slicer  
    291 Parameters*. A dialog window will appear in which you can enter values to  
     286Alternatively, once a 'slicer' is active you can also select the region to 
     287average by bringing back the *Dataset Menu* and selecting *Edit Slicer 
     288Parameters*. A dialog window will appear in which you can enter values to 
    292289define a region or select the number of points to plot (*nbins*). 
    293290 
    294 A separate plot window will also have appeared, displaying the requested  
     291A separate plot window will also have appeared, displaying the requested 
    295292average. 
    296293 
    297 *NOTE! The displayed average only updates when input focus is moved back to  
     294*NOTE! The displayed average only updates when input focus is moved back to 
    298295that window; ie, when the mouse pointer is moved onto that plot.* 
    299296 
    300 Selecting *Box Sum* automatically brings up the 'Slicer Parameters' dialog in  
     297Selecting *Box Sum* automatically brings up the 'Slicer Parameters' dialog in 
    301298order to display the average numerically, rather than graphically. 
    302299 
     
    306303^^^^^^^^^^^^^^^^^^^^^^^^^ 
    307304 
    308 This operation will perform an average in constant Q-rings around the (x,y)  
     305This operation will perform an average in constant Q-rings around the (x,y) 
    309306pixel location of the beam center. 
    310307 
     
    312309^^^^^^^^^^^^^^^^^^^^^^^ 
    313310 
    314 This operation is the same as 'Unmasked Circular Average' except that any  
     311This operation is the same as 'Unmasked Circular Average' except that any 
    315312masked region is excluded. 
    316313 
     
    320317This operation averages in constant Q-arcs. 
    321318 
    322 The width of the sector is specified in degrees (+/- |delta|\|phi|\) each side  
     319The width of the sector is specified in degrees (+/- |delta|\|phi|\) each side 
    323320of the central angle (|phi|\). 
    324321 
     
    326323^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
    327324 
    328 This operation performs an average between two Q-values centered on (0,0),  
     325This operation performs an average between two Q-values centered on (0,0), 
    329326and averaged over a specified number of pixels. 
    330327 
    331 The data is returned as a function of angle (|phi|\) in degrees with zero  
     328The data is returned as a function of angle (|phi|\) in degrees with zero 
    332329degrees at the 3 O'clock position. 
    333330 
     
    337334This operation performs a sum of counts in a 2D region of interest. 
    338335 
    339 When editing the slicer parameters, the user can enter the length and the width  
     336When editing the slicer parameters, the user can enter the length and the width 
    340337the rectangular slicer and the coordinates of the center of the rectangle. 
    341338 
     
    345342This operation computes an average I(Qx) for the region of interest. 
    346343 
    347 When editing the slicer parameters, the user can control the length and the  
    348 width the rectangular slicer. The averaged output is calculated from constant  
    349 bins with rectangular shape. The resultant Q values are nominal values, that  
     344When editing the slicer parameters, the user can control the length and the 
     345width the rectangular slicer. The averaged output is calculated from constant 
     346bins with rectangular shape. The resultant Q values are nominal values, that 
    350347is, the central value of each bin on the x-axis. 
    351348 
     
    355352This operation computes an average I(Qy) for the region of interest. 
    356353 
    357 When editing the slicer parameters, the user can control the length and the  
    358 width the rectangular slicer. The averaged output is calculated from constant  
    359 bins with rectangular shape. The resultant Q values are nominal values, that  
     354When editing the slicer parameters, the user can control the length and the 
     355width the rectangular slicer. The averaged output is calculated from constant 
     356bins with rectangular shape. The resultant Q values are nominal values, that 
    360357is, the central value of each bin on the x-axis. 
    361358 
Note: See TracChangeset for help on using the changeset viewer.