Changeset 3fd3d5a4 in sasview


Ignore:
Timestamp:
Feb 18, 2015 9:14:57 AM (9 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:
2bf5e3b, fa09d62
Parents:
5c44f33
Message:

Proof read.

Location:
src/sas/guiframe/media
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • src/sas/guiframe/media/data_formats_help.rst

    r6f10243 r3fd3d5a4  
    2929SasView recognises the following file extensions: 
    3030 
    31     .TXT 
    32      
    33     .ASC 
    34      
    35     .DAT 
    36      
    37     .XML (in canSAS format v1.0 and 1.1) 
     31*  .TXT 
     32*  .ASC 
     33*  .DAT 
     34*  .XML (in canSAS format v1.0 and 1.1) 
    3835 
    3936If using CSV output from, for example, a spreadsheet, ensure that it is not  
    4037using commas as delimiters for thousands. 
    4138 
     39For a description of the CanSAS/SASXML format see: 
     40http://www.cansas.org/formats/canSAS1d/1.1/doc/ 
     41 
    4242For a description of the NIST 1D format see: 
    43  
    4443http://danse.chem.utk.edu/trac/wiki/NCNROutput1D_IQ 
    4544 
    4645For a description of the ISIS 1D format see: 
    47  
    4846http://www.isis.stfc.ac.uk/instruments/loq/software/colette-ascii-file-format-descriptions9808.pdf 
    4947 
    50 NB: SasView does not at present load data where the Q and I(Q) data are in  
    51 separate files. 
     48*NOTE! SasView does not at present load data where the Q and I(Q) data are in  
     49separate files.* 
    5250 
    5351.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     
    6563 
    6664For a description of the NIST 2D format see: 
    67  
    6865http://danse.chem.utk.edu/trac/wiki/NCNROutput1D_2DQxQy  
    6966 
    7067.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     68 
     69.. note::  This help document was last changed by Steve King, 18Feb2015 
  • src/sas/guiframe/media/graph_help.rst

    r98b30b4 r3fd3d5a4  
    44.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 
    55 
     6.. |delta| unicode:: U+03B4 
     7.. |phi| unicode:: U+03C6 
     8 
     9 
    610Plotting Data/Models 
    711==================== 
    812 
    9 Graph_Menu_ 
     13Graph_Window_Options_ 
     14 
     15Dataset_Menu_Options_ 
    1016 
    11172D_Data_Averaging_ 
    1218 
    13 Key_Sequences_ 
    14  
    1519.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    1620 
    17 .. _Graph_Menu: 
    18  
    19 Graph Menu 
     21.. _Graph_Window_Options: 
     22 
     23Graph Window Options 
     24-------------------- 
     25 
     26Invoking_the_Graph_Menu_ 
     27 
     28Hide_Show_Delete_Graph_ 
     29 
     30Drag_Plot_ 
     31 
     32Zoom_In_Out_ 
     33 
     34Save_Plot_Image_ 
     35 
     36Print_Plot_ 
     37 
     38Reset_Graph_ 
     39 
     40Graph_Modifications_ 
     41 
     42Change_Scale_ 
     43 
     44Toggle_Scale_ 
     45 
     462D_Color_Map_ 
     47 
     48Data_Coordinates_ 
     49 
     50.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     51 
     52.. _Dataset_Menu_Options: 
     53 
     54Dataset Menu Options 
     55-------------------- 
     56 
     57Invoking_the_Dataset_Menu_ 
     58 
     59Data_Info_ 
     60 
     61Save_Data_ 
     62 
     63Linear_Fit_ 
     64 
     65Remove_Data_from_Plot_ 
     66 
     67Show_Hide_Error_Bars_ 
     68 
     69Modify_Plot_Property_ 
     70 
     712D Averaging 
     72------------ 
     73 
     742D_Data_Averaging_ 
     75 
     76.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     77 
     78.. _Invoking_the_Graph_Menu: 
     79 
     80Invoking the Graph Menu 
     81----------------------- 
     82 
     83To invoke the *Graph Menu* simply right-click on a data/theory plot, or click  
     84the *Graph Menu* (bullet list) icon in the toolbar at the bottom of the plot.  
     85Then select a menu item. 
     86 
     87.. _Hide_Show_Delete_Graph: 
     88 
     89Hide/Show/Delete Graph 
     90---------------------- 
     91 
     92To expand a plot window, click the *Maximise* (square) icon in the top-right  
     93corner. 
     94 
     95To shrink a plot window, click the *Restore down* (square-on-square) icon in  
     96the top-right corner. 
     97 
     98To hide a plot, click the *Minimise* (-) icon in the top-right corner of the  
     99plot window. 
     100 
     101To show a hidden plot, select the *Restore up* (square-on-square) icon on the  
     102minimised window. 
     103 
     104To delete a plot, click the *Close* (x) icon in the top-right corner of the  
     105plot window. 
     106 
     107*NOTE! If a residuals graph (when fitting data) is hidden, it will not show up  
     108after computation.* 
     109 
     110.. _Drag_Plot: 
     111 
     112Drag Plot 
     113--------- 
     114 
     115Select the *Pan* (crossed arrows) icon in the toolbar at the bottom of the plot  
     116to activate this option. Move the mouse pointer to the plot. It will change to  
     117a hand. Then left-click and drag the plot around. The axis values will adjust  
     118accordingly. 
     119  
     120To disable dragging mode, unselect the *crossed arrows* icon on the toolbar. 
     121 
     122.. _Zoom_In_Out: 
     123 
     124Zoom In/Out 
     125----------- 
     126 
     127Select the *Zoom* (magnifying glass) button in the toolbar at the bottom of  
     128the plot to activate this option. Move the mouse pointer to the plot. It will  
     129change to a cross-hair. Then left-click and drag the pointer around to generate  
     130a region of interest. Release the mouse button to generate the new view. 
     131 
     132To disable zoom mode, unselect the *Zoom* button on the toolbar. 
     133 
     134After zooming in on a a region, the *left arrow* or *right arrow* buttons on  
     135the toolbar will switch between recent views. 
     136 
     137*NOTE! If a wheel mouse is available scrolling the wheel will zoom in/out  
     138on the current plot (changing both axes). Alternatively, point at the numbers  
     139on one axis and scroll the wheel to zoom in/out on just that axis.* 
     140 
     141To return to the original view of the data, click the the *Reset* (home) icon  
     142in the toolbar at the bottom of the plot (see Reset_Graph_ for further details). 
     143 
     144.. _Save_Plot_Image: 
     145 
     146Save Plot Image 
     147--------------- 
     148 
     149To save the current plot as an image file, right click on the plot to bring up  
     150the *Graph Menu* (see Invoking_the_Graph_Menu_) and select *Save Image*.  
     151Alternatively, click on the *Save* (floppy disk) icon in the toolbar at the  
     152bottom of the plot. 
     153  
     154A dialog window will open. Select a folder, enter a filename, choose an output  
     155image type, and click *Save*. 
     156 
     157The currently supported image types are: 
     158 
     159*  EPS (encapsulated postscript) 
     160*  EMF (enhanced metafile) 
     161*  JPG/JPEG (joint photographics experts group) 
     162*  PDF (portable documant format) 
     163*  PNG (portable network graphics) 
     164*  PS (postscript) 
     165*  RAW/RGBA (bitmap) 
     166*  SVG/SVGA (scalable vector graphics) 
     167*  TIF/TIFF (tagged iamge file) 
     168 
     169.. _Print_Plot: 
     170 
     171Print Plot 
    20172---------- 
    21173 
    22 Invoking_the_Graph_Menu_ 
    23  
    24 Reset_Graph_ 
    25  
    26 Hide_Show_Delete_Graph_ 
    27  
    28 Data_Info_ 
    29  
    30 Save_Plot_Image_ 
    31  
    32 Save_Data_ 
    33  
    34 Drag_Plot_ 
    35  
    36 Zoom_In_Out_ 
    37  
    38 Remove_Data_from_Plot_ 
    39  
    40 Change_Scale_ 
    41  
    42 Linear_Fit_ 
    43  
    44 Other_Graph_Modifications_ 
    45  
    46 .. _Invoking_the_Graph_Menu: 
    47  
    48 Introduction 
    49 ------------ 
    50  
    51 Locating the pointer and right-clicking on a data/theory plot will bring a  
    52 context menu. On the menu, select a menu item. 
     174To send the current plot to a printer, click on the *Print* (printer) icon in  
     175the toolbar at the bottom of the plot. 
    53176 
    54177.. _Reset_Graph: 
     
    57180----------- 
    58181 
    59 To reset the graph's axis range, right click on the plot and the context menu  
    60 pops-up. Select *Reset Graph*  and the plot will take its initial range. Also  
    61 the 'home' icon in tool bar will do the same. 
    62  
    63 .. _Hide_Show_Delete_Graph: 
    64  
    65 Hide/Show/Delete Graph 
    66 ---------------------- 
    67  
    68 To Hide, click the Hide (bar) button in the tool bar.To Show, select the the  
    69 'Show' menu item in the 'Graph' menu in the menu bar.To Delete, click the 'x'  
    70 button in the title bar. 
    71  
    72 Note: If a residuals graph (in Fitting) is hidden, it will not show up after  
    73 computation. 
     182To reset the axis range of a graph to its initial values select *Reset Graph  
     183Range* on the *Graph Menu* (see Invoking_the_Graph_Menu_). Alternatively, use  
     184the *Reset* (home) icon in the toolbar at the bottom of the plot. 
     185 
     186.. _Graph_Modifications: 
     187 
     188Graph Modifications 
     189------------------- 
     190 
     191From the *Graph Menu* (see Invoking_the_Graph_Menu_) it is also possible to  
     192make some custom modifications to plots, including: 
     193 
     194*  changing the plot window title 
     195*  changing the axis legend locations 
     196*  changing the axis legend label text 
     197*  changing the axis legend label units 
     198*  changing the axis legend label font & font colour 
     199*  adding/removing a text string 
     200*  adding a grid overlay 
     201 
     202.. _Change_Scale: 
     203 
     204Change Scale 
     205------------ 
     206 
     207This menu option is only available with 1D data. 
     208 
     209From the *Graph Menu* (see Invoking_the_Graph_Menu_) select *Change Scale*. A  
     210dialog window will appear in which it is possible to choose different  
     211transformations of the x (usually Q) or y (usually I(Q)) axes, including: 
     212 
     213*  x, x^2, x^4, ln(x), log10(x), log10(x^4) 
     214*  y, 1/y, ln(y), y^2, y.(x^4), 1/sqrt(y), 
     215*  log10(y), ln(y.x), ln(y.x^2), ln(y.x^4), log10(y.x^4) 
     216  
     217A *View* option includes short-cuts to common SAS transformations, such as: 
     218 
     219*  linear 
     220*  Guinier 
     221*  X-sectional Guinier 
     222*  Porod 
     223*  Kratky 
     224 
     225For properly corrected and scaled data, these SAS transformations can be used  
     226to estimate, for example, Rg, rod diameter, or SANS incoherent background  
     227levels, via a linear fit (see Linear_Fit_). 
     228 
     229.. _Toggle_Scale: 
     230 
     231Toggle Scale 
     232------------ 
     233 
     234This menu option is only available with 2D data. 
     235 
     236From the *Graph Menu* (see Invoking_the_Graph_Menu_) select *Toggle Linear/Log  
     237Scale* to switch between a linear to log intensity scale. The type of scale  
     238selected is written alongside the colour scale. 
     239 
     240.. _2D_Color_Map: 
     241 
     2422D Color Map 
     243------------ 
     244 
     245This menu option is only available with 2D data. 
     246 
     247From the *Graph Menu* (see Invoking_the_Graph_Menu_) select *2D Color Map* to  
     248choose a different color scale for the image and/or change the maximum or  
     249minimum limits of the scale. 
     250 
     251.. _Data_Coordinates: 
     252 
     253Data Coordinates 
     254---------------- 
     255 
     256Clicking anywhere in the plot window will cause the current coordinates to be  
     257displayed in the status bar at the very bottom-left of the SasView window. 
     258  
     259.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     260 
     261.. _Invoking_the_Dataset_Menu: 
     262 
     263Invoking_the_Dataset_Menu 
     264------------------------- 
     265 
     266From the *Graph Menu* (see Invoking_the_Graph_Menu_) highlight a plotted  
     267dataset. 
    74268 
    75269.. _Data_Info: 
     
    78272--------- 
    79273 
    80 From the context menu, select 'Data Info' to see the data information dialog 
    81 panel. 
    82  
    83 .. _Save_Plot_Image: 
    84  
    85 Save Plot Image 
    86 --------------- 
    87  
    88 Right click on plot. Context menu will pop-up select save image [file name]. 
    89 A dialog window opens and write a the name of the file to save and click on  
    90 *Save Image.* 
     274In the *Dataset Menu* (see Invoking_the_Dataset_Menu_), highlight a data set  
     275and select *DataInfo* to bring up a data information dialog panel for that  
     276data set. 
    91277 
    92278.. _Save_Data: 
     
    95281--------- 
    96282 
    97 From the context menu, select 'Save points as a file' for 1D, or 'Save as a  
    98 file(DAT)' for 2D. Note that two formats, txt and xml, are available in 1D  
    99 saving. 
    100  
    101 .. _Drag_Plot: 
    102  
    103 Drag Plot 
    104 --------- 
    105  
    106 Select the *crossed arrows*  button on the plot panel *toolbar*  to drag the  
    107 plot. To disable dragging mode, unselect the same button on the toolbar. 
    108  
    109 .. _Zoom_In_Out: 
    110  
    111 Zoom In/Out 
    112 ----------- 
    113  
    114 Select the *rectangle*  button on the plot panel *toolbar*  to zoom in a 
    115 region of the plot. 
    116  
    117 To disable zoom mode, unselect the same button on the toolbar. After zoom in 
    118 a region, select *left arrow*  or *right arrow*  button on the toolbar to set 
    119 the graph the the previous size. If a mouse wheel button is available, 
    120 *zoom in/out*  by scrolling the mouse wheel (see Key_Sequences_ help for 
    121 details). 
     283In the *Dataset Menu* (see Invoking_the_Dataset_Menu_), select *Save Points as  
     284a File* (if 1D data) or *Save as a file(DAT)* (if 2D data). A save dialog will  
     285appear. 
     286 
     2871D data can be saved in either ASCII text (.TXT) or CanSAS/SASXML (.XML)  
     288formats (see 1D_Formats_). 2D data can only be saved in the NIST 2D format  
     289(.DAT) (see 2D_Formats_). 
     290 
     291.. _Linear_Fit: 
     292 
     293Linear Fit 
     294---------- 
     295 
     296Linear fit performs a simple ( y(x)=ax+b ) linear fit within the plot window. 
     297 
     298In the *Dataset Menu* (see Invoking_the_Dataset_Menu_), select *Linear Fit*. A  
     299fitting dialog will appear. Set some initial parameters and data limits and  
     300click *Fit*. The fitted parameter values are displayed and the resulting line  
     301calculated from them is added to the plot.  
     302 
     303This option is most useful for performing simple Guinier, XS Guinier, and 
     304Porod type analyses, for example, to estimate Rg, a rod diameter, or incoherent  
     305background level, respectively. 
     306 
     307The following figure shows an example of a Guinier analysis using this option 
     308 
     309.. image:: guinier_fit.png 
    122310 
    123311.. _Remove_Data_from_Plot: 
     
    126314--------------------- 
    127315 
    128 Highlight the plot and the context menu appears.Select *remove [file name]*. 
    129 The plot selected will disappear. 
    130  
    131 .. _Change_Scale: 
    132  
    133 Change Scale 
    134 ------------ 
    135  
    136 If the loaded data is a 1-D data changing scale or data representation will  
    137 work as follows. *Right click* on the plot window. A context menu pops-up and  
    138 select *Change Scale* . A dialog window titled *select the scale of the graph*  
    139 will pop-up then change the *x* , the *y*  and the *view*  values as wish. 
    140  
    141 The 'view' option includes the axis scale short-cuts such as Linear, Guinier,  
    142 Cross-sectional (XC) Guinier, and Porod plot scale. For a proper data set,  
    143 these axis scales can be used to estimate Rg, Rod diameter, or Background of  
    144 neutron scattering data respectively (via 'Linear Fit'; see below). For a 2D  
    145 image, *Right click*  on the image to pop-up the context menu. Select to  
    146 switch from linear to log scale. The scale selected is printed on the status  
    147 bar. 
    148  
    149 If the loaded data is an image. *Right click*  on the image to pop-up the 
    150 context menu. Select to switch from linear to log scale. The scale selected is 
    151 printed on the status bar. 
    152  
    153 .. _Linear_Fit: 
    154  
    155 Linear Fit 
    156 ---------- 
    157  
    158 Linear fit is to perform a line model fitting keeping the scale of the plot. 
    159 Highlight data to fit. From the context menu select *Linear Fit* . A dialog 
    160 window appears. Change model initial parameters, data limits and hit *fit* 
    161 button. New parameters values are displayed and the line with the new 
    162 parameters is added to the plot. Especially for Guinier, XC Guinier, and 
    163 Porod plot scale, this 'Linear Fit' will provides Rg, Rod diameter, and 
    164 background, respectively. The following figure shows an example for the 
    165 Guinier scale. 
    166  
    167 .. image:: guinier_fit.png 
    168  
    169 .. _Other_Graph_Modifications: 
    170  
    171 Other Graph Modifications 
    172 ------------------------- 
    173  
    174 Some custom modifications of the symbols, text, axis, etc of the graph are  
    175 provided. 
     316In the *Dataset Menu* (see Invoking_the_Dataset_Menu_), select *Remove*. The  
     317selected data will be removed from the plot. 
     318 
     319*NOTE! This action cannot be undone.* 
     320 
     321.. _Show_Hide_Error_Bars: 
     322 
     323Show/Hide Error Bars 
     324-------------------- 
     325 
     326In the *Dataset Menu* (see Invoking_the_Dataset_Menu_), select *Show Error Bar*  
     327or *Hide Error Bar* to switch between showing/hiding the errors associated  
     328with the chosen dataset.  
     329 
     330.. _Modify_Plot_Property: 
     331 
     332Modify Plot Property 
     333-------------------- 
     334 
     335In the *Dataset Menu* (see Invoking_the_Dataset_Menu_), select *Modify Plot  
     336Property* to change the size, color, or shape of the displayed marker for the  
     337chosen dataset, or to change the dataset label that appears on the plot. 
    176338 
    177339.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     
    182344----------------- 
    183345 
    184 Principle_ 
     346Purpose_ 
    185347 
    186348How_to_Average_ 
     
    204366.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    205367 
    206 .. Principle:  
    207  
    208 Principle 
    209 --------- 
    210  
    211 This feature allows you to perform different types of averages on your data,  
    212 and allows you to see what regions of the detector will contribute to the  
    213 average. The region to be averaged will be drown and can be modified by  
    214 dragging the lines around. 
     368.. Purpose:  
     369 
     370Purpose 
     371------- 
     372 
     373This feature is only available with 2D data. 
     374 
     3752D data averaging allows you to perform different types of averages on your  
     376data. The region to be averaged is displayed in the plot window and its limits  
     377can be modified by dragging the boundaries around. 
    215378 
    216379.. _How_to_Average: 
     
    219382-------------- 
    220383 
    221 Right click on 2D data for the context menu to appear. Select one type of  
    222 averages among *"sector [Q view]", "Annulus [Phi view]", "Box sum", "Box  
    223 averaging in Qx ", "box averaging on Qy","Perform circular Average".* 
    224  
    225 A slicer will appear except for *"Perform circular Average"*  that you can  
    226 drag by clicking on a slicer 's marker. When the marker is highlighted in red,  
    227 it means that the slicer can change size.You can also move some of the slicer  
    228 by simply drag its side when highlighted in red. the slicer size will be reset  
    229 to its previous size if the user try to select a region greater than the size  
    230 of the data. 
    231  
    232 The user can also select a region to average when a slicer has been selected  
    233 already by *right clicking*  on the context menu and selecting *Edit Slicer  
    234 Parameters* . The dialog window will appears and the user can enter values to  
    235 selected a region or selected numbers of points to plot *nbins* . 
    236  
    237 For *Box sum* , when the user selects this option, a new panel is created  
    238 containing the result of average of the sum of every pixels contains on that  
    239 data.The user can also enter values to select a region. 
     384In the *Dataset Menu* (see Invoking_the_Dataset_Menu_), select one of the  
     385following averages 
     386 
     387*  Perform Circular Average 
     388*  Sector [Q view] 
     389*  Annulus [Phi view] 
     390*  Box sum 
     391*  Box averaging in Qx 
     392*  Box averaging on Qy 
     393 
     394A 'slicer' will appear (except for *Perform Circular Average*) in the plot that  
     395you can drag by clicking on a slicer's handle. When the handle is highlighted  
     396in red, it means that the slicer can move/change size. 
     397 
     398*NOTE! The slicer size will reset if you try to select a region greater than  
     399the size of the data.* 
     400 
     401Alternatively, once a 'slicer' is active you can also select the region to  
     402average by bringing back the *Dataset Menu* and selecting *Edit Slicer  
     403Parameters*. A dialog window will appear in which you can enter values to  
     404define a region or select the number of points to plot (*nbins*). 
     405 
     406A separate plot window will also have appeared, displaying the requested  
     407average. 
     408 
     409*NOTE! The displayed average only updates when input focus is moved back to  
     410that window; ie, when the mouse pointer is moved onto that plot.* 
     411 
     412Selecting *Box Sum* automatically brings up the 'Slicer Parameters' dialog in  
     413order to display the average numerically, rather than graphically. 
     414 
     415To remove a 'slicer', bring back the *Dataset menu* and select *Clear Slicer*. 
    240416 
    241417.. _Available_Averagings: 
     
    244420-------------------- 
    245421 
    246 Some different types of averaging are provided for. 
     422The available averages are 
    247423 
    248424.. _Unmasked_Circular_Average: 
     
    251427------------------------- 
    252428 
    253 This operation will perform and average in constant q-rings around the (x,y) pixel 
    254 location of the beam center. 
     429This operation will perform an average in constant Q-rings around the (x,y)  
     430pixel location of the beam center. 
    255431 
    256432.. _Masked_Circular_Average: 
     
    259435----------------------- 
    260436 
    261 This operation is same as 'Masked Circular Average' except that the masked 
    262 region is excluded if masked. 
     437This operation is the same as 'Unmasked Circular Average' except that any  
     438masked region is excluded. 
    263439 
    264440.. _Sector_Average: 
     
    267443----------------------- 
    268444 
    269 This operation averages in constant q-arcs. The width of the sector is specified in 
    270 degrees (+/- delta phi) each side of the central angle (phi). 
     445This operation averages in constant Q-arcs. 
     446 
     447The width of the sector is specified in degrees (+/- |delta|\|phi|\) each side  
     448of the central angle (|phi|\). 
    271449 
    272450.. _Annular_Average: 
    273451 
    274 Annular Average [Phi View] 
    275 -------------------------- 
    276  
    277 It performs an average between two q-values centered in (0,0), and averaged  
    278 over a width of a specified number of pixels. The data is returned as a  
    279 function of angle (phi) in degrees. Moving one circle of this slicer to  
    280 radius of zero corresponding to a circular averaging on radius qmax , the  
    281 outer circle. The angle zero starts from the positive x-axis direction. 
     452Annular Average [|phi| View] 
     453---------------------------- 
     454 
     455This operation performs an average between two Q-values centered on (0,0),  
     456and averaged over a specified number of pixels. 
     457 
     458The data is returned as a function of angle (|phi|\) in degrees with zero  
     459degrees at the 3 O'clock position. 
    282460 
    283461.. _Box_Sum: 
     
    286464------- 
    287465 
    288 Perform the sum of counts in a 2D region of interest.When editing the slicer,  
    289 the user can enter the length and the width the rectangle slicer and the  
    290 coordinates of the center of this rectangle. 
     466This operation performs a sum of counts in a 2D region of interest. 
     467 
     468When editing the slicer parameters, the user can enter the length and the width  
     469the rectangular slicer and the coordinates of the center of the rectangle. 
    291470 
    292471.. _Box_Averaging_in_Qx: 
     
    295474------------------- 
    296475 
    297 Computes average I(Qx) for a region of interest. When editing the slicer, the  
    298 user can control the length and the width the rectangle slicer. The averaged  
    299 output is calculated from the constant bins with rectangular shape. The  
    300 resultant q values are nominal values, i.e., the central values of each bins  
    301 on the x-axis. 
     476This operation computes an average I(Qx) for the region of interest. 
     477 
     478When editing the slicer parameters, the user can control the length and the  
     479width the rectangular slicer. The averaged output is calculated from constant  
     480bins with rectangular shape. The resultant Q values are nominal values, that  
     481is, the central value of each bin on the x-axis. 
    302482 
    303483.. _Box_Averaging_in_Qy: 
     
    306486------------------- 
    307487 
    308 Computes average I(Qy) for a region of interest.When editing the slicer, the  
    309 user can control the length and the width the rectangle slicer. The averaged  
    310 output is calculated from the constant bins with rectangular shape. The  
    311 resultant q values are nominal values, i.e., the central values of each bins  
    312 on the y-axis. 
    313  
    314 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    315  
    316 .. _Key_Sequences: 
    317  
    318 Key Sequences 
    319 ------------- 
    320  
    321 Floating_Panel_ 
    322  
    323 Context_Menu_ 
    324  
    325 Zoom_ 
    326  
    327 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    328  
    329 .. _Floating_Panel: 
    330  
    331 Floating Panel 
    332 -------------- 
    333  
    334 For a graph panel to float on the top of the SV window: 
    335  
    336 Press the *Ctrl(Cmd on MAC) key*  on dragging and placing a panel. Or if you  
    337 want to make all plot panels float, select 'Float' from Graph/Preperences in  
    338 the menu bar. Otherwise choose 'Dock'. 
    339  
    340 .. _Context_Menu: 
    341  
    342 Graph Context Menu 
    343 ------------------ 
    344  
    345 To get the graph context menu to print, copy, save data, (2D)average, etc,  
    346 *locate the mouse point on the plot to highlight and *(Mouse) Right Click*  
    347 to bring up the full menu. 
    348  
    349 .. _Zoom: 
    350  
    351 Zoom In/Out 
    352 ----------- 
    353  
    354 To Zoom in or out the full plot, *locate the mouse point inside the graph  
    355 which will be the center of the zooming, then *rotate MouseWheel*. 
    356  
    357 *To Zoom in or out the plot in x or y direction, *locate (and click) the  
    358 mouse point near x (or y) axis just outside of the graph and then *rotate  
    359 MouseWheel* .* Note that this works only on the 1D plots. 
     488 
     489This operation computes an average I(Qy) for the region of interest. 
     490 
     491When editing the slicer parameters, the user can control the length and the  
     492width the rectangular slicer. The averaged output is calculated from constant  
     493bins with rectangular shape. The resultant Q values are nominal values, that  
     494is, the central value of each bin on the x-axis. 
     495 
     496.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     497 
     498.. note::  This help document was last changed by Steve King, 18Feb2015 
Note: See TracChangeset for help on using the changeset viewer.