Changeset 0cdf1af in sasview for src/sas/guiframe/media/graph_help.rst
- Timestamp:
- Apr 30, 2015 12:39:39 PM (10 years ago)
- 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:
- a9dc4eb
- Parents:
- 892a2cc
- File:
-
- 1 edited
-
src/sas/guiframe/media/graph_help.rst (modified) (20 diffs)
Legend:
- Unmodified
- Added
- Removed
-
src/sas/guiframe/media/graph_help.rst
r1394952 r0cdf1af 11 11 ==================== 12 12 13 Graph_Window_Options_ 14 15 Dataset_Menu_Options_ 16 17 2D_Data_Averaging_ 13 Help is available on: 14 15 Graph_window_options_ 16 17 Dataset_menu_options_ 18 19 2D_data_averaging_ 18 20 19 21 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 20 22 21 .. _Graph_ Window_Options:22 23 Graph Window Options23 .. _Graph_window_options: 24 25 Graph window options 24 26 -------------------- 25 27 26 Invoking_the_Graph_Menu_ 27 28 Hide_Show_Delete_Graph_ 29 30 Drag_Plot_ 31 32 Zoom_In_Out_ 33 34 Save_Plot_Image_ 35 36 Print_Plot_ 37 38 Reset_Graph_ 39 40 Graph_Modifications_ 41 42 Change_Scale_ 43 44 Toggle_Scale_ 45 46 2D_Color_Map_ 47 48 Data_Coordinates_ 49 50 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 51 52 .. _Dataset_Menu_Options: 53 54 Dataset Menu Options 55 -------------------- 56 57 Invoking_the_Dataset_Menu_ 58 59 Data_Info_ 60 61 Save_Data_ 62 63 Linear_Fit_ 64 65 Remove_Data_from_Plot_ 66 67 Show_Hide_Error_Bars_ 68 69 Modify_Plot_Property_ 70 71 2D Averaging 72 ------------ 73 74 2D_Data_Averaging_ 28 Invoking_the_graph_menu_ 29 30 How_to_Hide-Show-Delete_a_graph_ 31 32 Dragging_a_plot_ 33 34 Zooming_In-Out_on_a_plot_ 35 36 Saving_a_plot_image_ 37 38 Printing_a_plot_ 39 40 Resetting_the_graph_ 41 42 Modifying_the_graph_ 43 44 Changing_scales_ 45 46 Toggling_scales_ 47 48 2D_color_maps_ 49 50 Getting_data_coordinates_ 75 51 76 52 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 77 53 78 .. _Invoking_the_ Graph_Menu:79 80 Invoking the Graph Menu81 ----------------------- 54 .. _Invoking_the_graph_menu: 55 56 Invoking the graph menu 57 ^^^^^^^^^^^^^^^^^^^^^^^ 82 58 83 59 To invoke the *Graph Menu* simply right-click on a data/theory plot, or click … … 85 61 Then select a menu item. 86 62 87 .. _H ide_Show_Delete_Graph:88 89 H ide/Show/Delete Graph90 ---------------------- 63 .. _How_to_Hide-Show-Delete_a_graph: 64 65 How to Hide-Show-Delete a graph 66 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 91 67 92 68 To expand a plot window, click the *Maximise* (square) icon in the top-right … … 108 84 after computation.* 109 85 110 .. _Drag _Plot:111 112 Drag Plot113 --------- 86 .. _Dragging_a_plot: 87 88 Dragging a plot 89 ^^^^^^^^^^^^^^^ 114 90 115 91 Select the *Pan* (crossed arrows) icon in the toolbar at the bottom of the plot … … 120 96 To disable dragging mode, unselect the *crossed arrows* icon on the toolbar. 121 97 122 .. _Zoom _In_Out:123 124 Zoom In/Out125 ----------- 98 .. _Zooming_In-Out_on_a_plot: 99 100 Zooming In-Out on a plot 101 ^^^^^^^^^^^^^^^^^^^^^^^^ 126 102 127 103 Select the *Zoom* (magnifying glass) button in the toolbar at the bottom of … … 140 116 141 117 To return to the original view of the data, click the the *Reset* (home) icon 142 in the toolbar at the bottom of the plot (see Reset _Graph_ for further details).143 144 .. _Sav e_Plot_Image:145 146 Sav e Plot Image147 --------------- 118 in the toolbar at the bottom of the plot (see Resetting_the_graph_ for further details). 119 120 .. _Saving_a_plot_image: 121 122 Saving a plot image 123 ^^^^^^^^^^^^^^^^^^^ 148 124 149 125 To save the current plot as an image file, right click on the plot to bring up 150 the *Graph Menu* (see Invoking_the_ Graph_Menu_) and select *Save Image*.126 the *Graph Menu* (see Invoking_the_graph_menu_) and select *Save Image*. 151 127 Alternatively, click on the *Save* (floppy disk) icon in the toolbar at the 152 128 bottom of the plot. … … 167 143 * TIF/TIFF (tagged iamge file) 168 144 169 .. _Print _Plot:170 171 Print Plot172 ---------- 145 .. _Printing_a_plot: 146 147 Printing a plot 148 ^^^^^^^^^^^^^^^ 173 149 174 150 To send the current plot to a printer, click on the *Print* (printer) icon in 175 151 the toolbar at the bottom of the plot. 176 152 177 .. _Reset _Graph:178 179 Reset Graph180 ----------- 153 .. _Resetting_the_graph: 154 155 Resetting the graph 156 ^^^^^^^^^^^^^^^^^^^ 181 157 182 158 To reset the axis range of a graph to its initial values select *Reset Graph 183 Range* on the *Graph Menu* (see Invoking_the_ Graph_Menu_). Alternatively, use159 Range* on the *Graph Menu* (see Invoking_the_graph_menu_). Alternatively, use 184 160 the *Reset* (home) icon in the toolbar at the bottom of the plot. 185 161 186 .. _ Graph_Modifications:187 188 Graph Modifications 189 ------------------- 190 191 From the *Graph Menu* (see Invoking_the_ Graph_Menu_) it is also possible to162 .. _Modifying_the_graph: 163 164 Modifying the graph 165 ^^^^^^^^^^^^^^^^^^^ 166 167 From the *Graph Menu* (see Invoking_the_graph_menu_) it is also possible to 192 168 make some custom modifications to plots, including: 193 169 … … 200 176 * adding a grid overlay 201 177 202 .. _Chang e_Scale:203 204 Chang e Scale205 ------------ 178 .. _Changing_scales: 179 180 Changing scales 181 ^^^^^^^^^^^^^^^ 206 182 207 183 This menu option is only available with 1D data. 208 184 209 From the *Graph Menu* (see Invoking_the_ Graph_Menu_) select *Change Scale*. A185 From the *Graph Menu* (see Invoking_the_graph_menu_) select *Change Scale*. A 210 186 dialog window will appear in which it is possible to choose different 211 187 transformations of the x (usually Q) or y (usually I(Q)) axes, including: … … 225 201 For properly corrected and scaled data, these SAS transformations can be used 226 202 to estimate, for example, Rg, rod diameter, or SANS incoherent background 227 levels, via a linear fit (see Linear_Fit_).228 229 .. _Toggl e_Scale:230 231 Toggl e Scale232 ------------ 203 levels, via a linear fit (see Making_a_linear_fit_). 204 205 .. _Toggling_scales: 206 207 Toggling scales 208 ^^^^^^^^^^^^^^^ 233 209 234 210 This menu option is only available with 2D data. 235 211 236 From the *Graph Menu* (see Invoking_the_ Graph_Menu_) select *Toggle Linear/Log212 From the *Graph Menu* (see Invoking_the_graph_menu_) select *Toggle Linear/Log 237 213 Scale* to switch between a linear to log intensity scale. The type of scale 238 214 selected is written alongside the colour scale. 239 215 240 .. _2D_ Color_Map:241 242 2D Color Map243 ------------ 216 .. _2D_color_maps: 217 218 2D color maps 219 ^^^^^^^^^^^^^ 244 220 245 221 This menu option is only available with 2D data. … … 249 225 minimum limits of the scale. 250 226 251 .. _ Data_Coordinates:252 253 Data Coordinates254 ---------------- 227 .. _Getting_data_coordinates: 228 229 Getting data coordinates 230 ^^^^^^^^^^^^^^^^^^^^^^^^ 255 231 256 232 Clicking anywhere in the plot window will cause the current coordinates to be … … 259 235 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 260 236 261 .. _Invoking_the_Dataset_Menu: 262 263 Invoking_the_Dataset_Menu 264 ------------------------- 265 266 From the *Graph Menu* (see Invoking_the_Graph_Menu_) highlight a plotted 237 .. _Dataset_menu_options: 238 239 Dataset menu options 240 -------------------- 241 242 Invoking_the_dataset_menu_ 243 244 Getting_data_info_ 245 246 Saving_data_ 247 248 Making_a_linear_fit_ 249 250 Removing_data_from_the_plot_ 251 252 Show-Hide_error_bars_ 253 254 Modify_plot_properties_ 255 256 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 257 258 .. _Invoking_the_dataset_menu: 259 260 Invoking the dataset menu 261 ^^^^^^^^^^^^^^^^^^^^^^^^^ 262 263 From the *Graph Menu* (see Invoking_the_graph_menu_) highlight a plotted 267 264 dataset. 268 265 269 .. _ Data_Info:270 271 Data Info272 --------- 273 274 In the *Dataset Menu* (see Invoking_the_ Dataset_Menu_), highlight a data set266 .. _Getting_data_info: 267 268 Getting data info 269 ^^^^^^^^^^^^^^^^^ 270 271 In the *Dataset Menu* (see Invoking_the_dataset_menu_), highlight a data set 275 272 and select *DataInfo* to bring up a data information dialog panel for that 276 273 data set. 277 274 278 .. _Sav e_Data:279 280 Sav e Data281 --------- 282 283 In the *Dataset Menu* (see Invoking_the_ Dataset_Menu_), select *Save Points as275 .. _Saving_data: 276 277 Saving data 278 ^^^^^^^^^^^ 279 280 In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Save Points as 284 281 a File* (if 1D data) or *Save as a file(DAT)* (if 2D data). A save dialog will 285 282 appear. … … 290 287 2D data can only be saved in the NIST 2D format (.DAT) (see :ref:`2D_Formats`). 291 288 292 .. _ Linear_Fit:293 294 Linear Fit295 ---------- 289 .. _Making_a_linear_fit: 290 291 Making a linear fit 292 ^^^^^^^^^^^^^^^^^^^ 296 293 297 294 Linear fit performs a simple ( y(x)=ax+b ) linear fit within the plot window. 298 295 299 In the *Dataset Menu* (see Invoking_the_ Dataset_Menu_), select *Linear Fit*. A296 In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Linear Fit*. A 300 297 fitting dialog will appear. Set some initial parameters and data limits and 301 298 click *Fit*. The fitted parameter values are displayed and the resulting line … … 310 307 .. image:: guinier_fit.png 311 308 312 .. _Remov e_Data_from_Plot:313 314 Remov e Data from Plot315 --------------------- 316 317 In the *Dataset Menu* (see Invoking_the_ Dataset_Menu_), select *Remove*. The309 .. _Removing_data_from_the_plot: 310 311 Removing data from the plot 312 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ 313 314 In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Remove*. The 318 315 selected data will be removed from the plot. 319 316 320 317 *NOTE! This action cannot be undone.* 321 318 322 .. _Show _Hide_Error_Bars:323 324 Show /Hide Error Bars325 -------------------- 326 327 In the *Dataset Menu* (see Invoking_the_ Dataset_Menu_), select *Show Error Bar*319 .. _Show-Hide_error_bars: 320 321 Show-Hide error bars 322 ^^^^^^^^^^^^^^^^^^^^ 323 324 In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Show Error Bar* 328 325 or *Hide Error Bar* to switch between showing/hiding the errors associated 329 326 with the chosen dataset. 330 327 331 .. _Modify_ Plot_Property:332 333 Modify Plot Property334 -------------------- 335 336 In the *Dataset Menu* (see Invoking_the_ Dataset_Menu_), select *Modify Plot328 .. _Modify_plot_properties: 329 330 Modify plot properties 331 ^^^^^^^^^^^^^^^^^^^^^^ 332 333 In the *Dataset Menu* (see Invoking_the_dataset_menu_), select *Modify Plot 337 334 Property* to change the size, color, or shape of the displayed marker for the 338 335 chosen dataset, or to change the dataset label that appears on the plot. … … 340 337 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 341 338 342 .. _2D_ Data_Averaging:343 344 2D Data Averaging339 .. _2D_data_averaging: 340 341 2D data averaging 345 342 ----------------- 346 343 347 344 Purpose_ 348 345 349 How_to_Average_ 350 351 Available_Averagings_ 352 353 Unmasked_Circular_Average_ 354 355 Masked_Circular_Average_ 356 357 Sector_Average_ 358 359 Annular_Average_ 360 361 Box_Sum_ 362 363 Box_Averaging_in_Qx_ 364 365 Box_Averaging_in_Qy_ 346 How_to_average_ 347 348 Unmasked_circular_average_ 349 350 Masked_circular_average_ 351 352 Sector_average_ 353 354 Annular_average_ 355 356 Box_sum_ 357 358 Box_averaging_in_Qx_ 359 360 Box_averaging_in_Qy_ 366 361 367 362 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 368 363 369 .. Purpose:364 .. _Purpose: 370 365 371 366 Purpose 372 ------- 367 ^^^^^^^ 373 368 374 369 This feature is only available with 2D data. … … 378 373 can be modified by dragging the boundaries around. 379 374 380 .. _How_to_ Average:381 382 How to Average383 -------------- 384 385 In the *Dataset Menu* (see Invoking_the_ Dataset_Menu_), select one of the375 .. _How_to_average: 376 377 How to average 378 ^^^^^^^^^^^^^^ 379 380 In the *Dataset Menu* (see Invoking_the_dataset_menu_), select one of the 386 381 following averages 387 382 … … 416 411 To remove a 'slicer', bring back the *Dataset menu* and select *Clear Slicer*. 417 412 418 .. _Available_Averagings: 419 420 Available Averagings 421 -------------------- 422 423 The available averages are 424 425 .. _Unmasked_Circular_Average: 426 427 Unmasked Circular Average 428 ------------------------- 413 .. _Unmasked_circular_average: 414 415 Unmasked circular average 416 ^^^^^^^^^^^^^^^^^^^^^^^^^ 429 417 430 418 This operation will perform an average in constant Q-rings around the (x,y) 431 419 pixel location of the beam center. 432 420 433 .. _Masked_ Circular_Average:434 435 Masked Circular Average436 ----------------------- 421 .. _Masked_circular_average: 422 423 Masked circular average 424 ^^^^^^^^^^^^^^^^^^^^^^^ 437 425 438 426 This operation is the same as 'Unmasked Circular Average' except that any 439 427 masked region is excluded. 440 428 441 .. _Sector_ Average:442 443 Sector Average [Q View]444 ----------------------- 429 .. _Sector_average: 430 431 Sector average [Q View] 432 ^^^^^^^^^^^^^^^^^^^^^^^ 445 433 446 434 This operation averages in constant Q-arcs. … … 449 437 of the central angle (|phi|\). 450 438 451 .. _Annular_ Average:452 453 Annular Average [|phi| View]454 ---------------------------- 439 .. _Annular_average: 440 441 Annular average [|phi| View] 442 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 455 443 456 444 This operation performs an average between two Q-values centered on (0,0), … … 460 448 degrees at the 3 O'clock position. 461 449 462 .. _Box_ Sum:463 464 Box Sum465 ------- 450 .. _Box_sum: 451 452 Box sum 453 ^^^^^^^ 466 454 467 455 This operation performs a sum of counts in a 2D region of interest. … … 470 458 the rectangular slicer and the coordinates of the center of the rectangle. 471 459 472 .. _Box_ Averaging_in_Qx:460 .. _Box_averaging_in_Qx: 473 461 474 462 Box Averaging in Qx 475 ------------------- 463 ^^^^^^^^^^^^^^^^^^^ 476 464 477 465 This operation computes an average I(Qx) for the region of interest. … … 482 470 is, the central value of each bin on the x-axis. 483 471 484 .. _Box_ Averaging_in_Qy:472 .. _Box_averaging_in_Qy: 485 473 486 474 Box Averaging in Qy 487 ------------------- 488 475 ^^^^^^^^^^^^^^^^^^^ 489 476 490 477 This operation computes an average I(Qy) for the region of interest. … … 497 484 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 498 485 499 .. note:: This help document was last changed by Steve King, 18Feb2015486 .. note:: This help document was last changed by Steve King, 30Apr2015
Note: See TracChangeset
for help on using the changeset viewer.
