Debian Codegraph @

docs/source/manual/The_Centering_Calibration_panel.rst

raw
1 The Centering/Calibration panel
2 ===============================
3
4 **WARNING:** The manual is current several versions out of date. While it may
5 still be useful for some users, please refer to the tutorial for the most
6 up-to-date information.
7
8 .. _centeringcalibration:
9
10 The Centering/Calibration panel allows you to set the beam center, x-ray wavelength
11 or energy, sample to detector distance, and detector pixel size. This allows RAW to
12 calibrate the q position for each pixel, and integrate the image into a one dimensional
13 scattering profile.
14
15
16 Opening the Centering/Calibration panel
17 ---------------------------------------
18
19 Before opening the Centering/Calibration panel, you should make sure that an appropriate
20 image for calibration (such as the scattering from silver behenate) is :ref:`open <showimage>`
21 in the :ref:`Image panel <imageplotpanel>`. To open the Centering/Calibration panel, go
22 to the Tools menu and click on “Centering/Calibration”. The Centering/Calibration panel
23 will be placed (temporarily) over the control panel.
24
25
26 Setting calibration parameters
27 ------------------------------
28
29 The Wavelength, Energy, Sample-Detector Distance, and Detector Pixel Size can all be
30 set in the Manual Centering/Calibration Adjustments panel of the Centering/Calibration
31 panel. For each, they can be set in one of two ways. First, a value can be directly
32 typed into the appropriate field. Second, the spin controls can be used to adjust the
33 value in the field. The spin controls only change the last digit of the value, so if
34 the sample detector distance is set at 1000, the up spin control will change it to 1001,
35 whereas if it is set at 1000.0, the up spin control will change it to 1000.1.
36
37 If a centering pattern is displayed on the image, changing these calibration will change
38 the pattern. In order for the pattern to update when a value is typed into a field, you
39 must either hit the enter key, or click out of the field.
40
41 *Note:* Setting the wavelength will automatically set the appropriate energy, and vice
42 versa. You only need to set one of these values.
43
44
45 Manually setting the beam center
46 --------------------------------
47
48 The beam center is displayed in x and y coordinates in the Manual Center/Calibration
49 Adjustments panel. These coordinates correspond with the x and y coordinates shown
50 on the image. If a centering pattern is selected in the Pattern drop down menu, the
51 eam center is also displayed on the image as a red dot 6 pixels in diameter.
52
53 The location of the beam center can be changed in three ways. First, values can be
54 directly entered into the X center and Y center fields. As with the calibration
55 parameters, in order to update the pattern display after entering a value in these fields,
56 you must either click out of the field or hit the enter key.
57
58 Second, the step size of the beam center in pixels can be set using the drop-down “Steps”
59 menu. The Steps menu is also a field you can type into, so you can set it to any numerical
60 value if the options available in the list are insufficient. Once you have set this, the
61 large red centering arrows on the right side of the Manual Center/Calibration Adjustments
62 box can be used to move the beam center <steps> pixels in the direction indicated by the
63 arrow, where <steps> is the value of the “Steps” field/menu. The arrows can be held down
64 for repeated motion in the same direction with the same step size.
65
66 Third, the target button in the center of the centering arrows can be clicked. You then click
67 on the image, and the beam center will be set to that position on the image, to the nearest pixel.
68
69
70 Automatic centering and distance calibration
71 --------------------------------------------
72
73 There are two different automated centering methods available in RAW. Which one is available in
74 your version depends on whether or not you have the *pyFAI* library installed. With either of
75 these methods, you will have the best chance to obtain accurate results if you manually calibrate
76 the center and distance first, so that the automated centering can refine on that starting position.
77
78 *With pyFAI (recommended)*
79
80 |10000201000001890000009175CE1B8F47D2AF8A_png|
81
82 In the Manual Centering/Calibration Adjustments panel:
83
84 #. Select the appropriate Standard.
85
86 In the Automatic Centering/Calibration panel:
87
88 #. Select the parameters to hold constant by checking boxes in the Fix section.
89
90 #. Select the detector type to be used. If your detector is not in the list, select Other.
91
92 #. Set the Ring # to the index of the first ring visible on the detector. The ring
93 index starts at zero for the largest d-spacing ring (nearest the beam) and
94 increments by one for each ring thereafter. *IMPORTANT:* The first ring visible
95 on your detector image may not be ring 0!
96
97 #. Click the Start button. Then click on the first ring in the image. Points in that
98 ring will be automatically selected. Click on other parts of the ring as necessary to
99 fill in points.
100
101 #. Increment the ring number as appropriate for the next ring visible on the image (usually
102 increment by 1, for example from 0 to 1), and click on the next ring on the image to select
103 points there. Repeat for all visible rings.
104
105 #. (If necessary) To remove points in a ring, set the Ring # to that ring, and click the
106 Clear All Points In Ring button.
107
108 #. Click the Done button once you have selected points in all of the visible standard rings.
109 At this point, automatic centering and calibration will be carried out.
110
111 *Note:* Ring points cannot be selected if the Pan or Zoom tool are selected.
112
113 *Without pyFAI (not recommended)*
114
115 |10000201000001880000004957972A08CDA2E5BF_png|
116
117 This automated centering function attempts to position the center and find the sample-detector
118 distance based on the innermost ring of a Silver Behenate sample:
119
120 #. Click the start button in the “Centering/Calibration Panel”
121
122 #. Select at least 3 points just outside the innermost ring in the Silver Behenate image.
123
124 #. Hit the “Done” button.
125
126 This function attempts to find the center of the circle that all of the points defined by your
127 clicks make. If that is found, it then uses the known wavelength, pixel size, and q value of the
128 first silver behenate ring to calculate the sample-detector distance.
129
130
131 Centering patterns
132 ------------------
133
134 *With pyFAI (recommended)*
135
136 If the pyFAI library is installed, more than twenty different calibrants are available,
137 all of those supported by the pyFAI package (
138 `https://github.com/silx-kit/pyFAI/tree/master/pyFAI/resources/calibration <https://github.com/silx-kit/pyFAI/tree/master/pyFAI/resources/calibration>`_
139 ), including Silver-Behenate (AgBh). Rings are displayed as red dashed lines at all appropriate q values.
140
141 *Without pyFAI (not recommended)*
142
143 Only one centering pattern is available in RAW. This is the Silver-Behenate pattern, which displays
144 red dashed rings on the detector corresponding to the expected rings from Silver-Behenate. RAW
145 displays the first 5 rings, which at q = 0.1076, 0.2152, 0.3229, 0.4305, and 0.538 Å:sup:`-1`\ .
146 The q values are labeled in RAW, but only show at the bottom of the rings, and so you typically have
147 to zoom out of the image to show the label.
148
149 .. |10000201000001880000004957972A08CDA2E5BF_png| image:: images/10000201000001880000004957972A08CDA2E5BF.png
150
151
152 .. |10000201000001890000009175CE1B8F47D2AF8A_png| image:: images/10000201000001890000009175CE1B8F47D2AF8A.png
153