Debian Codegraph @

docs/source/manual/Analysis_windows.rst

raw
1 Analysis windows
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 .. _analysiswindows:
9
10 There are a variety of analysis windows in RAW: the Guinier Fit window, the Molecular
11 Weight window, the BIFT window, the GNOM window, the AMBIMETER window, the DAMMIF window,
12 the SVD window, and the EFA window. In this chapter we will cover how to open these windows
13 and carry out the analysis.
14
15 |100000000000032600000272911687F043FA6AEB_png|
16
17
18 Guinier Fit window
19 ------------------
20
21 .. _guinierwindow:
22
23 Data that has been properly background subtracted can be analyzed in the standard
24 fashion via a Guinier Fit to yield the radius of gyration and the scattering intensity
25 at zero angle. The Guinier Fit window allows you to interactively do the fit.
26
27
28 Opening the Guinier fit window
29 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30
31 The Guinier fit window can be opened by selecting a data item in the Manipulation Panel
32 and either right clicking and selecting “Guinier fit” or selecting “Guinier fit” from
33 the “Tools” menu. Whichever data item is selected will be the one that is being analyzed.
34 If multiple items are selected, the first (top item in the list) will be sent to the
35 Guinier Fit panel.
36
37 Once the window opens you will see two panels. The left panel has the filename of the data
38 loaded into the Guinier Fit panel, the fit parameters, and the fit controls. The right panel
39 has two plots that show the fit and residual. If no previous Guinier fit analysis has been
40 saved for the data item, the fit range defaults to the whole scattering profile. If a previous
41 Guinier fit analysis was saved for the data item, the fit range will be the range of that analysis.
42
43 Once you have completed a satisfactory Guinier fit, clicking the “OK” button will save the fit
44 for the data item selected. That will allow you to save the Guinier analysis parameters when
45 :ref:`saving all results <saveresults>`, view the results in the information window, and save it with
46 the scattering profile if that is saved as a “.dat” file. Clicking the “Cancel” button (or
47 the close window button from the operating system, typically in the upper left or right corner)
48 will exit the window without saving the analysis results.
49
50 **Note 1:** Only one Guinier Fit window can be open at once. If a window is already open and
51 you try to open a new one, it will close the current window and open a new one.
52
53 **Note 2:** RAW will automatically attempt to automatically determine the Rg when the Guinier
54 window is opened, if no previous Guinier fit has been done. If a previous Guinier fit has
55 been done, RAW will set the q min and q max to the previous values.
56
57
58 Guinier Fit Controls
59 ~~~~~~~~~~~~~~~~~~~~
60
61 The Guinier Fit Controls allow you to manually set the q_min and q_max values over which the
62 Guinier fit is done. You can do this in two ways. First, if you type a value into the q_min
63 or q_max box and hit enter, RAW will find the nearest q point, and set the q value to that
64 nearest point. Second, you can adjust the n_min and n_max values either by typing an integer
65 value in the appropriate box or using the spin controls. The n_min and n_max controls change
66 the minimum and maximum points of the q vector used (zero indexed), and the q_min and q_max
67 are updated to match. For example if n_min is set to 5 and n_max is set to 130, the 5th
68 indexed point through the 130th indexed point in the q vector (so points 6-131, because of the
69 zero indexing) will be used in the Guinier fit.
70
71 The AutoRG button calls a function that attempts to automatically determine the best range of
72 data to use for the Guinier fit. It considers the following criteria: q_min*Rg as small as possible,
73 q_max*Rg as close to 1.3 as possible, smallest fit error in the Rg, smallest fit error in
74 the I(0) possible, r^2 of the fit as close to one as possible, and the largest range of q
75 values used as possible.
76
77
78 Guinier Fit Plots
79 ~~~~~~~~~~~~~~~~~
80
81 There are two plots in the Guinier fit window. The top plot is the standard Guinier plot,
82 ln(I(q)) vs. q\ :sup:`2`\ , shown in the range of n_min -20 to n_max +3 (if possible)
83 as set in the Guinier Control panel. The scattering profile is marked by the blue points,
84 the fit is shown as the solid straight red line, the fit extrapolated to q=0 is shown
85 by the green dashed line, and the range of the fit, q_min and q_max, are shown by vertical
86 red dashed lines.
87
88 The bottom plot has the residual between each point in the scattering profile and the fit,
89 plotted as :math:`\Delta ln(I(q))` vs. q\ :sup:`2`\ . The red line is a line at zero. Note that the
90 x range of this plot may be slightly reduced compared to the top plot, as it only displays
91 the fit, while the top plot can display points beyond the limits of the fit.
92
93 **Note:** There are no controls available on right click for these plots, but there is a
94 standard :ref:`plot control bar <navbar>`.
95
96
97 Guinier Fit Parameters
98 ~~~~~~~~~~~~~~~~~~~~~~
99
100 The fit parameters available in the Guinier Fit window are:
101
102 * I(0), the extrapolated scattering intensity at zero angle
103
104 * Rg, the radius of gyration
105
106 * r\ :sup:`2`\ (fit), the r\ :sup:`2`\ value of the fit
107
108 * qRg, which is q_min*Rg and q_max*Rg for the left and right boxes respectively.
109
110
111 Molecular weight
112 ----------------
113
114 .. _molweightwindow:
115
116 Data that has been background subtracted and had a Guinier fit carried out can
117 be analyzed to find the molecular weight of the macromolecule. RAW provides four
118 different ways of calculating the molecular weight, which are described below.
119
120
121 Opening the Molecular Weight Window
122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123
124 The Molecular Weight window can be opened by selecting a data item in the
125 Manipulation Panel and either right clicking and selecting “Molecular Weight”
126 or selecting “Molecular Weight” from the “Tools” menu. Whichever data item is
127 selected will be the one that is being analyzed. If multiple items are selected,
128 the first (top item in the list) will be the one analyzed.
129
130 The window has two parts. The top part is a description of the MW methods and
131 a panel with the Guinier fit parameters. The bottom part is four panels providing
132 the calculated MW from each method, and the ability to see more details and learn
133 more about each method. All of the MW methods require a Guinier fit to have been
134 done, as they rely on the I(0) value. Two of the methods require knowing the sample
135 concentration, and the same two methods also depend on (different) calibration of
136 the scattering profile.
137
138 Once you are satisfied with the molecular weight analysis, clicking the “OK” button
139 will save the analysis for the data item selected. That will allow you to save the
140 molecular weight analysis parameters when :ref:`saving all results <saveresults>`, view the results
141 in the information window, and save the results with the scattering profile if that is
142 saved as a “.dat” file. Clicking the “Cancel” button (or the close window button from
143 the operating system, typically in the upper left or right corner) will exit the window
144 without saving the analysis results.
145
146 **Note:** Only one molecular weight window can be open at once. If a window is
147 already open and you try to open a new one, it will close the current window and
148 open a new one.
149
150
151 The molecular weight controls
152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153
154 There are several controls available in the molecular weight panel. In the top panel,
155 the Guinier Fit button can be used to open the Guinier panel and (re)analyze the
156 scattering profile using that method, so that an I(0) value is available for the
157 molecular weight panel.
158
159 Each of the four lower panels has a “Show Details” and “More Info” button. The “More
160 Info” button simply provides an extended description of the method used, and, when
161 relevant, a citation. The “Show Details” button provides extended information on the
162 parameters used to calculate the MW for a given method. None of these parameters are
163 editable in the molecular weight panel. When the “Show Details” button is clicked, it
164 becomes a “Hide Details” button, which hides the extra parameters.
165
166 The concentration box in both the first and fourth panels can have the sample concentration
167 entered, if it has not already been (for example, in the Information panel). These are
168 linked, so that any change to one also changes the other. Sample concentration should be in mg/ml.
169
170 The volume of correlation method uses different parameters for Proteins and RNA,
171 and the drop down menu can be used to toggle between those two sets of parameters.
172 The default setting can be changed in the Options window.
173
174 If RAW is set to normalize scattering profiles to an absolute scale, the “Intensity
175 on Absolute Scale” box will be checked in the fourth panel. If RAW is not normalizing
176 to an absolute scale, it will be unchecked. If that is set incorrectly for a particular
177 scattering profile for some reason, it can be manually toggled to the correct position.
178
179 At the bottom of the window there are three buttons. The “OK” and “Cancel” buttons
180 have been described above. The “Change Advanced Parameters” button opens the Options
181 window, with the Molecular Weight section shown. This allows you to change the
182 parameters used to calculate the molecular weight for each method of calculation.
183
184
185 The molecular weight parameters
186 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
187
188 There are a number of parameters listed in the molecular weight panel. In the top panel there are:
189
190 *Filename*
191
192 Gives the filename of the data item being analyzed.
193
194 *Guinier parameters*
195
196 Gives the I(0) and Rg from the Guinier fit.
197
198 In the I(0) Ref. MW panel there are:
199
200 *Concentration*
201
202 The sample concentration in mg/ml, this field accepts input.
203
204 *MW*
205
206 The sample MW calculated by this method, in kDa.
207
208 *Ref. I(0)*
209
210 The I(0) of the molecular weight standard set for RAW. This field corresponds
211 to the I(0) field in the “Molecular Weight Estimation Using a Standard” box in
212 the Molecular Weight section of the Options window, and can be changed there or
213 by :ref:`setting the MW standard <mwstandard>`.
214
215 *Ref. MW*
216
217 The molecular weight of the molecular weight standard set for RAW. This field
218 corresponds to the MW field in the “Molecular Weight Estimation Using a Standard”
219 box in the Molecular Weight section of the Options window, and can be changed there
220 or by :ref:`setting the MW standard <mwstandard>`.
221
222 *Ref. Concentration*
223
224 The concentration of the molecular weight standard set for RAW. This field
225 corresponds to the Conc. field in the “Molecular Weight Estimation Using a
226 Standard” box in the Molecular Weight section of the Options window, and can
227 be changed there or by :ref:`setting the MW standard <mwstandard>`.
228
229 *File*
230 – The data item name of the molecular weight standard set for RAW. This field
231 corresponds to the Filename field in the “Molecular Weight Estimation Using a
232 Standard” box in the Molecular Weight section of the Options window, and can
233 be changed there or by :ref:`setting the MW standard <mwstandard>`.
234
235 In the Vc MW panel there are:
236
237 *MW*
238
239 The sample molecular weight calculated by this method, in kDa.
240
241 *Vc*
242
243 The volume of correlation calculated by this method, in Å\ :sup:`2`\ .
244
245 *Qr*
246
247 The Qr parameter calculated by this method, in Å\ :sup:`3`\ .
248
249 *a*
250
251 The macromolecular type (protein/RNA) dependent “a” parameter used for the
252 calculation. This field corresponds to the “Protein (RNA) Coef. A” field
253 in the “Molecular Weight Estimation From Volume of Correlation” box in the
254 Molecular Weight section of the Options window, and can be changed there.
255 The value depends on whether Protein or RNA is selected in the drop down
256 menu at the top of this panel.
257
258 *b*
259
260 The macromolecular type (protein/RNA) dependent “b” parameter used for the
261 calculation. This field corresponds to the “Protein (RNA) Coef. B” field in
262 the “Molecular Weight Estimation From Volume of Correlation” box in the Molecular
263 Weight section of the Options window, and can be changed there. The value
264 depends on whether Protein or RNA is selected in the drop down menu at the
265 top of this panel.
266
267 This panel also has a plot which shows :math:`\int q I(q) dq` vs. q, over
268 the q-range of the scattering profile. For this method to be accurate, the
269 integral value needs to have converged at high q (the graph needs to be flat
270 at high q).
271
272 In the Vp MW panel there are:
273
274 *MW*
275
276 The sample molecular weight calculated by this method, in kDa.
277
278 *Vp*
279
280 The Porod volume calculated by direct integration of the scattering profile, in Å\ :sup:`3`\ .
281
282 *Corrected Vp*
283
284 The corrected Porod volume based on the method described :ref:`below <corvp>`, in Å\ :sup:`3`\ .
285
286 *Macromolecule Density*
287
288 The density of the macromolecule, used to calculate the molecular weight. This field
289 corresponds to the “Density” field in the “Molecular Weight Estimation from Corrected
290 Porod Volume” box in the Molecular Weight section of the Options window, and can be
291 changed there.
292
293 In the Abs. MW panel there are:
294
295 *Concentration*
296
297 The sample concentration in mg/ml, this field accepts input.
298
299 *MW*
300
301 The sample MW calculated by this method, in kDa.
302
303 *# electrons per mass dry macromolecule*
304
305 The dry mass number
306 density of electrons for the macromolecule, in e-/g. This field corresponds to
307 the “Electrons per dry mass of macromolecule” field in the “Molecular Weight Estimation
308 from Absolute Intensity Calibration” box in the Molecular Weight section of the Options
309 window, and can be changed there.
310
311 *# electrons per volume of buffer*
312
313 The number density of electrons for the protein buffer/solvent, in e-/cm\ :sup:`3`\ . This
314 field corresponds to the “Electrons per volume of aqueous solvent” field in the “Molecular
315 Weight Estimation from Absolute Intensity Calibration” box in the Molecular Weight section
316 of the Options window, and can be changed there.
317
318 *Protein partial specific volume*
319
320 The partial specific volume of the macromolecule, in cm\ :sup:`3`\ /g. This field corresponds
321 to the “Partial specific volume of the macromolecule” field in the “Molecular Weight Estimation
322 from Absolute Intensity Calibration” box in the Molecular Weight section of the Options window,
323 and can be changed there.
324
325 *Scattering length of an electron*
326
327 The scattering length of an electron in cm. This field corresponds to the “Scattering length
328 of an electron” field in the “Molecular Weight Estimation from Absolute Intensity Calibration”
329 box in the Molecular Weight section of the Options window, and can be changed there.
330
331 *Scattering contrast per mass*
332
333 .. _contrast:
334
335 The calculated scattering contrast per mass. This is calculated from the other parameters as
336 :math:`r_0(\rho_{Mmac}-\rho_{solv}\bar{\nu})` where :math:`r_0` is the scattering length of
337 an electron, :math:`\rho_{Mmac}` is the electrons per dry mass of macromolecule, :math:`\rho_{solv}`
338 is the electrons per volume of aqueous solvent, and :math:`\bar{\nu}` is the partial specific
339 volume of the protein.
340
341
342 The molecular weight methods
343 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
344
345 .. _molweightmethods:
346
347 Four different methods are used to calculate the molecular weight of the macromolecule
348 from the background subtracted scattering profile.
349
350 *I(0) Referenced molecular weight calculation (I(0) Ref. MW panel)*
351
352 The scattering at zero angle, I(0) is proportional to the molecular weight of the
353 macromolecule, and the concentration and contrast of the macromolecule in solution.
354 If a reference sample of known molecular weight and concentration is measured, it
355 can be used to calibrate the molecular weight of any other scattering profile with
356 known concentration (assuming constant contrast between reference and sample, and
357 a monodisperse sample). Molecular weight is calculated as:
358
359 .. math:: MW_m=\left(\frac{I(0)_m}{c_m}\right)\left(\frac{MM_{st}}{I(0)_{st}/c_{st}}\right)
360
361 where MW is the molecular weight, c is the concentration, and the m and st subscripts denote
362 quantities from the macromolecule of interest and the standard respectively. For a reference
363 see, among many, Mylonas, E. & Svergun, D. I. (2007). J. Appl. Crystallogr. 40, s245-s249.
364
365 This method can yield inaccurate results if the reference is not properly calibrated, I(0)
366 is not well estimated from the Guinier fit, or the contrast between the macromolecule and
367 buffer is significantly different between the reference and sample.
368
369 *Volume of correlation based molecular weight calculation (Vc MW panel)*
370
371 This method uses the approach described in: Rambo, R. P. & Tainer, J. A. (2013). Nature.
372 496, 477-481. First, the volume of correlation, V\ :sub:`c`\ , is calculated as
373
374 .. math:: V_c=\frac{I(0)}{\int qI(q)dq}
375
376 Unlike the Porod volume, V\ :sub:`c` is expected to converge for both compact and flexible
377 macromolecules. Physically, V\ :sub:`c` can be interpreted as the particle volume per
378 self-correlation length, and has units of Å\ :sup:`2`\ . V\ :sub:`c` and the radius of gyration,
379 Rg, are then used to calculate a parameter :math:`Q_r=V_c^2/R_g`\ . The molecular weight is
380 then calculated as:
381
382 .. math:: MW=\left(\frac{Q_r}{b}\right)^a
383
384 where *a* and *b* are empirically determined constants that depend upon the type of
385 macromolecule. More details on the calculation are in the reference. The authors
386 claim the error in MW determination is ~5-10%.
387
388 This method can yield inaccurate results if the integral :math:`\int qI(q)dq` doesn't converge,
389 which may indicate the scattering profile is not measured to high enough q or that there is a
390 bad buffer match. It also requires accurate determination of I(0) and Rg. It doesn't work for
391 protein-nucleic acid complexes.
392
393 *Corrected Porod Volume method (Vp MW panel)*
394
395 .. _corvp:
396
397 This method uses the approach described in: Fischer, H., de Oliveira Neto, M., Napolitano, H. B., Polikarpov, I., & Craievich, A. F. (2009). J. Appl. Crystallogr. 43, 101-109. First, the Porod volume, V\ :sub:`p`\ ,
398 is determined. True determination of the Porod volume requires the scattering profile measured to
399 infinite q. A correction is applied to V\ :sub:`p` to account for the limited range of the
400 measurement. The authors report a maximum of 10% uncertainty for calculated molecular weight
401 from globular proteins.
402
403 This method can yield inaccurate results if the molecule is not globular. It requires accurate
404 determination of I(0). It also requires an accurate protein density. It only works for proteins.
405
406 Note: To do the integration, RAW extrapolates the scattering profile to I(0) using the Guinier
407 fit. The authors of the original paper used smoothed and extrapolated scattering profiles
408 generated by GNOM. This may cause discrepancy. To use this method on GNOM profiles, use the
409 online SAXS MoW calculator located at: `http://saxs.ifsc.usp.br/ <http://saxs.ifsc.usp.br/>`_
410
411 *Absolute calibrated intensity method (Abs. MW panel)*
412
413 This uses the absolute calibration of the scattering profile to determine the molecular
414 weight, as described in Orthaber, D., Bergmann, A., & Glatter, O. (2000). J. Appl.
415 Crystallogr. 33, 218-225. By determining the absolute scattering at I(0), if the sample
416 concentration is also known, the molecular weight is calculated as:
417
418 .. math:: MW=\frac{N_AI(0)/c}{\Delta \rho^2_M}
419
420 where N\ :sub:`A` is the Avagadro number, c is the concentration, and :math:`\Delta \rho_M^2`
421 is the scattering contrast per mass described :ref:`above <contrast>`. The accuracy of this method was
422 assessed in Mylonas, E. & Svergun, D. I. (2007). J. Appl. Crystallogr. 40, s245-s249, and for most
423 proteins is <~10%.
424
425 This method can yield inaccurate results if the absolute calibration is off, or if the
426 partial specific volume of the macromolecule in solution is incorrect. I(0) and the
427 concentration in solution must be well determined. Unless the scattering contrast is
428 adjusted, this method will only work for proteins.
429
430
431 BIFT
432 -----
433
434 The BIFT window allows you to run a Bayesian Indirect Fourier Transform (BIFT) method on
435 background subtracted scattering profiles to find the P(r) function. The advantage to this
436 method over the method implemented by GNOM is that once the search parameters are set,
437 there is no subjective input required from the user, a single “best” solution is provided
438 by the algorithm. The BIFT algorithm being used to find the P(r) is that of: Hansen, S. (2000).
439 J. Appl. Crystallogr. 33, 1415-1421.
440
441
442 Opening the BIFT Window
443 ~~~~~~~~~~~~~~~~~~~~~~~
444
445 The BIFT window can be opened by selecting a data item in the Manipulation Panel and either
446 right clicking and selecting “BIFT” or selecting “BIFT” from the “Tools” menu. Whichever
447 data item is selected will be the one that is being analyzed. If multiple items are selected,
448 the first (top item in the list) will be the one analyzed.
449
450 The window has two parts. The left part shows the file being analyzed, and the controls,
451 parameter outputs, and status for the BIFT. The right is two plots, the top showing the P(r)
452 function found by the BIFT and the bottom showing the experimental data and the scattering
453 profile generated from the P(r) function. The space allotted to each side can be adjusted
454 by clicking and dragging the separator bar. The whole window can be resized by clicking and
455 dragging an edge or corner.
456
457 When the window is first opened, it runs a BIFT analysis to find the P(r) function of the
458 data, based on the current settings. These settings can be altered from the
459 :ref:`BIFT panel <biftoptions>` in the Options window.
460
461 Once you are satisfied with the BIFT results, clicking the “OK” button will save the Dmax, real
462 space Rg, real space I(0), the :math:`\chi` :sup:`2` for the fit, and :math:`\log_{10}\alpha` for the data
463 item selected. That will allow you to save the BIFT analysis parameters when :ref:`saving all results <saveresults>` and save the results with the scattering profile if that is saved as a “.dat” file.
464 Additionally, a new IFT data item will be created, which will be shown in the
465 :ref:`IFT Control and Plot panels <iftpanel>`. Clicking the
466 “Cancel” button (or the close window button from the operating system, typically in the upper
467 left or right corner) will exit the window without saving the analysis results or new IFT item.
468 IFT items created by BIFT will have an extension “.ift”.
469
470 **Note:** Only one BIFT window can be open at once. If a window is already open and you try to
471 open a new one, it will close the current window and open the new one.
472
473
474 The BIFT Controls
475 ~~~~~~~~~~~~~~~~~
476
477 A BIFT analysis of the scattering profile is automatically run when the window is opened. BIFT
478 has very few controls available to the user, though settings can be customized. The controls consist
479 of three buttons:
480
481 *Run*
482
483 Reruns the BIFT analysis. Needs to be done if the settings are changed after the BIFT panel is opened.
484
485 *Abort*
486
487 Aborts the BIFT analysis if it is currently running.
488
489 *Settings*
490
491 Opens the Options window and shows the settings for BIFT. If settings are changed, the Run button
492 must be used to generate a new P(r) function with the changed settings.
493
494
495 The BIFT parameters
496 ~~~~~~~~~~~~~~~~~~~
497
498 The BIFT panel displays the following parameters:
499
500 *Dmax*
501
502 The maximum dimension of the P(r) function found by the BIFT algorithm. This is in units of
503 1/q, which RAW assumes to be Å.
504
505 *Log(Alpha)*
506
507 The log base 10 of the alpha value found as optimal by the BIFT search.
508
509 *Rg (A)*
510
511 The radius of gyration in Å (assumed, actual units of 1/q). This is shown from the Guinier
512 fit (if available) and the P(r) function. The value from the P(r) function is the value calculated
513 in real space by
514
515 .. math:: R_g=\frac{\int_0^{D_{max}}r^2 P(r) dr}{2\int_0^{D_{max}} P(r)dr}
516
517 *I(0)*
518
519 The scattering at zero angle. This is shown from the Guinier fit (if available) and the
520 P(r) function. The value from the P(r) function is the value calculated in real space by
521
522 .. math:: I(0)=4\pi\int_0^{D_{max}} P(r) dr
523
524 *chi^2 (fit)*
525
526 The :math:`\chi^2` value of the scattering profile from the P(r) function to the experimental data.
527
528
529 The BIFT status
530 ~~~~~~~~~~~~~~~
531
532 The status box for the BIFT search shows parameters that update as the BIFT search is
533 performed. Once the search is over, they show the parameters of the final solution. The
534 status items displayed are:
535
536 *Status*
537
538 An overall status, which can be: Performing search grid, Performing Fine Search, BIFT done,
539 or BIFT canceled.
540
541 *Evidence*
542
543 The evidence value for a given search point.
544
545 *Chi*
546
547 The :math:`\chi^2` value of a given search point.
548
549 *Alpha*
550
551 The log base 10 of the alpha value of a given search point.
552
553 *Dmax*
554
555 The maximum dimension of the current search point.
556
557 *Current Search Point*
558
559 The current search point (numbered along the search grid, essentially arbitrary).
560
561 *Total Search Points*
562
563 The total number of search points, equal to the number of Dmax search points multiplied
564 by the number of alpha search points.
565
566 **Note:** The status window does not update the evidence, chi, alpha, or dmax values during
567 the fine search, only at the end of the fine search.
568
569
570 The BIFT plots
571 ~~~~~~~~~~~~~~
572
573 There are two plots in the BIFT window. The top plot shows the P(r) function in red. The
574 units for the r (bottom) axis of this plot are 1/q, which RAW assumes to be Å. A black
575 line is displayed at zero on the plot for reference. The bottom plot shows the measured
576 scattering profile data as blue points, and the scattering profile generated from the P(r)
577 function in red.
578
579 **Note:** There are no controls available on right click for these plots, but there is a standard :ref:`plot control bar <navbar>`.
580
581
582 The BIFT algorithm
583 ~~~~~~~~~~~~~~~~~~
584
585 The algorithm used is described in Hansen, S. (2000). J. Appl. Crystallogr. 33, 1415-1421.
586 In RAW, a coarse grid is used for an initial search, and then a fine optimization is performed
587 from the best point in that search space. The limits of the coarse grid and the number of
588 points in the coarse grid can be set in the Options window.
589
590
591 GNOM (ATSAS)
592 ------------
593
594 .. _gnomwindow:
595
596 RAW allows you to run certain analyses using the ATSAS software package from within RAW.
597 One of the programs that can be run from RAW is GNOM, which performs an IFT to find the
598 P(r) function. Using the ATSAS package programs requires a :ref:`separate installation <atsas>` and
599 (possibly) some additional configuration of RAW.
600
601
602 Opening the GNOM Window
603 ~~~~~~~~~~~~~~~~~~~~~~~
604
605 The GNOM window can be opened by selecting a data item in the Manipulation Panel
606 and either right clicking and selecting “GNOM (ATSAS)” or selecting “GNOM” from the
607 “Tools”->“ATSAS” menu. Whichever data item is selected will be the one that is being
608 analyzed. If multiple items are selected, the first (top item in the list) will be
609 the one analyzed.
610
611 The window has two parts. The left part shows the filename being analyzed, and the
612 controls and parameter outputs for GNOM. The right part has two plots, the top showing
613 the P(r) function found by the GNOM, and the bottom showing the experimental data and
614 the scattering profile generated from the P(r) function. The space allotted to each side
615 can be adjusted by clicking and dragging the separator bar. The whole window can be resized
616 by clicking and dragging an edge or corner.
617
618 When the window is first opened, if no previous GNOM analysis is available for the data
619 item, RAW runs DATGNOM from the ATSAS package analysis to find a P(r) function of the
620 data. Generally, better results are obtained from DATGNOM when an Rg value is available
621 from the Guinier fit. If GNOM analysis has previously be done on the data item, RAW will
622 display the P(r) function corresponding to the Dmax value found by that analysis.
623
624 Once you are satisfied with the GNOM results, clicking the “OK” button will save the Dmax,
625 Total Estimate, real space Rg, real space I(0), and the starting and ending q values for
626 the data item selected. That will allow you to save the GNOM analysis parameters when
627 :ref:`saving all results <saveresults>` and save the results with the scattering profile
628 if that is saved as a “.dat” file. Additionally, a new IFT data item will be created,
629 which will be shown in the :ref:`IFT Control and Plot panels <iftpanel>`. Clicking the
630 “Cancel” button (or the close window button from the operating system, typically in the upper
631 left or right corner) will exit the window without saving the analysis results or new IFT item.
632 IFT items created by GNOM will have an extension “.out”.
633
634 **Note 1:** Only one GNOM window can be open at once. If a window is already open and you try
635 to open a new one, it will close the current window and open the new one.
636
637 **Note 2:** If the GNOM option is unavailable in the right click menu for a data item, it
638 indicates that RAW is unable to find the :ref:`ATSAS programs <atsas>` on your computer.
639
640
641 The GNOM Controls
642 ~~~~~~~~~~~~~~~~~
643
644 The GNOM Controls allow you to manually set the q_min and q_max values GNOM uses. You can
645 do this in two ways. First, if you type a value into the q_min or q_max box and hit enter,
646 RAW will find the nearest q point, and set the q value to that nearest point. Second, you
647 can adjust the n_min and n_max values either by typing an integer value in the appropriate
648 box or using the spin controls. The n_min and n_max controls change the minimum and maximum
649 points of the q vector used (zero indexed), and the q_min and q_max are updated to match. For
650 example if n_min is set to 5 and n_max is set to 130, the 5th indexed point through the 130th
651 indexed point in the q vector (so points 6-131, because of the zero indexing) will be used by
652 GNOM. The Dmax value can be either by typing an integer value in the appropriate box or using
653 the spin controls. Changing any of these values (q_min, q_max, and Dmax) automatically updates
654 the P(r) function.
655
656 The “Change Advanced Parameters” button opens the Options panel and shows the options for GNOM.
657 This allows you to change advanced parameters for your GNOM analysis.
658
659 The “DATGNOM” button runs the DATGNOM program from the ATSAS software package. The Dmax it finds
660 is rounded to the nearest integer, and GNOM is run with that Dmax value to generate the P(r) function.
661
662
663 The GNOM parameters
664 ~~~~~~~~~~~~~~~~~~~
665
666 The GNOM panel displays the following parameters from the GNOM fit:
667
668 *Rg (A)*
669
670 The radius of gyration in Å (assumed, actual units of 1/q). This is shown from the
671 Guinier fit (if available) and the P(r) function. The value from the P(r) function is
672 the value calculated in real space by
673
674 .. math:: R_g=\frac{\int_0^{D_{max}}r^2 P(r) dr}{2\int_0^{D_{max}} P(r)dr}
675
676 *I(0)*
677
678 The scattering at zero angle. This is shown from the Guinier fit (if available) and the
679 P(r) function. The value from the P(r) function is the value calculated in real space by
680
681 .. math:: I(0)=4\pi\int_0^{D_{max}} P(r) dr
682
683 *Total Estimate*
684
685 The “Total Estimate” produced by GNOM. A value close to 1 is good.
686
687 *chi^2 (fit)*
688
689 The :math:`\chi^2` value of the scattering profile from the P(r) function to the experimental data.
690
691 *GNOM says*
692
693 The subject interpretation of the quality of the P(r) function provided by GNOM.
694
695
696 The GNOM plots
697 ~~~~~~~~~~~~~~
698
699 There are two plots in the GNOM window. The top plot shows the P(r) function in red.
700 The units for the r (bottom) axis of this plot are 1/q, which RAW assumes to be Å.
701 A black line is displayed at zero on the plot for reference. The bottom plot shows the
702 measured scattering profile data as blue points, and the scattering profile generated
703 from the P(r) function in red.
704
705 **Note:** There are no controls available on right click for these plots, but there is a
706 standard :ref:`plot control bar <navbar>`.
707
708
709 AMBIMETER (ATSAS)
710 -----------------
711
712 .. _ambimeterwindow:
713
714 RAW allows you to run certain analyses using the ATSAS software package from within RAW. One
715 of the programs that can be run from RAW is AMBIMETER, which provides an estimate of the
716 ambiguity a 3D shape reconstruction will have, based on the scattering profile generated
717 from the P(r) function. Using the ATSAS package programs requires equires a
718 :ref:`separate installation <atsas>` and (possibly) some additional configuration of RAW.
719
720 Opening the AMBIMETER Window
721 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
722
723 The AMBIMETER window can be opened by selecting a data item in the IFT Panel and either
724 right clicking and selecting “Run AMBIMETER” or selecting “AMBIMETER” from the
725 “Tools” -> “ATSAS” menu. Whichever data item is selected will be the one that is being
726 analyzed. If multiple items are selected, the first (top item in the list) will be the
727 one analyzed. Currently, AMBIMETER only works on IFT items generated by GNOM (“.out” files
728 in the IFT panel). The AMBIMETER window shows the file it is being run on, the Rg (real
729 space form the P(r) function), and controls and results.
730
731 When the window is first opened, AMBIMETER is run on the data. Once you are satisfied with
732 the GNOM results, clicking the “OK” or “Cancel” will close the window. Because of the strict
733 save format required for “.out” files to be used by the ATSAS package, the AMBIMETER results
734 are not saved anywhere, and must be manually saved by the user (such as writing it down).
735
736 **Note 1:** Only one AMBIMETER window can be open at once. If a window is already open and
737 you try to open a new one, it will close the current window and open the new one.
738
739 **Note 2:** If the AMBIMETER option is unavailable in the right click menu for a
740 data item, it indicates that RAW is unable to find the :ref:`ATSAS programs <atsas>` on your computer
741 or that you do not have a recent enough version of the ATSAS package installed (version
742 2.7.1 or greater required for AMBIMETER).
743
744
745 The AMBIMETER Controls
746 ~~~~~~~~~~~~~~~~~~~~~~
747
748 The AMBIMETER controls allow you to adjust the maximum q value used by AMBIMETER, by
749 adjusting the upper q*Rg limit between 3 and 7. Note that if the maximum q value of
750 the scattering profile times the Rg is less than the limit set, the whole curve is used.
751
752 The AMBIMETER program can also save output shapes. For more information about this, see
753 the AMBIMETER manual available with the ATSAS software. In the window, you can select
754 which shapes to save, None (default), Best (one shape, the best fit), or All (all of
755 the shapes that fit). If you are saving shapes, you should then select the output directory
756 to save them in, and provide an output prefix. The shapes will with the prefix value provided
757 in the Output prefix box, as described in the AMBIMETER manual. Clicking the Run button is
758 necessary to rerun AMBIMETER after any settings have been changed.
759
760
761 The AMBIMETER Results
762 ~~~~~~~~~~~~~~~~~~~~~
763
764 The results section shows the output from AMBIMETER. It reports:
765
766 *Number of compatible shape categories*
767
768 The number of compatible shape categories, as described in the AMBIMETER manual.
769
770 *Ambiguity score*
771
772 Log base 10 of the number of compatible shape categories.
773
774 *AMBIMETER says*
775
776 The subjective interpretation of the ambiguity score provided by AMBIMETER.
777
778
779 DAMMIF (ATSAS)
780 --------------
781
782 .. _dammifwindow:
783
784 RAW allows you to run certain analyses using the ATSAS software package from within RAW.
785 One of the programs that can be run from RAW is DAMMIF and the accompanying programs DAMAVER
786 and DAMCLUST, which carry out 3D shape reconstructions based on the P(r) function and scattering
787 profile. Using the ATSAS programs requires a :ref:`separate installation <atsas>` and
788 (possibly) some additional configuration of RAW.
789
790
791 Opening the DAMMIF Window
792 ~~~~~~~~~~~~~~~~~~~~~~~~~
793
794 The DAMMIF window can be opened by selecting a data item in the IFT Panel and either right
795 clicking and selecting “Run DAMMIF” or selecting “DAMMIF” from the “Tools”->“ATSAS” menu.
796 Whichever data item is selected will be the one that is being analyzed. If multiple items are
797 selected, the first (top item in the list) will be the one analyzed. Currently, DAMMIF only
798 works on IFT items generated by GNOM (“.out” files in the IFT panel).
799
800 The DAMMIF window shows current DAMMIF settings, controls, the log output for each separate
801 DAMMIF and DAMAVER run, and the overall status of the processing. The “Close” button closes
802 the window. If this is done before the DAMMIF processing is finished, it will abort the
803 processing.
804
805 **Note 1:** Only one DAMMIF window can be open at once. If a window is already open and you
806 try to open a new one, it will close the current window and open the new one.
807
808 **Note 2:** If the DAMMIF option is unavailable in the right click menu for a data item,
809 it indicates that RAW is unable to find the :ref:`ATSAS programs <atsas>` on your computer.
810
811 **Note 3:** The DAMMIF processing can be run in the background while further data processing
812 is done in RAW.
813
814
815 The DAMMIF settings
816 ~~~~~~~~~~~~~~~~~~~
817
818 The DAMMIF window settings section allows you to change the most commonly used DAMMIF settings.
819 The “Change Advanced Settings” button allows you to change all of the advanced settings of DAMMIF.
820
821 *Output directory*
822
823 This sets the output directory for DAMMIF and DAMAVER results, and can be set either by typing a
824 directory into the box and hitting enter, or using the Select/Change Directory button. The directory
825 defaults to the directory showing the Files tab.
826
827 *Output prefix*
828
829 The output prefix will be appended to each DAMMIF and DAMAVER file. It defaults to the filename being
830 analyzed. This should contain no spaces.
831
832 *Number of reconstructions*
833
834 The total number of DAMMIF models to construct.
835
836 *Number of simultaneous runs*
837
838 The number of DAMMIF models to reconstruct simultaneously. DAMMIF runs on a single core, and typically
839 takes 100% of the resources of that core. On multicore machines, the number of simultaneous runs can
840 be set between 1 and the total number of cores. The default is the number of cores minus one.
841
842 *Mode*
843
844 Sets the Mode used by DAMMIF for the reconstructions. The “Fast” and “Slow” modes are as described
845 in the DAMMIF manual. The “Custom” mode is equivalent to the “Interactive” mode for DAMMIF, and
846 allows the use of the more advanced settings, as set in the Options panel in the “DAMMIF Advanced” section.
847
848 *Symmetry*
849
850 Allows the symmetry to be set, if known, as described in the DAMMIF manual.
851
852 *Anisometry*
853
854 Allows the anisometry to be set, if known, as described in the DAMMIF manual.
855
856 *Change Advanced Settings*
857
858 This opens the Options panel and shows the options for DAMMIF. This allows you to change advanced
859 parameters for your DAMMIF analysis.
860
861 *Align and average envelopes (damaver)*
862
863 If this is selected and two or more reconstructions are generated using DAMMIF, then once
864 all reconstructions are finished DAMAVER is automatically run on the DAMMIF reconstructions.
865 This runs in a mode equivalent to “damaver –a” at the command line.
866
867 *Align and cluster envelopes (damclust)*
868
869 If this is selected and two or more reconstructions are generated using DAMMIF, then once all
870 reconstructions are finished DAMCLUST is automatically run on the DAMMIF reconstructions.
871
872 **Note:** The damaver and damclust options are mutually exclusive, you can select DAMAVER or
873 DAMCLUST but not both.
874
875
876 The DAMMIF controls
877 ~~~~~~~~~~~~~~~~~~~
878
879 There are only two control buttons, “Start”, which starts the DAMMIF reconstructions, and “Abort”,
880 which aborts the DAMMIF reconstructions. Start is only available if DAMMIF reconstructions are not
881 currently running. Abort is only available if DAMMIF reconstructions are running.
882
883 **Note:** DAMMIF requires that the P(r) function be written to disk as a “.out” file. RAW will
884 check whether there is an existing “.out” file with the same name that will be overwritten before
885 running. It will also check whether the DAMMIF files generated will overwrite any existing files.
886 In either case, it will provide a warning to let you know that is happening.
887
888 **Note 2:** DAMMIF gets the starting random seed value from the computer clock time in seconds.
889 In order to produce different reconstructions, the start of each reconstruction must occur at
890 least 1s after the previous one. This introduces a noticeable delay when starting up a large number
891 simultaneous reconstructions.
892
893
894 The DAMMIF status
895 ~~~~~~~~~~~~~~~~~
896
897 The status panel provides an overview of the current status of the DAMMIF runs. It updates with the
898 following status:
899
900 *Starting Processing*
901
902 Indicates that the initial processing has started.
903
904 *Starting DAMMIF run <#>*
905
906 Here the <#> corresponds to the run number (1 up to the total number of reconstructions), and this
907 corresponds to the numbers in the Log panel. This indicates that the given DAMMIF run has started.
908
909 *Finished DAMMIF run <#>*
910
911 Here the <#> corresponds to the run number (1 up to the total number of reconstructions), and this
912 corresponds to the numbers in the Log panel. This indicates that the given DAMMIF run has finished.
913
914 *Starting DAMVER*
915
916 Indicates that the reconstructions are now being aligned and averaged by DAMAVER.
917
918 *Finished DAMAVER*
919
920 Indicates that the reconstructions have finished being aligned and averaged by DAMAVER.
921
922 *Finished Processing*
923
924 Indicates that all processing has finished.
925
926 *Processing Aborted!*
927
928 Indicates that the processing was aborted before everything finished.
929
930 If necessary, the status window is scrollable.
931
932
933 The DAMMIF log
934 ~~~~~~~~~~~~~~
935
936 The log area provides details of the current and finished DAMMIF and DAMAVER processing.
937 This is the output that would be displayed in the console window if DAMMIF or DAMAVER were
938 run from the command line.
939
940 When the DAMMIF window is first opened, the log window will be empty. Once DAMMIF processing
941 is started, a set of different panels accessible via the tabs at the top will be opened. Any
942 tab with a number corresponds with a DAMMIF run (output from DAMMIF run 1 will display in tab
943 “1”, and so on). The runs are simply numbered sequentially starting with 1 and ending with the
944 total number of reconstructions. If DAMAVER will also be run, the last tab is “Damaver”, which
945 shows the output of that processing.
946
947 Before a given run is started, the window associated with the tab will be empty. Once it starts,
948 it will be updated with the output from DAMMIF or DAMAVER that would normally display in the console.
949 Once it finishes, it will no longer update, but the log can still be viewed. The long windows are
950 scrollable. You can change which output you are viewing by clicking on the tabs.
951
952 **Note:** The output in the log window is not saved, however by default DAMMIF writes this
953 output to a log file, and the DAMAVER output is available in a set of output files. See the
954 ATSAS manuals for each program for more details.
955
956
957 SVD
958 ---
959
960 Singular value decomposition (SVD) is a mathematical technique that is a model independent
961 approach that provides information on the number of unique elements in a data set. Formally,
962 singular value decomposition of a m x n matrix M is a factorization of into three matrices such that
963
964 .. math:: M=U\Sigma V^*
965
966 where U is an m x m unitary matrix, called the left singular values; :math:`\Sigma` is a diagonal
967 m x n matrix, where the diagonal values are the singular values, and :math:`V^*` is the conjugate
968 transpose of an n x n unitary matrix V, the right singular vectors. A typical interpretation of
969 singular value decompositions is that the number of singular values significantly above the baseline
970 level represents the number of significant distinct components in the data set.
971
972 RAW allows the user to use either scattering profiles or P(r) functions as the data set. This is
973 typically applied to scattering profiles in a SEC-SAXS data set, and the number of significant singular
974 values corresponds to the number of distinct scatterers in the data set. For SVD done across a single
975 well-separated peak from the chromatograph, there would be two significant components: one from the
976 buffer and one from the protein. For SVD done on a poorly separated monomer-dimer peak, there would be
977 three significant components: buffer, monomer, and dimer. RAW allows users to select a range of scattering
978 profiles for SVD, and displays the singular values :math:`\sigma_i` and the autocorrelation of the left and
979 right singular vectors :math:`R_i` for each ith singular value defined as
980
981 .. math:: R_i=\Sigma_n X_{i,n}X_{i,n+1}
982 :label: autocorr
983
984 where X is the U or V singular vector matrix.
985
986
987 Opening the SVD Window
988 ~~~~~~~~~~~~~~~~~~~~~~
989
990 .. _svdwindow:
991
992 The SVD window can be opened by selecting a single data item in the SEC Panel or two or more data
993 items in the Manipulation or IFT Panels and either right clicking and selecting “SVD” or selecting
994 “SVD” from the “Tools” menu.
995
996 The SVD window shows current SVD settings, controls, and results. The “Okay” button closes the window
997 and saves the parameters used, the “Cancel” button closes the window and saves nothing.
998
999 **Note:** Only one SVD window can be open at once. If a window is already open and you try to open a
1000 new one, it will close the current window and open the new one.
1001
1002
1003 The SVD Controls
1004 ~~~~~~~~~~~~~~~~
1005
1006 The SVD controls give the user (up to) three items to control.
1007
1008 *Use*
1009
1010 This option allows the user to select whether they use Unsubtracted or Subtracted data. Note
1011 that this choice is only available for SEC curves, where both unsubtracted and subtracted data
1012 can exist within the same data item. Subtracted data can only be selected if the SEC curve has
1013 had :ref:`structural parameters <secparams>` calculated for it.
1014
1015 *Use Frames*
1016
1017 This option changes the range of frames used for the SVD. If a SEC data item is selected, the frame
1018 number corresponds to the frame number in the SEC Plot. If Manipulation or IFT data items are selected
1019 in, the frame number is the same as how it would be displayed if the data were plotted on the
1020 :ref:`SEC plot <secplot>`. The plot in the controls window shows the SEC curve of the selected.
1021 The red points correspond to all of the data in the data set, the blue points correspond to the
1022 data being used for SVD.
1023
1024 *Normalize by uncertainty*
1025
1026 If this option is selected, the intensity at a given q (SEC and Manipulation data) or r
1027 (P(r) data) value is divided by the average uncertainty across all frames at that q or r
1028 value. When doing EFA analysis, the data is normalized in this way, so this option allows
1029 corresponding SVD analysis.
1030
1031
1032 The SVD Results
1033 ~~~~~~~~~~~~~~~
1034
1035 The SVD results are plotted in the two plots on the right side of the SVD panel. The top plot
1036 shows the singular values as a function of index (by default singular values are ordered from
1037 largest to smallest). The bottom plot shows the autocorrelation, defined in equation :eq:`autocorr`,
1038 of the left (red) and right (blue) singular vectors as a function of index.
1039
1040 The results control panel allows you to control which singular value indices are plotted. It
1041 has two further controls:
1042
1043 *Save Plotted Values*
1044
1045 This saves the singular values and autocorrelation values as a function of index that are plotted
1046 in the plots on the right. The data is saved as a comma separated value (.csv) file.
1047
1048 *Save All*
1049
1050 This saves all of the singular value information, which is to say, the full U, :math:`\Sigma`\ ,
1051 and V\ :sup:`*` matrices. It also saves the autocorrelation values for all indices. The data is
1052 saved as a comma separated value (.csv) file.
1053
1054
1055 EFA
1056 ---
1057
1058 Evolving factor analysis (EFA) is a model independent approach that extends SVD to allow
1059 separation of scattering profiles from mixed solutions, particularly overlapping
1060 chromatographic peaks from different species. This method was recently applied to SEC-SAXS
1061 data (see: Meisburger, S. P., Taylor, A. B., Khan, C. A., Zhang, S., Fitzpatrick, P. F., &
1062 Ando, N. (2016). J. Am. Chem. Soc. jacs.6b01563). An improved version of the method described
1063 by Meisburger et al. has been implemented in RAW. EFA in RAW starts with SVD, then proceeds
1064 by finding the component start and end points in the EFA plot and then rotating the significant
1065 singular value vectors into real scattering profiles. RAW implements two new methods for rotation
1066 of the singular vectors besides the iterative approached described by Meisburger et al. The
1067 first new method is the explicit calculation method described in: Maeder, M. (1987). Anal.
1068 Chem. 59, 530–533, while the second is a hybrid method that uses the explicit calculation
1069 as a seed for the iterative approach, allowing much faster convergence of the rotation.
1070
1071 Because EFA analysis is relative complex, it consists of three distinct screens in RAW, which
1072 are reached by clicking the “Next” and “Back” buttons in the EFA window. These screens step
1073 you through the EFA analysis. The window can be closed at any time with the “Cancel” button.
1074 If the EFA analysis succeeds, the window can be closed with the “Done” button, which sends the
1075 extracted scattering profiles to the Main plot, and saves information about the parameters used
1076 in the SEC item (if a SEC item was selected).
1077
1078
1079 Opening the EFA Window
1080 ~~~~~~~~~~~~~~~~~~~~~~
1081
1082 The EFA window can be opened by selecting a single data item in the SEC Panel or two or more
1083 data items in the Manipulation or IFT Panels and either right clicking and selecting “EFA” or
1084 selecting “EFA” from the “Tools” menu.
1085
1086 The EFA window shows current EFA settings, controls, and results. The “Okay” button closes the
1087 window and saves the parameters used, the “Cancel” button closes the window and saves nothing.
1088
1089 **Note:** Only one EFA window can be open at once. If a window is already open and you try to
1090 open a new one, it will close the current window and open the new one.
1091
1092
1093 EFA Page 1 – SVD
1094 ~~~~~~~~~~~~~~~~
1095
1096 The first EFA page essentially reproduces the SVD window described :ref:`above <svdwindow>`.
1097 The difference is that there is a panel for User Input, “# Significant SVs” where the user
1098 inputs the number of significant singular values/vectors in the data set. RAW will automatically
1099 attempt to determine that, but the user can adjust it. If the user changes any of the SVD
1100 controls, RAW will not refine the guess for the number of significant singular values.
1101
1102 Once the user is happy with the data range and has determined number of significant singular
1103 vectors in the data, they click the “Next” button to move to Page 2.
1104
1105
1106 EFA Page 2 – Evolving Factors
1107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1108
1109 The second EFA page presents the results of the Evolving Factor Analysis. The details are
1110 described in the above referenced papers. In short, for Forward EFA, SVD is done on pieces
1111 of the data set, starting with just the first two frames, then the first three frames, and
1112 so on, until the entire data set is used. The singular values are then plotted as a function
1113 of final frame index used in that particular SVD, the top plot in this second page. This
1114 lets the user determine where certain components start in the data set, when there is a
1115 strong increase in a singular value is when a component starts in the data set. For Backward
1116 EFA, the same thing is done, except using the last two frames, then the last three frames,
1117 etc. The Backward EFA plot, the bottom plot on this page, shows the user where components
1118 exit the data set. Both the Forward and Backward EFA plots show one more value than the user
1119 marked as significant in Page 1, so that the user can judge where the value diverges from the
1120 baseline.
1121
1122 The User Input panel on the left side of the page consists of “Forward” and “Backward” sections
1123 each with a number of values equal to the user input of significant singular values from Page 1.
1124 These controls allow the user to set where each value diverges from the baseline.
1125
1126 Once the starting points for the values are set for both Forward and Backward EFA, clicking the
1127 “Next” button will take the user to Page 3.
1128
1129 Clicking the “Back” button allows the user to go back to Page 1 and adjust the results there.
1130
1131
1132 EFA Page 3 – Rotation
1133 ~~~~~~~~~~~~~~~~~~~~~
1134
1135 The third EFA page allows the user to control the rotation of the singular vectors into
1136 scattering profiles and view the result of that rotation. There are several different control boxes:
1137
1138 *Component Range Controls*
1139
1140 These allow the user to adjust the ranges of the components in the scattering profile. There
1141 are a number of controls equal to the number of significant singular vectors selected on Page
1142 1. Each control allows you to set the start and end point of the range, and each control has
1143 a “C>=0” checkbox. When checked, that forces the concentration profile for that component to
1144 be never negative (a physical constraint that can help with rotation by may hide mathematical
1145 errors). When the ranges are adjusted, the plot above this control is updated. The arrows and
1146 dashed lines of this plot shown the component ranges, with colors that correspond to the colors
1147 in the legend of the Scattering Profiles plot in the top right.
1148
1149 *Rotation Controls*
1150
1151 *Method*
1152
1153 This controls the rotation method. There are three choices. Iterative applies the approach
1154 of Meisburger et al. (2016). Explicit applies the approach of Maeder (1987). Hybrid uses the
1155 explicit approach to seed the iterative approach.
1156
1157 *Number of iterations*
1158
1159 This can only be set for the Hybrid and Iterative approaches, and sets the maximum number of
1160 iterations the algorithm will attempt. If convergence is not reached by the end of these
1161 iterations, the method will fail.
1162
1163 *Convergence Threshold*
1164
1165 This sets the threshold at which the iterative and hybrid solutions are said to be converged.
1166 This threshold is defined in Meisburger et al. (2016), and for the nth rotation is the
1167 absolute difference between the concentration profiles of the n-1 and n solutions.
1168
1169 *Status*
1170
1171 The status box displays the status of the rotation. If the rotation has succeeded it will
1172 say “Rotation Successful.” If the rotation is in progress it will say “Rotation in progress.”
1173 If the rotation has failed it will provide a message with some on the failure, that starts with
1174 “Rotation failed.”
1175
1176 *Results*
1177
1178 *Save EFA Data (not profiles)*
1179
1180 This button saves the EFA data, including the SVD data, the number of significant values,
1181 the ranges Forward and Backward EFA data, the ranges and concentration constraints for each
1182 component, the rotation method and other parameters used, and the mean error weighted :math:`\chi^2`
1183 and concentration data. This is all saved as a .csv file.
1184
1185 In addition to the control boxes, there are also three plots. The top plot shows the scattering
1186 profiles obtained via the rotation (if the rotation is successful). The bottom plots show: Left – the
1187 mean error weighted :math:`\chi^2` as a function of frame, which is a measure difference
1188 between the scattering profiles in a given frame as measured and as produced from the
1189 rotated scattering profiles and concentration profiles; Right – the concentration
1190 profiles for each component, which are color as the scattering profile (top) plot.
1191 The concentration profiles are normalized to an area of 1, and so are on an arbitrary scale.
1192
1193 .. |100000000000032600000272911687F043FA6AEB_png| image:: images/100000000000032600000272911687F043FA6AEB.png
1194 :width: 3.3472in
1195 :height: 2.5972in
1196