Debian Codegraph @

docs/source/manual/The_IFT_Control_Panel_and_IFT_Plot_Panel.rst

raw
1 The IFT Control Panel and IFT Plot Panel
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 .. _iftpanel:
9
10 When inverse Fourier transforms (P(r) functions) are loaded into RAW or generated
11 by BIFT or GNOM in RAW, they are placed in the IFT tab of the Control Panel, and
12 displayed in the IFT Plot window. This section will cover the features of the IFT
13 control panel and IFT plot panel.
14
15
16 The IFT control panel
17 ---------------------
18
19 The IFT control panel refers to the panel that is shown in the Control panel
20 when the IFT tab is selected.
21
22 The panel consists of two parts. The top part is where individual IFT items loaded
23 into RAW are shown. The bottom part consists of buttons that allow you to save or
24 remove those IFT items. Further manipulation of the IFT items can be done from the
25 right click (context) menu and from the Tools menu.
26
27 An individual item in the IFT list is called an IFT data item. It is associated
28 with a P(r) function, the scattering profile used to generate that P(r) function,
29 and the scattering profile generated from the P(r) function.
30
31 All items loaded into the IFT panel have a P(r) function displayed in the top plot
32 of the IFT Plot window, and an experimental scattering profile and a scattering profile
33 from the P(r) function displayed in the bottom plot of the IFT Plot window.
34
35
36 IFT Data Items
37 ~~~~~~~~~~~~~~
38
39 When a new item is plotted, a data item is added to the IFT list in the IFT tab.
40 This allows you to control the properties of the data item, and perform analysis on it.
41
42 The name of the data item is displayed for each item. If an item is given a different
43 name for the plot legend, this legend name is displayed in [square brackets] next to the
44 item name. On the same line as the item name, on the right side of the data item, there
45 are several buttons that can be used for :ref:`further manipulation <iftitembuttons>`
46 of the data item.
47
48 **Note:** If there is a \* to the left of the item name (between the checkbox and the
49 item name), it indicates there are unsaved changes to the item. This can occur if the
50 item is newly created IFT data (such as from the BIFT or GNOM panels), or if item properties
51 such as the name have been changed.
52
53
54 Showing/Hiding data items on the IFT plot
55 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56
57 To show/hide all of the curves (P(r), experimental data, scattering profile from P(r) curve)
58 associated with a data item on the plot, click the checkbox next to the filename. If the checkbox
59 is checked, the item is currently shown on the IFT plot, if the checkbox is unchecked, the item
60 is currently hidden on the IFT plot.
61
62
63 Data item buttons
64 ~~~~~~~~~~~~~~~~~
65
66 .. _iftitembuttons:
67
68 On the right of the data are a series of buttons for controlling the data item. In order of
69 left to right, these buttons have the following properties.
70
71 *Locate Line*
72
73 The target button is used to highlight the scattering profile on the graph that is associated
74 with the data item. When the target is pressed, it ‘bolds’ the line each plotted curve associated
75 with the data item (increases the line width by several points). When the target is pressed again,
76 the line width is set back to normal. You can tell if a line is currently bolded, as the target
77 will be orange instead of grey.
78
79 *Line Properties*
80
81 The colored line button has two purposes. First, the color matches the current color of the
82 P(r) function in the IFT Plot. Second, when pressed it opens a
83 :ref:`line properties dialog <lineproperties>` which allows you to set the legend label;
84 the line style, width, and color; the data point marker style, size, line color, and fill
85 color; and the error bar line style, width, and color for each line associated with the IFT data item.
86
87
88 Selecting data items
89 ~~~~~~~~~~~~~~~~~~~~
90
91 A single data item can be selected by clicking on the item name in the IFT list (similar to
92 how you would select files in your system file browser). When an item is selected, the color
93 of the item background changes from white to gray. If the item is currently selected, clicking
94 on it will cause it to be unselected. Note that for a regular click, all other selected items
95 will be unselected when a new item is selected.
96
97 Multiple items may be selected in two ways. If the Control key (Command key on Macs) is held
98 down while clicking on items, each item that is clicked on will be added to the set of selected
99 items. If a single item is first selected and then the Shift key is held down and another item
100 is selected, all of the items in the list between the two items will be selected (including the
101 second item that is clicked on).
102
103 All of the items in the list can be selected in two ways. The first is using the
104 :ref:`select all <iftselectall>` button, the second is pressing Ctrl-A (Cmd-A),
105 the Control (Command) key and the A key at the same time when you are in the IFT panel.
106 All items can be unselected by clicking in an empty spot of the IFT list (but not above
107 or below the list), or by clicking on an already selected item.
108
109 **Note:** If you have a set of selected items and wish to remove some, holding down the Control
110 (Command) key and clicking on selected items will deselect them without affecting the other selected
111 items.
112
113
114 The top buttons of the IFT Panel
115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
116
117 The IFT Panel has a set of three buttons at the top of the panel. These buttons have the following
118 effects, listed from left to right.
119
120 *Show All*
121
122 Clicking on the button that looks like an eye will show all IFT items. This is the same as if you
123 manually set all of the show/hide checkboxes in the data items to on.
124
125 *Hide All*
126
127 Clicking on the button that looks like an eye with a red x through it will hide all IFT items.
128 This is the same as if you manually set all of the show/hide checkboxes in the data items to off.
129
130 *Select All*
131
132 .. _iftselectall:
133
134 Clicking on the button that looks like a spreadsheet with selected cells will select all of the
135 IFT data items.
136
137
138 Renaming a data item
139 ~~~~~~~~~~~~~~~~~~~~
140
141 .. _renameiftitem:
142
143 Data items can be renamed by selecting the data item of interest and selecting “Rename” in the right
144 click popup menu.
145
146 **Note:** While no characters are expressly forbidden in the filename, RAW does not sanitize file names
147 before saving, and thus special characters such as ‘/’ and ‘\\’ are likely to cause problems when the
148 file is saved.
149
150
151 Saving data items
152 ~~~~~~~~~~~~~~~~~
153
154 .. _savingiftdata:
155
156 IFT items are saved in two different formats, depending on whether the item was generated by BIFT
157 (“.ift”) or GNOM (“.out”). The procedure to save either is the same. To save:
158
159 #. Select the item(s) to be saved.
160
161 #. Click the “Save” button or select “Save selected file(s)” from the right click menu.
162
163 #. In the window that pops up, navigate to the directory in which you want to save the files.
164
165 #. If you are saving a single item, the window will give you an opportunity to rename your file
166 if desired. Click “Save” when ready.
167
168 #. If you are saving multiple items, you simply need to select the folder for the items to be saved
169 in, and click “Open”. The items will be saved with the same names displayed in the IFT Panel, in
170 the folder that you chose.
171
172 BIFT items are saved as “.ift” files, which is a text file with RAW specific formatting of the text.
173 The first two lines are “BIFT” and the “Filename: <filename>”. After that, the P(r) function is saved
174 as 3 column data. The first column is “R”, the second column is “P(R)” and the third column is “Error”,
175 these headers are included as the third line of the file. After the P(R) function there are two blank
176 lines, followed by the scattering data. This is saved in four columns, the first three are “Q”, “I(q)”
177 and “Error” which correspond to the experimental data, while the fourth column is “Fit” which is the
178 scattering profile from the P(r) function. After this data is written there is a “header” written, which
179 consists of the Chisquared, algorithm used, I(0) value, log base 10 of the alpha value, Dmax, Rg, and the
180 filename, all saved in JSON format. The files are simply text files, and can be opened and viewed in any
181 standard text editor.
182
183 GNOM items are saved in the standard “.out” format. This is described in the ATSAS manual for GNOM.
184 These files can be directly input into any ATSAS (or other) program that requires a GNOM .out file as input.
185
186
187 Removing data items from the IFT list
188 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
189
190 .. _removeift:
191
192 To remove one or more data items, select them and do one of the following:
193
194 #. Press the “Delete” key on the keyboard
195
196 #. Click the “Remove” button
197
198 #. Select “Remove” from the right click menu
199
200
201 Sending data to the main plot
202 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
203
204 .. _ifttomainplot:
205
206 If you wish to examine the experimental scattering profile and fit to this profile from
207 the P(r) function more closely, the data can be sent to the main plot. To do this, right
208 click on the IFT data item and select “To Main Plot”. This will plot items on the Main plot
209 and add them to the Manipulation list.
210
211 For a “.ift” file generated by BIFT, the following items will be added to the Manipulation list
212 and Main plot. In all cases, <filename> corresponds to the filename of the IFT data item without
213 the extension (so “my_ift”.ift would have a filename of “my_ift”).
214
215 <filename>_data – This is the experimental data that was used to generate the P(r) curve.
216
217 <filename>_fit – This is the scattering profile generated from the P(r) curve.
218
219 For a “.out” file generated by GNOM, the same two curves as for a BIFT item (above) are sent to the
220 main plot, there is also one additional file.
221
222 <filename>_extrap – This is the scattering profile generated from the P(r) curve, extrapolated to q=0.
223
224
225 Running DAMMIF on the P(r) function
226 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
227
228 RAW allows you to run DAMMIF on a P(r) function from within RAW. Currently, this can only be
229 done on P(r) items generated by GNOM (these can be generated in RAW, or loaded in after being
230 generated outside of RAW). To run DAMMIF, select an appropriate IFT data item (a “.out” item),
231 and either right click and select the “Run DAMMIF” option or from the Tools->ATSAS menu select
232 “DAMMIF”. This opens the :ref:`DAMMIF window <dammifwindow>`.
233
234
235 Running AMBIMETER on the P(r) function
236 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
237
238 RAW allows you to run AMBIMETER on a P(r) function from within RAW. Currently, this can only
239 be done on P(r) items generated by GNOM (these can be generated in RAW, or loaded in after
240 being generated outside of RAW). To run AMBIMETER, select an appropriate IFT data item (a
241 “.out” item), and either right click and select the “Run AMBIMETER” option or from the
242 Tools->ATSAS menu select “AMBIMETER”. This opens the :ref:`AMBIMETER window <ambimeterwindow>`.
243
244
245 Data point browsing
246 ~~~~~~~~~~~~~~~~~~~
247
248 .. _showiftdata:
249
250 Each individual point of the r; P(r); error in P(r); experimental q, I(q), and error;
251 I(q) from the P(r) function; and, for GNOM generated IFT data items, the q and I(q)
252 values extrapolated to q=0 vectors; can be inspected using the data browser. To do so:
253
254 #. Right-click on the data item of interest.
255
256 #. Select “Show data” in the popup menu.
257
258
259 The IFT data item right click menu options
260 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
261
262 When you right click on a data item, a popup menu is shown. This section describes what each
263 item on the menu does.
264
265 *Remove*
266
267 :ref:`Removes the item <removeift>`.
268
269 *To Main Plot*
270
271 This :ref:`sends the scattering profile data to the main plot <ifttomainplot>`.
272
273 *Run DAMMIF*
274
275 This item is only available for “.out” files generated by GNOM. It opens the
276 :ref:`DAMMIF window <dammifwindow>`.
277
278 *Run AMBIMETER*
279
280 This item is only available for “.out” files generated by GNOM. It opens the
281 :ref:`AMBIMETER window <ambimeterwindow>`.
282
283 *SVD*
284
285 Opens the singular value decomposition (SVD) analysis panel for the selected scattering
286 profiles (must have at least 2 items selected).
287
288 *EFA*
289
290 Opens the evolving factor analysis (EFA) panel for the selected scattering profiles
291 (must have at least 2 items selected).
292
293 *Show data*
294
295 Shows the :ref:`individual data points <showiftdata>`.
296
297 *Rename*
298
299 :ref:`Renames <renameiftitem>` the data item,
300
301 *Save selected file(s)*
302
303 :ref:`Saves the selected data item(s) <savingiftdata>`.
304
305
306 The IFT panel bottom buttons
307 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
308
309 There are three buttons at the bottom of the IFT control panel. They are:
310
311 *Save*
312
313 This button :ref:`saves the selected data item(s) <savingiftdata>`.
314
315 *Remove*
316
317 This button :ref:`removes the selected data item(s) <removeift>` from the IFT panel.
318
319 *Clear IFT Data*
320
321 This button clears all loaded IFT data. It works the same as if you had selected all of
322 the IFT data items and then removed them.
323
324
325 The IFT Plot window
326 -------------------
327
328 The IFT Plot window displays P(r) data (top plot), the scattering profiles generated from
329 the P(r) data (bottom plot), and the experimental scattering profile used to generate the
330 P(r) data (bottom plot). Each set of three curves is associated with a single IFT data item
331 in the IFT control panel. The two subplots are the Pair Distance Distribution Function (top)
332 and Data/Fit (bottom) plots.
333
334 The features that are general between all of the plots are described :ref:`elsewhere <genplotpanel>`.
335 This section will describe features unique to this plot.
336
337
338 Changing axes and plot types
339 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
340
341 Right-click in the Data/Fit (top) plot to view a pop-up menu with different axis settings.
342
343 The available plot modes are:
344
345 * Lin-Lin
346
347 * Log-Lin
348
349 * Log-Log
350
351 * Lin-Log
352
353 * Guinier plot (ln(I(q)) vs. q\ :sup:`2`\ )
354
355 * Porod plot (q\ :sup:`4`\ I(q) vs. q)
356
357 * Kratky plot (q\ :sup:`2`\ I(q) vs. q)
358
359 The axes cannot be changed for the P(r) (top) plot.
360
361
362 The IFT plot toolbar
363 ~~~~~~~~~~~~~~~~~~~~
364
365 In addition to the plot toolbar buttons :ref:`shared by all of the plots <navbar>`, the
366 IFT plot has the following buttons:
367
368 |100000000000002200000021727FD1590D192861_png|
369
370 Toggle errorbars. Shows the error bars on the plotted curves.
371
372 |100000000000001F00000021D9FCD008A5DADBD2_png|
373
374 Top/Bottom plot. Shows both the top and the bottom plot.
375
376 |100000000000001F00000020F81C3AA753AFD388_png|
377
378 Top plot. Shows only the top plot.
379
380 |1000000000000022000000213F375FFE6DB9D8A9_png|
381
382 Bottom plot. Shows only the bottom plot.
383
384
385 .. |100000000000001F00000020F81C3AA753AFD388_png| image:: images/100000000000001F00000020F81C3AA753AFD388.png
386
387
388 .. |100000000000001F00000021D9FCD008A5DADBD2_png| image:: images/100000000000001F00000021D9FCD008A5DADBD2.png
389
390
391 .. |1000000000000022000000213F375FFE6DB9D8A9_png| image:: images/1000000000000022000000213F375FFE6DB9D8A9.png
392
393
394 .. |100000000000002200000021727FD1590D192861_png| image:: images/100000000000002200000021727FD1590D192861.png
395