source: sasview/src/sas/guiframe/media/data_explorer_help.rst @ 6bd3a8d1

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 6bd3a8d1 was 2bf5e3b, checked in by smk78, 10 years ago

Proof read.

  • Property mode set to 100644
File size: 4.3 KB
RevLine 
[23a9beb]1.. data_explorer_help.rst
[0d66541]2
[78f02c3]3.. This is a port of the original SasView html help file to ReSTructured text
4.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
5
[37bbd5f]6Loading Data
7============
8
[23a9beb]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_
[3e2ebbb]26
[78f02c3]27.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
[3e2ebbb]28
[78f02c3]29.. _Introduction:
[3e2ebbb]30
[78f02c3]31Introduction
32------------
[23a9beb]33
[78f02c3]34*Data Explorer* is a panel that allows the user more interactions with data.
[c147870]35Some functionalities provided by the *Data Explorer* are also available through
36the context menu of plot panels or other menus within the application.
[78f02c3]37
[c147870]38Under *View* in the menu bar, *Data Explorer* can be toggled between Show and
39Hide by clicking *Show/Hide Data Explorer*.
40
[2bf5e3b]41*NOTE! When* Data Explorer *is hidden, all data loaded will be sent directly
42to the current active application, if possible. When* Data Explorer *is
43shown, data go first to the* Data Explorer.
[78f02c3]44
45.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
46
[23a9beb]47.. _Load_Data:
[78f02c3]48
49Load Data
50---------
51
[c147870]52To load data, click the button *Load Data*, then select one or more (by holding
53the Ctrl key) files to load into the application. The name of each selected
[2bf5e3b]54file will be listed.
55
56Clicking the *+*  symbol will display any available metadata.
[78f02c3]57
58.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
59
[23a9beb]60.. _Handy_Menu:
[78f02c3]61
62Handy Menu
63----------
64
[c147870]65Right-clicking on a loaded dataset (or model calculation, what SasView calls a
[2bf5e3b]66theory) brings up a *Handy Menu* from which it is possible to access Datainfo,
[c147870]67Save the data/theory, or Plot the data/theory.
[3e2ebbb]68
[23a9beb]69.. image:: hand_menu.png
[3e2ebbb]70
[78f02c3]71.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
[3e2ebbb]72
[23a9beb]73.. _Activate_Data:
[78f02c3]74
75Activate Data
76-------------
77
[c147870]78To interact with data it must be activated. This is accomplished by checking
79the box next to the data label. A green tick will appear.
80
81Unchecking/unticking the box deactivates a data set.
[78f02c3]82
[c147870]83There is also a combo box labeled *Selection Options* from which you can
84activate or deactivate multiple data sets.
[78f02c3]85
86.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
[3e2ebbb]87
[23a9beb]88.. _Remove_Data:
[78f02c3]89
90Remove Data
91-----------
[3e2ebbb]92
[2bf5e3b]93*WARNING!* Remove Data *will stop any data operations currently using the
94selected data sets.*
[3e2ebbb]95
[c147870]96*Remove Data* removes all reference to selected data from the application.
[3e2ebbb]97
[78f02c3]98.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
[3e2ebbb]99
[23a9beb]100.. _Append_Plot_to_Graph:
[3e2ebbb]101
[78f02c3]102Append Plot to Graph
103--------------------
104
[2bf5e3b]105This operation can only be performed on 1D data and plot panels currently
106containing 1D data.
107
[c147870]108Click on the button *Append To* to add selected data to a plot panel. Next to
109the button is a combo box containing the names of available plot panels.
110Selecting a name from this combo box will move that plot into focus.
111 
112If a plot panel is not available, the combo box and button will be
113disabled.
114
[2bf5e3b]1152D Data cannot be appended to any plot panels.
[78f02c3]116
117.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
118
[23a9beb]119.. _Create_New_Plot:
[78f02c3]120
121Create New Plot
122---------------
123
[c147870]124Click on the *New Plot* button to create a new plot panel where the currently
125selected data will be plotted.
[3e2ebbb]126
[78f02c3]127.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
128
[23a9beb]129.. _Freeze_Theory:
[78f02c3]130
131Freeze Theory
132-------------
133
[c147870]134The *Freeze Theory* button generates data from the selected theory.
135
[2bf5e3b]136*NOTE! This operation can only be performed when theory labels are selected.*
[78f02c3]137
138.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
139
[23a9beb]140.. _Send_Data_to_Applications:
[78f02c3]141
142Send to Application
143-------------------
[3e2ebbb]144
[c147870]145Click on the button *Send To* button to send the currently selected data to
146a perspective (for *Fitting*, *P(r) Inversion*, or *Invariant* calculation).
147 
148The *Single*/*Batch* mode radio buttons only apply to the *Fitting* perspective.
149
150*Batch mode* provides serial (batch) fitting with one model function, that is,
151fitting one data set followed by another. If several data sets need to be
152fitted at the same time, use *Simultaneous* fitting under the *Fitting* 
153option on the menu bar.
[2bf5e3b]154
155.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
156
157.. note::  This help document was last changed by Steve King, 18Feb2015
Note: See TracBrowser for help on using the repository browser.