Changeset 23a9beb in sasview for src/sas/guiframe


Ignore:
Timestamp:
Feb 15, 2015 10:09:34 AM (10 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:
920928f
Parents:
898a8b9
Message:

Fixed rst errors

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

Legend:

Unmodified
Added
Removed

  • src/sas/guiframe/media/data_explorer_help.rst

    r78f02c3 r23a9beb  
    1 .. _data_explorer_help.rst 
     1.. data_explorer_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
    … …  
    77============ 
    88 
    9 1. Introduction_  
    10 2. Load Data_ 
    11 3. Handy Menu_ 
    12 4. Activate Data_ 
    13 5. Remove Data_ 
    14 6. Append Plot to Graph_ 
    15 7. Create New Plot_ 
    16 8. Freeze Theory_ 
    17 9. Send Data to Applications_ 
     9Introduction_ 
     10 
     11Load_Data_ 
     12 
     13Handy_Menu_ 
     14 
     15Activate_Data_ 
     16 
     17Remove_Data_ 
     18 
     19Append_Plot_to_Graph_ 
     20 
     21Create_New_Plot_ 
     22 
     23Freeze_Theory_ 
     24 
     25Send_Data_to_Applications_ 
    1826 
    1927.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    … …  
    2331Introduction 
    2432------------ 
     33 
    2534*Data Explorer* is a panel that allows the user more interactions with data.  
    2635Some functionalities provided by the Data Explorer are also available through  
    … …  
    3544.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    3645 
    37 .. _Load Data: 
     46.. _Load_Data: 
    3847 
    3948Load Data 
    … …  
    4857.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    4958 
    50 .. _Handy Menu: 
     59.. _Handy_Menu: 
    5160 
    5261Handy Menu 
    … …  
    5766context menu. 
    5867 
    59 .. _ image:: hand_menu.png 
     68.. image:: hand_menu.png 
    6069 
    6170.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    6271 
    63 .. _Activate Data: 
     72.. _Activate_Data: 
    6473 
    6574Activate Data 
    … …  
    7584.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    7685 
    77 .. _Remove Data: 
     86.. _Remove_Data: 
    7887 
    7988Remove Data 
    … …  
    8695.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    8796 
    88 .. _Append Plot to Graph: 
     97.. _Append_Plot_to_Graph: 
    8998 
    9099Append Plot to Graph 
    … …  
    100109.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    101110 
    102 .. _Create New Plot: 
     111.. _Create_New_Plot: 
    103112 
    104113Create New Plot 
    … …  
    110119.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    111120 
    112 .. _Freeze Theory: 
     121.. _Freeze_Theory: 
    113122 
    114123Freeze Theory 
    … …  
    120129.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    121130 
    122 .. _Send to application: 
     131.. _Send_Data_to_Applications: 
    123132 
    124133Send to Application 

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

    r78f02c3 r23a9beb  
    1 ..graph_help.rst 
     1.. graph_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
    … …  
    77==================== 
    88 
    9 1. Graph Menu_ 
    10 2. 2D Data Averaging_ 
    11 3. Key Combinations_ 
    12  
    13 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    14  
    15 .. _Graph menu: 
     9Graph_Menu_ 
     10 
     112D_Data_Averaging_ 
     12 
     13Key_Combinations_ 
     14 
     15.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     16 
     17.. _Graph_Menu: 
    1618 
    1719Graph Menu 
    1820---------- 
    1921 
    20 Introduction_  
    21 Reset Graph_  
    22 Hide/Show/Delete Graph_  
    23 Data Info_  
    24 Save Plot Image_  
    25 Save Data_  
    26 Drag Plot_  
    27 Zoom In/Out_  
    28 Remove Data_  
    29 Change Scale_  
    30 Linear Fit_  
    31 Other Graph Modifications_  
    32  
    33 .. _Introduction:  
     22Introduction_ 
     23 
     24Reset_Graph_ 
     25 
     26Hide_Show_Delete_Graph_ 
     27 
     28Data_Info_ 
     29 
     30Save_Plot_Image_ 
     31 
     32Save_Data_ 
     33 
     34Drag_Plot_ 
     35 
     36Zoom_In_Out_ 
     37 
     38Remove_Data_ 
     39 
     40Change_Scale_ 
     41 
     42Linear_Fit_ 
     43 
     44Other_Graph_Modifications_ 
     45 
     46.. _Introduction: 
     47 
     48Introduction 
     49------------ 
    3450 
    3551Locating the pointer and right-clicking on a data/theory plot will bring a  
    3652context menu. On the menu, select a menu item. 
    3753 
    38 .. _Reset Graph:  
     54.. _Reset_Graph: 
     55 
     56Reset Graph 
     57----------- 
    3958 
    4059To reset the graph's axis range, right click on the plot and the context menu  
    … …  
    4261the 'home' icon in tool bar will do the same. 
    4362 
    44 .. _Hide/Show/Delete Graph:  
     63.. _Hide_Show_Delete_Graph: 
     64 
     65Hide/Show/Delete Graph 
     66---------------------- 
    4567 
    4668To Hide, click the Hide (bar) button in the tool bar.To Show, select the the  
    … …  
    5173computation. 
    5274 
    53 .. _Save Plot Image:  
     75.. _Data_Info: 
     76 
     77Data Info 
     78--------- 
     79 
     80From the context menu, select 'Data Info' to see the data information dialog 
     81panel. 
     82 
     83.. _Save_Plot_Image: 
     84 
     85Save Plot Image 
     86--------------- 
    5487 
    5588Right click on plot. Context menu will pop-up select save image [file name]. 
    … …  
    5790*Save Image.* 
    5891 
    59 .. _Data Info:  
    60  
    61 From the context menu, select 'Data Info' to see the data information dialog  
    62 panel. 
    63  
    64 .. _Save Data:  
     92.. _Save_Data: 
     93 
     94Save Data 
     95--------- 
    6596 
    6697From the context menu, select 'Save points as a file' for 1D, or 'Save as a  
    … …  
    6899saving. 
    69100 
    70 .. _Drag Plot:  
     101.. _Drag_Plot: 
     102 
     103Drag Plot 
     104--------- 
    71105 
    72106Select the *crossed arrows*  button on the plot panel *toolbar*  to drag the  
    73107plot. To disable dragging mode, unselect the same button on the toolbar. 
    74108 
    75 .. _Remove data from plot:  
    76  
    77 Highlight the plot and the context menu appears.Select *remove [file name]*.  
     109.. _Zoom_In_Out: 
     110 
     111Zoom In/Out 
     112----------- 
     113 
     114Select the *rectangle*  button on the plot panel *toolbar*  to zoom in a 
     115region of the plot. 
     116 
     117To disable zoom mode, unselect the same button on the toolbar. After zoom in 
     118a region, select *left arrow*  or *right arrow*  button on the toolbar to set 
     119the graph the the previous size. If a mouse wheel button is available, 
     120*zoom in/out*  by scrolling the mouse wheel (see Key_Combinations_ help for 
     121details). 
     122 
     123.. _Remove_Data: 
     124 
     125Remove Data from Plot 
     126--------------------- 
     127 
     128Highlight the plot and the context menu appears.Select *remove [file name]*. 
    78129The plot selected will disappear. 
    79130 
    80 .. _Zoom In/Out:  
    81  
    82 Select the *rectangle*  button on the plot panel *toolbar*  to zoom in a  
    83 region of the plot. 
    84  
    85 To disable zoom mode, unselect the same button on the toolbar. After zoom in  
    86 a region, select *left arrow*  or *right arrow*  button on the toolbar to set  
    87 the graph the the previous size. If a mouse wheel button is available,  
    88 *zoom in/out*  by scrolling the mouse wheel (see Key combination_ help for  
    89 details). 
    90  
    91 .. _Change Scale:  
     131.. _Change_Scale: 
     132 
     133Change Scale 
     134------------ 
    92135 
    93136If the loaded data is a 1-D data changing scale or data representation will  
    94137work as follows. *Right click* on the plot window. A context menu pops-up and  
    95138select *Change Scale* . A dialog window titled *select the scale of the graph*  
    96 will pop-up then change the *x* , the *y*  and the *view*  values as wish.  
     139will pop-up then change the *x* , the *y*  and the *view*  values as wish. 
     140 
    97141The 'view' option includes the axis scale short-cuts such as Linear, Guinier,  
    98142Cross-sectional (XC) Guinier, and Porod plot scale. For a proper data set,  
    … …  
    103147bar. 
    104148 
    105 .. _Linear Fit:  
    106  
    107 Linear fit is to perform a line model fitting keeping the scale of the plot.  
    108 Highlight data to fit. From the context menu select *Linear Fit* . A dialog  
    109 window appears. Change model initial parameters, data limits and hit *fit*  
    110 button. New parameters values are displayed and the line with the new  
    111 parameters is added to the plot. Especially for Guinier, XC Guinier, and  
    112 Porod plot scale, this 'Linear Fit' will provides Rg, Rod diameter, and  
    113 background, respectively. The following figure shows an example for the  
     149If the loaded data is an image. *Right click*  on the image to pop-up the 
     150context menu. Select to switch from linear to log scale. The scale selected is 
     151printed on the status bar. 
     152 
     153.. _Linear_Fit: 
     154 
     155Linear Fit 
     156---------- 
     157 
     158Linear fit is to perform a line model fitting keeping the scale of the plot. 
     159Highlight data to fit. From the context menu select *Linear Fit* . A dialog 
     160window appears. Change model initial parameters, data limits and hit *fit* 
     161button. New parameters values are displayed and the line with the new 
     162parameters is added to the plot. Especially for Guinier, XC Guinier, and 
     163Porod plot scale, this 'Linear Fit' will provides Rg, Rod diameter, and 
     164background, respectively. The following figure shows an example for the 
    114165Guinier scale. 
    115166 
    116 .. _Change scale 
    117  
    118 If the loaded data is a 1-D data changing scale or data representation will  
    119 work as follows. *Right click* on the plot window. A context menu pops-up and  
    120 select *Change Scale* . A dialog window titled *select the scale of the graph*  
    121 will pop-up then change the *x* , the *y*  and the *view*  values as wish.  
    122 If the loaded data is an image. *Right click*  on the image to pop-up the  
    123 context menu. Select to switch from linear to log scale. The scale selected is  
    124 printed on the statusbar. 
    125  
    126167.. image:: guinier_fit.png 
    127168 
    128 .. _Other Graph Modifications:  
     169.. _Other_Graph_Modifications: 
     170 
     171Other Graph Modifications 
     172------------------------- 
    129173 
    130174Some custom modifications of the symbols, text, axis, etc of the graph are  
    131 provided 
    132  
    133 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    134  
    135 .. _2D data averaging 
     175provided. 
     176 
     177.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     178 
     179.. _2D_Data_Averaging: 
    136180 
    1371812D Data Averaging 
    138182----------------- 
    139183 
    140 Description_  
    141 How to Average_  
    142 Available Averagings_ 
    143 Perform Circular Average_  
    144 Masked Circular Average_  
    145 Sector [Q view]_  
    146 Annulus [Phi view]_  
    147 Box Sum_  
    148 Box Averaging in Qx_  
    149 Box Averaging in Qy_  
     184Description_ 
     185 
     186How_to_Average_ 
     187 
     188Available_Averagings_ 
     189 
     190Unmasked_Circular_Average_ 
     191 
     192Masked_Circular_Average_ 
     193 
     194Sector_Average_ 
     195 
     196Annular_Average_ 
     197 
     198Box_Sum_ 
     199 
     200Box_Averaging_in_Qx_ 
     201 
     202Box_Averaging_in_Qy_ 
    150203 
    151204.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    152205 
    153206.. _Description:  
     207 
     208Description 
     209----------- 
    154210 
    155211This feature allows you to perform different types of averages on your data,  
    … …  
    158214dragging the lines around. 
    159215 
    160 .. _How to Average  
     216.. _How_to_Average: 
     217 
     218How to Average 
     219-------------- 
    161220 
    162221Right click on 2D data for the context menu to appear. Select one type of  
    … …  
    180239data.The user can also enter values to select a region. 
    181240 
    182 .. _Available Averagings: 
    183  
    184 ??? 
    185  
    186 .. _Perform Circular Average:  
    187  
    188 It will perform and average in constant q-rings around the (x,y) pixel  
     241.. _Available_Averagings: 
     242 
     243Available Averagings 
     244-------------------- 
     245 
     246Some different types of averaging are provided for. 
     247 
     248.. _Unmasked_Circular_Average: 
     249 
     250Unmasked Circular Average 
     251------------------------- 
     252 
     253This operation will perform and average in constant q-rings around the (x,y) pixel 
    189254location of the beam center. 
    190255 
    191 .. _Masked Circular Average:  
    192  
    193 This operation is same as 'Perform Circular Average' except that the masked  
     256.. _Masked_Circular_Average: 
     257 
     258Masked Circular Average 
     259----------------------- 
     260 
     261This operation is same as 'Masked Circular Average' except that the masked 
    194262region is excluded if masked. 
    195263 
    196 .. _Sector [Q view]:  
    197  
    198 It averages in constant q-arcs. The width of the sector is specified in  
    199 degrees (+/- delta phi) each direction from the central angle (phi). 
    200  
    201 .. _Annulus [Phi view]:  
     264.. _Sector_Average: 
     265 
     266Sector Average [Q View] 
     267----------------------- 
     268 
     269This operation averages in constant q-arcs. The width of the sector is specified in 
     270degrees (+/- delta phi) each side of the central angle (phi). 
     271 
     272.. _Annular_Average: 
     273 
     274Annular Average [Phi View] 
     275-------------------------- 
    202276 
    203277It performs an average between two q-values centered in (0,0), and averaged  
    … …  
    207281outer circle. The angle zero starts from the positive x-axis direction. 
    208282 
    209 .. _Box Sum:  
     283.. _Box_Sum: 
     284 
     285Box Sum 
     286------- 
    210287 
    211288Perform the sum of counts in a 2D region of interest.When editing the slicer,  
    … …  
    213290coordinates of the center of this rectangle. 
    214291 
    215 .. _Box Averaging in Qx:  
     292.. _Box_Averaging_in_Qx: 
     293 
     294Box Averaging in Qx 
     295------------------- 
    216296 
    217297Computes average I(Qx) for a region of interest. When editing the slicer, the  
    … …  
    221301on the x-axis. 
    222302 
    223 .. _Box Averaging in Qy:  
     303.. _Box_Averaging_in_Qy: 
     304 
     305Box Averaging in Qy 
     306------------------- 
    224307 
    225308Computes average I(Qy) for a region of interest.When editing the slicer, the  
    … …  
    231314.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    232315 
    233 .. _Key combination 
     316.. _Key_Combinations: 
    234317 
    235318Key Combination 
    236319--------------- 
    237320 
    238 Floating Panel_  
    239 Graph Context Menu_  
    240 Zoom In and Out_  
    241  
    242 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    243  
    244 .. _Floating Panel:  
     321Floating_Panel_ 
     322 
     323Graph_Context_Menu_ 
     324 
     325Zoom_ 
     326 
     327.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     328 
     329.. _Floating_Panel: 
     330 
     331Floating Panel 
     332-------------- 
    245333 
    246334For a graph panel to float on the top of the SV window: 
    … …  
    250338the menu bar. Otherwise choose 'Dock'. 
    251339 
    252 .. _Graph Context Menu:  
     340.. _Graph_Context_Menu: 
     341 
     342Graph Context Menu 
     343------------------ 
    253344 
    254345To get the graph context menu to print, copy, save data, (2D)average, etc,  
    … …  
    256347to bring up the full menu. 
    257348 
    258 .. _Zoom In and Out:  
     349.. _Zoom: 
     350 
     351Zoom In/Out 
     352----------- 
    259353 
    260354To Zoom in or out the full plot, *locate the mouse point inside the graph  
Note: See TracChangeset for help on using the changeset viewer.