Changeset a9dc4eb in sasview for src/sas/guiframe/media


Ignore:
Timestamp:
May 1, 2015 6:21:43 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:
f256d9b
Parents:
0cdf1af
Message:

Sphinx formatting changes (sections → sections & subsections; many
'html'ised internal links removed as Sphinx will autogenerate navigation
links from the sectioning)

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

Legend:

Unmodified
Added
Removed

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

    r0cdf1af ra9dc4eb  
    44.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 
    55 
     6.. _Loading_data: 
     7 
    68Loading Data 
    79============ 
    8  
    9 Help is available on: 
    10  
    11 The_data_explorer_ 
    12  
    13 Loading_data_ 
    14  
    15 The_handy_menu_ 
    16  
    17 Activating_data_ 
    18  
    19 Removing_data_ 
    20  
    21 Creating_a_new_plot_ 
    22  
    23 Appending_plots_to_a_graph_ 
    24  
    25 Freezing_the_theory_ 
    26  
    27 Sending_data_to_applications_ 
    28  
    29 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    30  
    31 .. _The_data_explorer: 
    3210 
    3311The data explorer 
    … …  
    4624 
    4725.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    48  
    49 .. _Loading_data: 
    5026 
    5127Loading data 
    … …  
    6743.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    6844 
    69 .. _The_handy_menu: 
    70  
    7145The handy menu 
    7246-------------- 
    … …  
    7953 
    8054.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    81  
    82 .. _Activating_data: 
    8355 
    8456Activating data 
    … …  
    9567.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    9668 
    97 .. _Removing_data: 
    98  
    9969Removing data 
    10070------------- 
    … …  
    10777.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    10878 
    109 .. _Creating_a_new_plot: 
    110  
    11179Creating a new plot 
    11280------------------- 
    … …  
    11684 
    11785.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    118  
    119 .. _Appending_plots_to_a_graph: 
    12086 
    12187Appending plots to a graph 
    … …  
    136102.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    137103 
    138 .. _Freezing_the_theory: 
    139  
    140104Freezing the theory 
    141105------------------- 
    … …  
    147111 
    148112.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    149  
    150 .. _Sending_data_to_applications: 
    151113 
    152114Sending data to applications 
    … …  
    165127.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    166128 
    167 .. note::  This help document was last changed by Steve King, 30Apr2015 
     129.. note::  This help document was last changed by Steve King, 01May2015 

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

    r3fd3d5a4 ra9dc4eb  
    44.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 
    55 
     6.. _Formats: 
     7 
    68Data Formats 
    79============ 
    810 
    9 1D_Formats_ 
    10  
    11 2D_Formats_ 
    12  
    13 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    14  
    15 .. _1D_Formats: 
     11SasView reads several different 1D (I(Q) vs Q) and 2D (I(Qx,Qy) vs (Qx,Qy)) 
     12data files. But please note that SasView does not at present load data where 
     13the Q and I(Q) data are in separate files. 
    1614 
    17151D Formats 
    … …  
    4644http://www.isis.stfc.ac.uk/instruments/loq/software/colette-ascii-file-format-descriptions9808.pdf 
    4745 
    48 *NOTE! SasView does not at present load data where the Q and I(Q) data are in  
    49 separate files.* 
    50  
    5146.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    52  
    53 .. _2D_Formats: 
    5447 
    55482D Formats 
    … …  
    6760.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    6861 
    69 .. note::  This help document was last changed by Steve King, 18Feb2015 
     62.. note::  This help document was last changed by Steve King, 01May2015 

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

    r0cdf1af ra9dc4eb  
    1111==================== 
    1212 
    13 Help is available on: 
    14  
    15 Graph_window_options_ 
    16  
    17 Dataset_menu_options_ 
    18  
    19 2D_data_averaging_ 
    20  
    21 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    22  
    23 .. _Graph_window_options: 
    24  
    2513Graph window options 
    2614-------------------- 
    27  
    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_ 
    51  
    52 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    5315 
    5416.. _Invoking_the_graph_menu: 
    … …  
    6123Then select a menu item. 
    6224 
    63 .. _How_to_Hide-Show-Delete_a_graph: 
    64  
    6525How to Hide-Show-Delete a graph 
    6626^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
    … …  
    8343*NOTE! If a residuals graph (when fitting data) is hidden, it will not show up  
    8444after computation.* 
    85  
    86 .. _Dragging_a_plot: 
    8745 
    8846Dragging a plot 
    … …  
    9654To disable dragging mode, unselect the *crossed arrows* icon on the toolbar. 
    9755 
    98 .. _Zooming_In-Out_on_a_plot: 
    99  
    10056Zooming In-Out on a plot 
    10157^^^^^^^^^^^^^^^^^^^^^^^^ 
    … …  
    11773To return to the original view of the data, click the the *Reset* (home) icon  
    11874in the toolbar at the bottom of the plot (see Resetting_the_graph_ for further details). 
    119  
    120 .. _Saving_a_plot_image: 
    12175 
    12276Saving a plot image 
    … …  
    14397*  TIF/TIFF (tagged iamge file) 
    14498 
    145 .. _Printing_a_plot: 
    146  
    14799Printing a plot 
    148100^^^^^^^^^^^^^^^ 
    … …  
    159111Range* on the *Graph Menu* (see Invoking_the_graph_menu_). Alternatively, use 
    160112the *Reset* (home) icon in the toolbar at the bottom of the plot. 
    161  
    162 .. _Modifying_the_graph: 
    163113 
    164114Modifying the graph 
    … …  
    176126*  adding a grid overlay 
    177127 
    178 .. _Changing_scales: 
    179  
    180128Changing scales 
    181129^^^^^^^^^^^^^^^ 
    … …  
    203151levels, via a linear fit (see Making_a_linear_fit_). 
    204152 
    205 .. _Toggling_scales: 
    206  
    207153Toggling scales 
    208154^^^^^^^^^^^^^^^ 
    … …  
    214160selected is written alongside the colour scale. 
    215161 
    216 .. _2D_color_maps: 
    217  
    2181622D color maps 
    219163^^^^^^^^^^^^^ 
    … …  
    221165This menu option is only available with 2D data. 
    222166 
    223 From the *Graph Menu* (see Invoking_the_Graph_Menu_) select *2D Color Map* to  
     167From the *Graph Menu* (see Invoking_the_graph_menu_) select *2D Color Map* to 
    224168choose a different color scale for the image and/or change the maximum or  
    225169minimum limits of the scale. 
    226  
    227 .. _Getting_data_coordinates: 
    228170 
    229171Getting data coordinates 
    … …  
    235177.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    236178 
    237 .. _Dataset_menu_options: 
    238  
    239179Dataset menu options 
    240180-------------------- 
    241181 
    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  
    258182.. _Invoking_the_dataset_menu: 
    259183 
    … …  
    263187From the *Graph Menu* (see Invoking_the_graph_menu_) highlight a plotted 
    264188dataset. 
    265  
    266 .. _Getting_data_info: 
    267189 
    268190Getting data info 
    … …  
    273195data set. 
    274196 
    275 .. _Saving_data: 
    276  
    277197Saving data 
    278198^^^^^^^^^^^ 
    … …  
    283203 
    2842041D data can be saved in either ASCII text (.TXT) or CanSAS/SASXML (.XML)  
    285 formats (see :ref:`1D_Formats`). 
    286  
    287 2D data can only be saved in the NIST 2D format (.DAT) (see :ref:`2D_Formats`). 
     205formats (see :ref:`Formats`). 
     206 
     2072D data can only be saved in the NIST 2D format (.DAT) (see :ref:`Formats`). 
    288208 
    289209.. _Making_a_linear_fit: 
    … …  
    307227.. image:: guinier_fit.png 
    308228 
    309 .. _Removing_data_from_the_plot: 
    310  
    311229Removing data from the plot 
    312230^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
    … …  
    316234 
    317235*NOTE! This action cannot be undone.* 
    318  
    319 .. _Show-Hide_error_bars: 
    320236 
    321237Show-Hide error bars 
    … …  
    326242with the chosen dataset.  
    327243 
    328 .. _Modify_plot_properties: 
    329  
    330244Modify plot properties 
    331245^^^^^^^^^^^^^^^^^^^^^^ 
    … …  
    337251.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    338252 
    339 .. _2D_data_averaging: 
    340  
    3412532D data averaging 
    342254----------------- 
    343  
    344 Purpose_ 
    345  
    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_ 
    361  
    362 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    363  
    364 .. _Purpose: 
    365255 
    366256Purpose 
    … …  
    372262data. The region to be averaged is displayed in the plot window and its limits  
    373263can be modified by dragging the boundaries around. 
    374  
    375 .. _How_to_average: 
    376264 
    377265How to average 
    … …  
    411299To remove a 'slicer', bring back the *Dataset menu* and select *Clear Slicer*. 
    412300 
    413 .. _Unmasked_circular_average: 
    414  
    415301Unmasked circular average 
    416302^^^^^^^^^^^^^^^^^^^^^^^^^ 
    … …  
    419305pixel location of the beam center. 
    420306 
    421 .. _Masked_circular_average: 
    422  
    423307Masked circular average 
    424308^^^^^^^^^^^^^^^^^^^^^^^ 
    … …  
    427311masked region is excluded. 
    428312 
    429 .. _Sector_average: 
    430  
    431313Sector average [Q View] 
    432314^^^^^^^^^^^^^^^^^^^^^^^ 
    … …  
    437319of the central angle (|phi|\). 
    438320 
    439 .. _Annular_average: 
    440  
    441321Annular average [|phi| View] 
    442322^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
    … …  
    448328degrees at the 3 O'clock position. 
    449329 
    450 .. _Box_sum: 
    451  
    452330Box sum 
    453331^^^^^^^ 
    … …  
    457335When editing the slicer parameters, the user can enter the length and the width  
    458336the rectangular slicer and the coordinates of the center of the rectangle. 
    459  
    460 .. _Box_averaging_in_Qx: 
    461337 
    462338Box Averaging in Qx 
    … …  
    470346is, the central value of each bin on the x-axis. 
    471347 
    472 .. _Box_averaging_in_Qy: 
    473  
    474348Box Averaging in Qy 
    475349^^^^^^^^^^^^^^^^^^^ 
    … …  
    484358.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    485359 
    486 .. note::  This help document was last changed by Steve King, 30Apr2015 
     360.. note::  This help document was last changed by Steve King, 01May2015 
Note: See TracChangeset for help on using the changeset viewer.