Debian Codegraph @

docs/source/manual/Introduction_to_RAW_and_this_documentation.rst

raw
1 Introduction to RAW and this documentation
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 RAW
9 ---
10
11 BioXTAS RAW is a program for analysis of Small-Angle X-ray Scattering (SAXS) data.
12 The software enables: creation of 1D scattering profiles from 2D detector images,
13 standard data operations such as averaging and subtraction, analysis of radius of
14 gyration (Rg) and molecular weight, and advanced processing using GNOM, DAMMIF,
15 and AMBIMETER (requires ATSAS installation). It also allows easy processing of
16 inline SEC-SAXS data.
17
18 RAW is written in python (mostly) and C++ (a few small bits for speed). It is open
19 source and free for anyone to use. If you do use RAW, we ask that you cite the
20 following paper if you publish or present your results:
21
22 BioXTAS RAW, a software program for high-throughput automated small-angle X-ray
23 scattering data reduction and preliminary analysis, J. Appl. Cryst. (2009). 42, 959-964.
24
25 Some of the features of RAW include:
26
27 * Calibrate, mask, radially integrate, and normalize 2D images to make 1D scattering profiles
28
29 * Average, subtract, merge, rebin, and interpolate scattering profiles
30
31 * Easily process in-line SEC-SAXS data
32
33 * Calculate radius of gyration (Rg) and I(0) via Guinier fit
34
35 * Calculate the molecular weight via I(0) comparison to standards, absolute calibration,
36 correlation volume, and corrected Porod volume
37
38 * Run GNOM, DAMMIF, and AMBIMETER (requires ATSAS installation)
39
40 * Run singular value decomposition (SVD) and evolving factor analysis (EFA) on datasets
41
42 * Calculate P(r) functions using a Bayesian indirect Fourier transform (BIFT)
43
44 * Can read the following image formats:
45
46 * Pilatus Tiff
47
48 * CBF
49
50 * SAXSLab300
51
52 * ADSC Quantum
53
54 * Bruker
55
56 * Gatan Digital Micrograph
57
58 * EDNA-XML
59
60 * Eiger
61
62 * ESRF EDF
63
64 * FReLoN
65
66 * Nonius KappaCCD
67
68 * Fit2D spreadsheet
69
70 * FLICAM
71
72 * General Electric
73
74 * Hamamatsu CCD
75
76 * HDF5
77
78 * ILL SANS D11
79
80 * MarCCD 165
81
82 * Mar345
83
84 * Medoptics
85
86 * MPA (multiwire)
87
88 * Numpy 2D Array
89
90 * Oxford Diffraction
91
92 * Pixi
93
94 * Portable aNy Map
95
96 * Rigaku SAXS format
97
98 * 16 bit TIF
99
100 * 32 bit TIF
101
102 RAW is currently being developed by Jesse Hopkins and Soren Nielsen.
103
104 More information on RAW is available from the RAW website:
105
106 `https://sourceforge.net/projects/bioxtasraw/ <https://sourceforge.net/projects/bioxtasraw/>`_
107
108 RAW needs your help! If you find bugs in the program, or errors in the documentation
109 or tutorial, please let us know. Your input is the way we get better!
110
111 This documentation
112 ------------------
113
114 The purpose of this documentation is to clearly and completely document the functions of RAW.
115 This document is not intended to act as a tutorial to RAW, for a tutorial please refer to the
116 tutorial document and videos available from the RAW website. Instead, the goal is to document
117 what features are available in each section of RAW, how to use them, and what they do.
118
119 This document is laid out in chapters discussing each general area of RAW (for example, the
120 Files tab in the Control Panel is a single chapter). When appropriate, a chapter will cover
121 two related areas, such as the Manipulation tab of the Control Panel and the Main Plot Panel.
122 Some areas will be physical panels or windows of RAW, as the previous examples, while some
123 will be features, such as the Online Mode chapter. The exceptions to this are the second chapter,
124 which covers how to install RAW, and the third chapter, which provides a brief introduction
125 to the different windows of RAW and how they relate.
126
127 Typically, the algorithms used will not be fully documented here, as they are available in
128 the source code or appropriate citations (and are subject to change as we improve and expand RAW).
129