Debian Codegraph @

docs/source/manual/RAW_Settings_and_the_Options_window.rst

raw
1 RAW Settings and the Options window
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 .. _optionswindow:
9
10 This section covers the RAW settings, in particular focusing on the Options window and
11 what all of the settings there do. It also covers how to save and load settings in RAW.
12
13
14 Saving and loading settings
15 ---------------------------
16
17 To save the current RAW settings to disk (a .cfg file):
18
19 #. Go to the “File” menu bar and select “Save Settings”
20
21 #. Select a filename and a location for the configuration (config) file and click “Save”
22
23
24 To load RAW settings from disk (a .cfg file):
25
26 #. Go to the “File” menu bar and select “Load Settings”
27
28 #. Select the appropriate file and click “Open”
29
30
31 **Note:** Saving a configuration file saves all of the settings in RAW that are set
32 in the Options window. It also saves any masks that have been created.
33
34
35 Changing settings
36 -----------------
37
38 Settings in RAW are generally changed in the Options window. Below we describe how to
39 open the options window, how to change all of the settings, and what the settings do.
40
41
42 Opening the Options window
43 --------------------------
44
45 To open the options window:
46
47 #. Go to the “Options” menu
48
49 #. Select “Advanced Options”
50
51
52 There are two parts to the Options window. There is an options tree on the left that
53 determines which options panel is displayed on the right. The part on the right displays
54 the options associated with the selected option in the option tree.
55
56
57 Closing the Options window
58 --------------------------
59
60 To save the changes made to the settings in the Options window, close the window by clicking
61 the “OK” button. To exit without saving any of the changes in the Options window, use the
62 “Cancel” button or the system close button (an “x” in the upper left or right corner of the panel).
63
64
65 General settings panel
66 ----------------------
67
68 The general settings are all check boxes and can be set by checking and unchecking the boxes.
69 They control the following items:
70
71 *Hide controls on manipulation items for new plots*
72
73 If this option is selected, new Manipulation data items start out
74 :ref:`collapsed <manipcollapse>`, if not selected they start out expanded. Defaults to off.
75
76
77 *Write header on top of dat files*
78
79 The :ref:`.dat <savingdata>` and :ref:`.ift <savingiftdata>` file “header” information can be
80 saved at the top or bottom of the file. If this is selected, it is written at the top,
81 if not it is written at the bottom. Defaults to off.
82
83
84 *Use header for mask creation (SAXSLAB instruments)*
85
86 If this option is set, if a SAXSLab instrument is being used, the image header will be used to make
87 the beamstop mask. Defaults to off.
88
89
90 *Detector is rotated 90 degrees (SAXSLAB instruments)*
91
92 If this option is set, it indicates to RAW that the SAXSLAB detector is rotated 90 degrees. This
93 affects mask creation from the image header. Defaults to off.
94
95
96 *Start online mode on startup*
97
98 If this option is selected and an *Online mode startup directory* has been picked, then when RAW
99 starts, it will automatically turn on online mode, with the selected directory as the target online
100 directory.
101
102
103 2D Reduction
104 ------------
105
106 In the 2D reduction panel, there are reduction options.
107
108 *Correct of the change in the solid angle of the pixels*
109
110 If this option is selected, the scattering intensity is corrected for the change in solid angle of
111 pixels as you move along the detector. This is implemented as the standard :math:`\cos^3 (2\theta)`
112 where :math:`2\theta` is the scattering angle.
113
114
115 Image/Header Format panel
116 ~~~~~~~~~~~~~~~~~~~~~~~~~
117
118 This panel in the Options window allows you to set the image format, the header file format (if any),
119 load the image header into RAW to set up normalizations, and set up bindings to use information in
120 the image header or header file as calibration and reduction parameters.
121
122
123 Image format
124 ~~~~~~~~~~~~
125
126 The image format can be set using the drop down menu. A full description of supported image types
127 is available in the :ref:`file types section <filetypes>`.
128
129
130 Header file format
131 ~~~~~~~~~~~~~~~~~~
132
133 The header file is a file that accompanies the detector image on some beamlines. This file often
134 contains additional information such as, diode values, ion chamber readings, exposure time and
135 date. Currently RAW supports the following header files: I711, MAXLab; I911-4, MAXLab; F2, CHESS;
136 G1, CHESS; G1 WAXS, CHESS; G1 Eiger, CHESS; BL19U2, SSRF; and BioCAT, APS.
137
138 **Note:** If you wish to have a new header file format added to RAW, please contact the developers.
139
140
141 Loading/Viewing header information
142 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
143
144 .. _loadimghdr:
145
146 If you wish to view header information from either the header file or the image header, click the
147 “Load Image” button and select the image of interest.
148
149 If you wish to use the header information to normalize the image, load the image using the “Load
150 Image” button and then click the “Apply” button at the bottom of the screen. This will save the
151 counter values in such a way that RAW can set up the normalization appropriately.
152
153
154 Using image header information for calibration and reduction (turning on and setting bindings)
155 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
156
157 .. _imghdrbind:
158
159 RAW has the ability to use header information for calibration and reduction settings. The method
160 for doing this is to set a “binding” between the counter value and the calibration value. The
161 calibration values that can be obtained from the image header or header file are: Beam X Center,
162 Beam Y Center, Detector Pixel Size, Sample Detector Distance, and Wavelength.
163
164 To create a binding:
165
166 #. Check the “Use image-header/header file for calibration and reduction parameters” box.
167
168 #. Load the image and header file values into the list as described :ref:`above <loadimghdr>`.
169
170 #. In the list of the image header and header file names and values, click on the name
171 of the header parameter that you want to use as one of the calibration values. This
172 will fill in the Name and Value in the appropriate fields in the lower left hand
173 portion of the panel.
174
175 #. Using the “Binding” menu, select what calibration parameter should use this header
176 value. In the binding column of the header list, you will see this calibration
177 parameter displayed.
178
179 **Note:** These values overwrite the same values set elsewhere in the settings. So if
180 you bind the Beam X Center to use a value from the header, no matter what you set it
181 to in the Calibration panel of the Options window it will use the value from the header.
182
183 **Note 2:** Make sure that your header file values match the expected units for the
184 calibration parameter. The beam center values should be in pixels on the detector,
185 the detector pixel size should be in microns, the sample detector distance in mm,
186 and the wavelength in angstroms.
187
188
189 Adding a modifier to a binding
190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
191
192 .. _addhdrmod:
193
194 Once a binding is set, it is possible to add a modifier to the binding, which affects
195 the value obtained from the header. This might be used in a case where the header value
196 is not in the appropriate units.
197
198 To set a modifier:
199
200 #. In the list of the image header and header file names and values, click on the name
201 of the bound header parameter that you want to set a modifier for.
202
203 #. In the Modifier field at the bottom of the panel, type in a mathematical expression.
204 This expression may contain any of the header values (including but not limited to the
205 header value selected for the binding). It may contain “+” “-“ “\*” and “/” for addition,
206 subtraction, multiplication, and division. The following strings are restricted, and
207 apply specific mathematical functions: *acos, asin, atan, atan2, ceil, cos, cosh, degrees,
208 exp, fabs, floor, fmod, frexp, hypot, ldexp, log, log10, modf, pow, radians, sin, sinh,
209 sqrt, tan, tanh*, all of which correspond to the functions of the same name in the python
210 math library (
211 `https://docs.python.org/2/library/math.html#module-math <https://docs.python.org/2/library/math.html#module-math>`_
212 ).
213
214 #. Click the “Add” button. You should get a popup window that evaluates the expression for the
215 current loaded header values. Once you close that window, the modifier should be listed in
216 the Modifer column of the header list.
217
218
219 Changing or removing a modifier to a binding
220 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221
222 To change a modifier to a binding, do the steps to add a modifier, :ref:`above <addhdrmod>`.
223 When you click on the header item in step 1, the modifier will be shown in the Modifier
224 field at the bottom of the panel, and you can make changes as appropriate in step 2.
225
226 To remove a modifier to a binding:
227
228 #. In the list of the image header and header file names and values, click on the name of the
229 bound header parameter that you want to remove a modifier to.
230
231 #. Click the “Remove” button (next to the Modifier field at the bottom of the panel).
232
233
234 Removing bindings
235 ~~~~~~~~~~~~~~~~~
236
237 .. _removehdrbind:
238
239 To remove a single binding:
240
241 #. In the list of the image header and header file names and values, click on the name of the bound
242 header parameter that you want to remove a binding to.
243
244 #. In the “Binding” menu at the bottom of the panel, select “No binding”.
245
246 To remove all bindings, click the “Clear Bindings” button.
247
248
249 Disabling bindings for calibration and reduction
250 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
251
252 To disable the use of bindings for calibration and reduction, either :ref:`remove <removehdrbind>`
253 all bindings or uncheck the “Use image-header/header file for calibration and
254 reduction parameters” checkbox.
255
256
257 Clear All
258 ~~~~~~~~~
259
260 The “Clear All” button clears all bindings, and removes the current loaded header/header file values
261 from the panel.
262
263
264 Calibration panel
265 ~~~~~~~~~~~~~~~~~
266
267 The calibration panel allows you to set the beam center, binning size, number of points skipped at the
268 start and end of a scattering profile, the sample to detector distance, wavelength, detector pixel size,
269 and whether or not the Q range is calibrated.
270
271
272 Setting calibration parameters
273 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
274
275 The calibration paramters are: Beam center (x and y), sample-detector distance, wavelength, and detector
276 pixel size. These can all be set by entering a value in the appropriate field on this panel or using the
277 spin controls. However, it is more natural to set these values from the
278 :ref:`Calibration/Centering panel <centeringcalibration>`.
279
280 **Note:** Changing the settings in the calibration/centering panel will change the values in this panel,
281 and vice versa.
282
283 **Note 2:** All of these calibration values are overridden by the bindings described
284 :ref:`above <imghdrbind>`, if a binding for the particular calibration parameter is set.
285
286
287 Start and end points
288 ~~~~~~~~~~~~~~~~~~~~
289
290 The “Start plots at q point number” value sets the first q point shown on the plot when a scattering
291 profile is integrated. It is zero indexed (first point is zero). So if it is set to 5, the plot will
292 start with the 6th q point in the q-vector. This is typically used to get rid of the beamstop shadow
293 from the integrated profiles.
294
295 The “Skip n points at the end of the curve” value sets the last point shown on the plot when a scattering
296 profile is integrated. If it is set to zero, all points are shown. So if it is set to 5, the last point
297 shown will be the 5th to last point in the q-vector. This is typically used to remove end points if something,
298 for example the downstream flight tube window, is shadowing a high q region of the detector.
299
300
301 Binning
302 ~~~~~~~
303
304 The default binning for integrated scattering profiles can be set using the “Binning Size” option. It accepts
305 integer values. A binning size of one corresponds to q bins that are one pixel wide. A binning size of 2
306 corresponds to q bins that are 2 pixels wide, and so on.
307
308 **Note:** The q size of a bin of a given pixel size will depend on the calibration parameters.
309
310
311 Calibrating the q-range
312 ~~~~~~~~~~~~~~~~~~~~~~~
313
314 If you do not wish to calibrate the q-range of integrated scattering profiles, uncheck the
315 “Calibrate Q-range” box. The scattering profile will then be displayed as intensity vs. bin
316 number. This option is checked by default.
317
318
319 Normalization panel
320 ~~~~~~~~~~~~~~~~~~~
321
322 The normalization panel allows you to normalize integrated scattering profiles by some value.
323 Typically a counter value is used that is proportional to the beam intensity transmitted through
324 the sample (such as a beamstop counter from an active beamstop).
325
326
327 Enabling and disabling normalization
328 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
329
330 |10000000000002F40000020EB2EC18E7EDE80AA8_png|
331
332 To enable normalization for integrated scattering profiles, check the “Enable Normalization”
333 checkbox (checked by default). To disable, uncheck the “Enable Normalization” checkbox.
334
335
336 Setting up normalization operations
337 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
338
339 .. _addnormalization:
340
341 To add a new operation to the normalization procedure:
342
343 #. Select the operator to be used (/, \*, -, + corresponding to division, multiplication,
344 subtraction, and addition respectively)
345
346 #. Enter the desired expression in the expression box.
347
348 #. Click the “Calc” button to view the result of the entered expression.
349
350 #. Click the “Add” button.
351
352 **Note:** This expression may contain any of the header values (including but not limited to
353 the header value selected for the binding). It may contain “+” “-“ “\*” and “/” for addition,
354 subtraction, multiplication, and division. The following strings are restricted, and apply
355 specific mathematical functions: *acos, asin, atan, atan2, ceil, cos, cosh, degrees, exp, fabs,
356 floor, fmod, frexp, hypot, ldexp, log, log10, modf, pow, radians, sin, sinh, sqrt, tan, tanh*,
357 all of which correspond to the functions of the same name in the python math library (
358 `https://docs.python.org/2/library/math.html#module-math <https://docs.python.org/2/library/math.html#module-math>`_
359 ).
360
361
362 Reordering and removing normalization operations
363 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
364
365 The order in which the operations are carried out can be changed by selecting the operation
366 in the normalization list and using the Move Up and Move Down buttons. Operations can be
367 removed by selecting the operation in the list and clicking the Delete button.
368
369
370 Normalizing by a header value
371 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
372
373 It is often desired to normalize the data by exposure time or incoming / transmitted beam
374 intensity, and/or remove offsets on the detector.
375
376 To do so:
377
378 #. Load a header file into RAW as :ref:`described <loadimghdr>`. Be sure to hit the “Apply”
379 button after loading!
380
381 #. Return to the Normalization panel.
382
383 #. Add a normalization value as in steps, in the expression box enter the name of the
384 header value you wish to normalize by along with any other mathematical operations.
385
386
387 Normalizing by a region of interest (ROI)
388 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
389
390 RAW has the ability to normalize by a region of interest on the image. Every pixel in the region of
391 interest is summed, and that can be used to normalize in the same way as a header value.
392
393 To normalize by an ROI:
394
395 #. Set an :ref:`ROI mask <makeroimask>`.
396
397 #. Add an operation to the :ref:`normalization list <addnormalization>`, but
398 use “roi_counter” (without quotes) as the header value. For example, to divide
399 by the roi value, select the “/” operator and enter roi_counter in the expression
400 box, then add that to the list.
401
402
403 Absolute scale panel
404 ~~~~~~~~~~~~~~~~~~~~
405
406 |10000000000002F40000020E7C0AF04ABC8AD64A_png|
407
408 RAW is able to scale loaded image data to absolute scale using water as a standard. Water has a known,
409 temperature dependent absolute scale value at the forward scattering I(0). Water has a relatively
410 flat scattering profile, which makes it possible to estimate the forward scattering, I(0), from
411 an average of the intensity. To obtain the pure water signal, the water sample obtained in a sample
412 cell must have the empty cell subtracted from it.
413
414 To set up Absolute scale:
415
416 #. Click the “Set” button for the empty cell. Select either an image or text (such as .dat) file
417 of the empty cell scattering.
418
419 #. Click the “Set” button for the water sample. Select either an image or text (such as .dat)
420 file of the water scattering.
421
422 #. Select the water temperature in degrees centigrade.
423
424 #. Click the “Calculate” button. An absolute scaling constant should appear.
425
426 #. Enable absolute scale normalization by checking “Normalize processed data to absolute
427 scale” check box.
428
429 The algorithm uses the middle third part of the water scattering curve to estimate I(0) by
430 the average intensity.
431
432 **Note:** The selected files must have been normalized in exactly the same way as the
433 rest of the data that is to go on absolute scale. If loading an image, that means not
434 changing the normalization parameters after calculating the
435 absolute scale. If normalization parameters are changed the absolute scale constant
436 will have to be re-calculated. It is particularly important that the images or profiles
437 used to calculate absolute scale not have been saved with absolute scale already on (for
438 example, from a previous calibration).
439
440
441 Turning off absolute scale
442 ~~~~~~~~~~~~~~~~~~~~~~~~~~
443
444 To turn off absolute scale, uncheck the “Normalize processed data to absolute scale” checkbox
445 in the Absolute scale panel.
446
447
448 Flatfield correction panel
449 ~~~~~~~~~~~~~~~~~~~~~~~~~~
450
451 If a flatfield file is available, RAW can do a flatfield correction of the data. To do so,
452 click the “Set” button, and select the flatfield image. Then check the “Enable flatfield
453 correction” box.
454
455 When RAW applies a flatfield correction, it divides every image it processes by the flatfield
456 image, on a per-pixel basis. The assumption is that every pixel in the flatfield image should
457 have gotten the same intensity, so any variation comes from variation in the detector.
458
459
460 Turning off flatfield correction
461 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
462
463 To turn off flatfield correction, uncheck the “Enable flatfield correction” checkbox in the
464 Flatfield correction panel.
465
466 Molecular weight panel
467 ----------------------
468
469 The molecular weight panel of the Options windows allows control of the parameters used to
470 calculate molecular weight in the :ref:`molecular weight window <molweightwindow>` and the
471 :ref:`SEC calculated parameters <secparams>`. All four methods are described in more detail
472 :ref:`elsewhere <molweightmethods>`.
473
474 *Molecular Weight Estimation Using a Standard*
475
476 This subpanel corresponds to parameters for the MW estimation by comparison to a known standard.
477 While all of the parameters of the standard can be set/changed in this box, the standard MW (in
478 kDa), the standard I(0), the standard concentration (in mg/ml), and the standard filename (only
479 for reference), it is more natural to change these settings by loading the standard scattering
480 profile into RAW and using the :ref:`Use as MW Standard <mwstandard>` option.
481
482 *Molecular Weight Estimation From Volume of Correlation*
483
484 This subpanel corresponds to the parameters used for the volume of correlation method of estimating
485 molecular weight. This method is the method used for calculating MW in the :ref:`SEC panel <secparams>`
486 ). The protein and RNA coefficients correspond to the :ref:`A and B coefficients <molweightmethods>`.
487 The default type selection selects if the MW calculation defaults to Protein or RNA. Changing
488 this option will change whether the MW calculated in the SEC panel is for protein or RNA.
489
490 *Molecular Weight Estimation From Corrected Porod Volume*
491
492 This subpanel corresponds to the parameters for the MW calculation by corrected Porod volume. For
493 this method, the only parmater that can be changed is the protein density in kDa/Å:sup:`3`\ .
494
495 *Molecular Weight Estimation From Absolute Intensity Calibration*
496
497 These parameters correspond to the parameters necessary for calculating the molecular weight when
498 a scattering profile is on an absolute scale.
499
500 *Reset MW Parameters To Defaults*
501
502 If you have customized the MW parameters for a particular sample, you can restore the parameters
503 to the RAW defaults (which are the defaults from the relevant papers for each method). There are
504 no default settings for the estimation using a standard.
505
506
507 Artifact removal panel
508 ----------------------
509
510 Zingers are pixel values on the detector that are unusually high due to either cosmic radiation or
511 readout errors. RAW includes three methods that can be used for zinger removal.
512
513
514 Zinger removal by smoothing
515 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
516
517 A window of “Window Length” data points can be run across the data and discard values that are
518 more than “Std” standard deviations away from the average of the points in the window. A starting
519 index is given to specify where on the data curve the window should start.
520
521
522 Zinger removal when averaging
523 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
524
525 If three or more exposures of the same sample are available, then these can be used to eliminate
526 zingers by comparing the intensity values of each data set to the others. An intensity value in a
527 data-set that is larger than x standard deviations (Sensitivity) from third quintile of all related
528 data points in the rest of the data sets is removed and replaced by the average of the third quintile.
529
530
531 Zinger removal after radial averaging
532 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
533
534 This method is the most effective method for removing zingers. Pixel intensities in the image for
535 the same q value are compared and should be fairly constant. Values that are more than “Sensitivity”
536 standard deviations away from the median are discarded.
537
538
539 IFT panel
540 ---------
541
542 RAW currently supports one built-in method for determining the inverse Fourier transform (IFT)
543 of a scattering profile, the Bayesian IFT (BIFT) method. In the future we anticipate supporting
544 a python based implementation of the GNOM algorithm called pyGNOM, but currently that is not available.
545
546
547 BIFT
548 ~~~~
549
550 .. _biftoptions:
551
552 The BIFT panel allows you to set the BIFT Grid-Search parameters. These define the large grid
553 that the BIFT algorithm searches over before doing the fine search near the best value on the grid.
554
555 *Dmax Upper Bound*
556
557 Sets the largest maximum dimension (Dmax) value that will be used in the coarse grid search, in Å.
558
559 *Dmax Lower Bound*
560
561 Sets the smallest Dmax value that will be used in the coarse grid search, in Å.
562
563 *Dmax Search Points*
564
565 Total number of Dmax values in the coarse grid search that. These are evenly distributed between
566 the lower and upper bounds.
567
568 *Alpha Upper Bound*
569
570 Sets the largest alpha value that will be used in the coarse grid search.
571
572 *Alpha Lower Bound*
573
574 Sets the smallest alpha value that will be used in the coarse grid search.
575
576 *Alpha search points*
577
578 Sets the total number of alpha values in the coarse grid search. These are distributed logarithmically
579 between the lower and upper bound.
580
581 *P(r) Points*
582
583 Sets the number of points in the calculated P(r) curve.
584
585
586 Save Directories panel
587 ----------------------
588
589 .. _savedirpanel:
590
591 This panel controls the settings for :ref:`automated saving of data <autosave>`.
592
593 *Auto Save*
594
595 In this subpanel, the checkboxes control whether or not RAW automatically saves
596 Processed image files, Averaged data files, and Subtracted data files. When the
597 boxes are checked, that file type will be automatically saved, when they are unchecked,
598 it will not.
599
600 *Save Directories*
601
602 This panel allows you to selected the directories into which files will be saved for
603 each of the automated saving file types (Processed, Averaged, Subtracted). To pick a
604 directory, click the “Set” button and use the window that opens to select a folder.
605 Click “Open” once the appropriate folder is selected. To clear a directory click the “
606 Clear” button.
607
608 **Note:** A save directory must be selected before an Auto Save checkbox can be enabled.
609
610
611 Online Mode panel
612 -----------------
613
614 .. _onlinefilter:
615
616 This panel includes settings for the :ref:`online mode <onlinemode>`. This lets you enable
617 online filtering and set up the filter list.
618
619 Enabling/disabling online filtering
620 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
621
622 Online filtering filters files by filename, so that you can control which files are loaded
623 into RAW automatically. To enable this mode, check the “Enable Online Filtering” checkbox.
624 To disable this mode, uncheck that checkbox.
625
626 Adding a filter item to the online filter list
627 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
628
629 A filter item consists of three parts. First, there is the Ignore/Open operator. This allows
630 you specify whether you want RAW to ignore files with the given filter string in their name,
631 or to only open files that have the given filter string in their name. To set this option,
632 use the dropdown selector box at the bottom of the panel and select either “Ignore” or “Open
633 only with”.
634
635 The next part of the filter is the filter string. This is the string that RAW looks for in the
636 filename. To set this, enter a string into the filter string box at the bottom of the panel.
637
638 The final part of the filter is the location of the filter string. This sets where in the
639 filename RAW looks for the given filter string. This can be set to: “At start”, which means
640 RAW only applies the filter Ignore/Open action to files with the filter string at the start
641 of the file name; “Anywhere”, which means RAW applies the filter Ignore/Open action to files
642 with the filter string anywhere in the file name; and “At end”, which means RAW only applies
643 the filter Ignore/Open action to files with the filter string at the end of the file name.
644 To set this, use the dropdown selector box at the bottom of the panel and select one of those
645 three options.
646
647 Once you have set the Ignore/Open option, entered a filter string, and selected the location
648 of the filter string, click the “Add” button to add the filter item to the Online Filter List.
649
650 Reordering and removing filter items
651 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
652
653 The order in which the filtering is carried out can be changed by selecting the item in the filter
654 list and using the Move Up and Move Down buttons. Items can be removed by selecting the operation
655 in the list and clicking the Delete button. All filter items can be removed using the “Clear all” button.
656
657
658 SEC-SAXS panel
659 --------------
660
661 The SEC-SAXS panel controls settings related to the SEC-SAXS data processing.
662
663 *Intensity ratio (to background) threshold for calculationg Rg, MW, I0*
664
665 In order to speed up the :ref:`calculation of Rg, MW, and I0 as a function of frame <secparams>`
666 for SEC-SAXS data, a ratio of the frame intensity to the background intensity is taken.
667 If that value is less than the threshold set here, the frame is skipped. To attempt to calculate
668 structural parameters for all frames, set this threshold to -1.
669
670
671 ATSAS panel
672 -----------
673
674 The top level ATSAS panel allows you to control where the ATSAS bin location is (the folder
675 with all of the ATSAS programs in it). By default, RAW will attempt to automatically find the
676 ATSAS installation. If you wish to set the location yourself, uncheck the “Automatically find
677 the ATSAS bin location” checkbox, and either type the location into the ATSAS bin location
678 field or use the “Select Directory” button to select the appropriate directory.
679
680 **Note:** If you uncheck and then check the Automatically find checkbox, RAW will attempt to
681 find the ATSAS directory again. This can be useful if, for example, you install ATSAS and want
682 RAW to find the new installation without restarting RAW.
683
684
685 GNOM panel
686 ~~~~~~~~~~
687
688 The top level GNOM panel allows you to set the commonly used advanced settings for the ATSAS
689 software GNOM, which is run from the :ref:`GNOM window <gnomwindow>`. All of these options
690 correspond in name and allowable values to those of GNOM as described in the GNOM manual:
691 `https://www.embl-hamburg.de/biosaxs/manuals/gnom.html <https://www.embl-hamburg.de/biosaxs/manuals/gnom.html>`_
692
693 Settings can be rest to their defaults (which correspond to the GNOM defaults) by clicking the “Reset
694 to default” button. This resets the settings in this panel and in the GNOM Advanced panel.
695
696
697 GNOM Advanced panel
698 ~~~~~~~~~~~~~~~~~~~
699
700 This GNOM panel allows setting GNOM settings which are not as commonly used in GNOM. Again, all of
701 the options correspond in name and allowable values to those of GNOM as described in the GNOM manual:
702 `https://www.embl-hamburg.de/biosaxs/manuals/gnom.html <https://www.embl-hamburg.de/biosaxs/manuals/gnom.html>`_
703
704 Settings can be rest to their defaults (which correspond to the GNOM defaults) by clicking the
705 “Reset to default” button in the GNOM panel. This resets the settings in this panel and in the GNOM panel.
706
707
708 DAMMIF panel
709 ~~~~~~~~~~~~
710
711 The top level DAMMIF panel allows setting two things: First, the default settings for
712 DAMMIF that are set when the :ref:`DAMMIF window <dammifwindow>` is opened. Second, standard
713 settings that are available in Fast and Slow mode can be set in the “Standard Settings”
714 subpanel. All of the settings correspond in name and allowable values to those in the DAMMIF manual:
715 `https://www.embl-hamburg.de/biosaxs/manuals/dammif.html <https://www.embl-hamburg.de/biosaxs/manuals/dammif.html>`_
716
717 Settings can be rest to their defaults (which generally correspond to the DAMMIF defaults) by
718 clicking the “Reset to default” button. This resets the settings in this panel and in the DAMMIF
719 Advanced panel.
720
721
722 DAMMIF Advanced panel
723 ~~~~~~~~~~~~~~~~~~~~~
724
725 The settings in the DAMMIF advanced panel are only used when the “Custom” mode is selected
726 in the DAMMIF panel. This is equivalent to the interactive DAMMIF mode at the command line.
727 Unless otherwise noted, a value of -1 for a field indicates that it will use the default
728 setting. The settings correspond in name and allowable values to those in the DAMMIF manual:
729 `https://www.embl-hamburg.de/biosaxs/manuals/dammif.html <https://www.embl-hamburg.de/biosaxs/manuals/dammif.html>`_
730
731 Settings can be rest to their defaults (which generally correspond to the DAMMIF defaults)
732 by clicking the “Reset to default” button in the DAMMIF panel. This resets the settings in
733 this panel and in the DAMMIF panel.
734
735
736 .. |10000000000002F40000020E7C0AF04ABC8AD64A_png| image:: images/10000000000002F40000020E7C0AF04ABC8AD64A.png
737 :width: 3.4862in
738 :height: 2.4307in
739
740
741 .. |10000000000002F40000020EB2EC18E7EDE80AA8_png| image:: images/10000000000002F40000020EB2EC18E7EDE80AA8.png
742 :width: 3.4862in
743 :height: 2.4165in