Debian Codegraph @

docs/source/manual/Overview_of_RAW.rst

raw
1 Overview of RAW
2 ===============
3
4 **WARNING:** The manual is current several versions out of date. While it may
5 still be useful for some users, please refer to the tutorial for the most
6 up-to-date information.
7
8 The main screen of RAW shows three distinct panels: The Information Panel (top left),
9 the Control Panel (bottom left), and the Plot Panel (right). Additional windows that
10 can be shown are the Options window, and various Analysis windows. In addition, there
11 is a menu bar at the top of RAW (either in the RAW window or in the system menu bar,
12 depending on your operating system).
13
14
15 Any of the three panels docked in the main RAW window can be moved relative to the
16 other panels. To do this, click on the title bar of the panel, and drag the panel
17 to the desired location (you should see a blue rectangle indicating where the panel
18 will be put). Additionally, panels can be undocked from the main window by clicking
19 on the pin icon on the right side of the title bar of the panel. Undocked panels can
20 be re-docked with the main window using the same method as rearranging the panels,
21 drag the title bar until you see a blue rectangle appear indicating where the panel
22 will go.
23
24
25 The portion of the total area available for the left (information and control) and
26 right (plot) sides of RAW is controlled by the separator bar. You can click and drag
27 on this bar to change this ratio.
28
29
30 The main RAW window can be resized by clicking and dragging on a corner or edge.
31
32 The Control panel
33 -----------------
34
35 The control panel is where you manipulate files and items loaded into RAW. It has
36 four tabs: Files, Manipulation, IFT, and SEC. The Files tab is for viewing files
37 on the system disk, and loading the files into RAW. The Manipulation tab is for
38 working with individual scattering profiles, the IFT tab is for working with inverse
39 Fourier transforms, and the SEC tab is for working with SEC-SAXS data. You change
40 tabs just by clicking on them. The order of the tabs in the control panel can be
41 rearranged by clicking and dragging the tabs.
42
43 The Plot panel
44 --------------
45
46 .. _genplotpanel:
47
48 The plot panel contains four tabs: the Main Plot, IFT Plot, Image plot, and SEC
49 plot tabs. The Main Plot tab is for viewing individual scattering profiles. The
50 IFT Plot tab is for viewing inverse Fourier transforms, the Image plot tab is for
51 viewing detector images, and the SEC plot tab is for viewing SEC-SAXS data. The
52 order of the tabs can be changed by clicking and dragging.
53
54
55 Multiple different plot tabs can be displayed at the same time. Click and drag the
56 tab to any edge of the Plot Panel (up, down, left, or right) and you should see a
57 blue box appear indicating where the tab will go. Additional splits after the
58 first can be accomplished by dragging other tabs, and tabs can be moved between
59 different tab bars (in this case, you should see the bar light up blue, rather
60 than a full blue box for the panel). The amount of screen occupied by the different
61 plots can be set by clicking and dragging the separator bars. To recombine, drag all
62 of the plot tabs into a single bar.
63
64
65 *Navigation/control bar*
66
67 .. _navbar:
68
69 Each Plot tab has a navigation/control bar on the bottom. Most navigation bars have
70 some unique buttons, but they all share the following buttons:
71
72 |10000000000000210000002267AFAB5BBBEB8688_png|
73
74 Home. Zoom the to fit all the displayed data.
75
76 Move back and fourth in the zoom history.
77
78 |1000000000000023000000229179FE499099E336_png|
79
80 |1000000000000023000000229179FE499099E336_png|
81
82
83 Pan/Zoom. Click and drag the left mouse button to pan and the right mouse button to zoom.
84
85 |1000000000000023000000229BAB0E7642366178_png|
86
87
88 |10000000000000230000002174F1BA52DF6B9C53_png|
89
90 Area Zoom. Click and drag to zoom to the selected area.
91
92 |100000000000001F0000001F9C07D19476FF080E_png|
93
94 White-space settings. Ability to adjust the white-space around the plots.
95
96
97 |100000000000001C0000001F02670C0CCE6242ED_png|
98
99 Image save. Ability to save the displayed plot(s) in formats such as .png, .svg, .eps,
100 .pdf and more.
101
102
103 *Cursor readout*
104
105 Every plot has a cursor readout. If the mouse is hovering over a position on the plot,
106 the coordinates (x-axis and y-axis values) will read out in the bottom bar of RAW. For
107 the image plot, the intensity at those coordinates is also displayed. For the SEC plot,
108 the value of the secondary y-axis is also displayed.
109
110
111 *Plot settings*
112
113 For each of the Main Plot, IFT Plot, and SEC plot, one of the options in the right-click
114 menu is “Plot Options”. Selecting this will open a window that allows you to set:
115
116 * Plot title, x-axis label, and y-axis label text, font size, and bold/italicization
117
118 * Legend title, font size, and bold/italication
119
120 * Whether the legend is visible (default: no)
121
122 * Legend font size, transparency, border, and shadow
123
124 * Turn auto limits on/off for the Axes and manually set the axes limits if desired
125
126 * Turn off the left/right/top/bottom plot borders
127
128 * Turn on a line at y = 0 (the Zero Line)
129
130 * Adjust the axes tick label font sizes
131
132
133 The axis labels and title will accept some LaTeX commands if they are placed between
134 $ symbols, for example: $\\int I(q)$ will display as :math:`\int I(q)`. The bold and
135 italic options will not change LaTeX text.
136
137 The settings will be changed for the plot/subplot that was clicked on.
138
139 The Information panel
140 ---------------------
141
142 The information panel displays information about a selected data item in the Manipulation
143 panel. It will show, if available, the Rg, I(0), and MW. It provides a place to enter the
144 sample concentration, description/notes about the sample, and quickly look at the different
145 header values of the data item.
146
147 If the current Control panel is changed from the Manipulation panel to the IFT or SEC panel,
148 the Information panel is cleared. If the panel is changed back to the Manipulation panel,
149 the data in the Information panel are restored.
150
151 The Options window
152 ------------------
153
154 The options panel is opened by clicking on the Options->Advanced Options menu item. This
155 opens a separate window where many of the RAW settings can be viewed/changed. The panel
156 has two pieces. On the left is the set/category of options, and on the right the actual
157 options panel. For example, if you click on the General Settings section in the left panel,
158 the general settings will be displayed on the right.
159
160 Note that in the options tree on the left, the triangles can be used to expand/collapse more
161 options for many of the categories.
162
163 Once you have changed the settings, you simply need to click “OK” and they will be saved
164 in memory. In some cases you may want to set the options without exciting the panel. To
165 do this, click “Apply”. To exit without saving any changes click “Cancel”.
166
167 Analysis windows
168 ----------------
169
170 Various analysis windows can be opened in RAW. These will be discussed in detail
171 :ref:`later <analysiswindows>`.
172
173 Menus
174 -----
175
176 The top menu bar of RAW contains the File, Options, View, Tools, and Help menu. The View
177 and Tools menu are simply another way to access options found elsewhere, while the File,
178 Options, and Help menu have items that cannot otherwise be accessed. These will be discussed
179 :ref:`later <menus>`.
180
181
182 .. |10000000000000230000002174F1BA52DF6B9C53_png| image:: images/10000000000000230000002174F1BA52DF6B9C53.png
183
184
185 .. |100000000000001F0000001F9C07D19476FF080E_png| image:: images/100000000000001F0000001F9C07D19476FF080E.png
186
187
188 .. |100000000000001C0000001F02670C0CCE6242ED_png| image:: images/100000000000001C0000001F02670C0CCE6242ED.png
189
190
191 .. |1000000000000023000000229BAB0E7642366178_png| image:: images/1000000000000023000000229BAB0E7642366178.png
192
193
194 .. |1000000000000023000000229179FE499099E336_png| image:: images/1000000000000023000000229179FE499099E336.png
195
196
197 .. |10000000000000210000002267AFAB5BBBEB8688_png| image:: images/10000000000000210000002267AFAB5BBBEB8688.png
198