-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathxPDFsuite_manual.html
284 lines (186 loc) · 12.2 KB
/
xPDFsuite_manual.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Quick guide of calibration with xPDFsuite — xpdAcq 0.3 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="xpdAcq 0.3 documentation" href="index.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> xpdAcq
</a>
<div class="version">
0.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick start</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="xpdusers.html">XPD Users</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="beamlinestaff.html">Beamline Staff</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">xpdAcq</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Quick guide of calibration with xPDFsuite</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/xPDFsuite_manual.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="quick-guide-of-calibration-with-xpdfsuite">
<span id="xpdfsuite-manual"></span><h1>Quick guide of calibration with xPDFsuite<a class="headerlink" href="#quick-guide-of-calibration-with-xpdfsuite" title="Permalink to this headline">¶</a></h1>
<p>After collecting calibration images, we can perform calibration and make program
to calculate geometry parameters to current experiment.
Here is a quick guide for how to do it with <code class="docutils literal"><span class="pre">xPDFsuite</span></code></p>
<p>1. Type <code class="docutils literal"><span class="pre">xPDFsuite</span></code> or <code class="docutils literal"><span class="pre">xpdfsuite</span></code> <strong>in a new terminal window</strong>, to open our
data analysis tool kit <strong>xPDFsuite</strong>.</p>
<ol class="arabic simple" start="2">
<li>After open it, you should see main <code class="docutils literal"><span class="pre">xPDFsuite</span></code> window pops out:</li>
</ol>
<blockquote>
<div><a class="reference internal image-reference" href="_images/calib_01.png"><img alt="_images/calib_01.png" class="align-center" src="_images/calib_01.png" style="width: 400px; height: 300px;" /></a>
</div></blockquote>
<p>3. Click on the green button at the top from main <code class="docutils literal"><span class="pre">xPDFsuite</span></code> window to open
<code class="docutils literal"><span class="pre">SrXgui</span></code>. Then you should have another window:</p>
<blockquote>
<div><a class="reference internal image-reference" href="_images/calib_02.png"><img alt="_images/calib_02.png" class="align-center" src="_images/calib_02.png" style="width: 400px; height: 300px;" /></a>
<p><strong>Note:</strong> This screenshot is a demonstration at local computer so <code class="docutils literal"><span class="pre">input</span> <span class="pre">dir</span></code>
and <code class="docutils literal"><span class="pre">output</span> <span class="pre">dir</span></code> both point to local directory.
However, at beamline, we need to properly choose <code class="docutils literal"><span class="pre">input</span> <span class="pre">dir</span></code> to be
<code class="docutils literal"><span class="pre">/home/xf28id1/xpdUser/tiff_base``and</span> <span class="pre">``output</span> <span class="pre">dir</span></code> to be
<code class="docutils literal"><span class="pre">/home/xf28id1/xpdUser/config_base</span></code> so that entire pipeline is completed.</p>
</div></blockquote>
<p>4. Then clcik <code class="docutils literal"><span class="pre">Calibrate</span></code> button at the bottom and another window will pop out.
Choose <code class="docutils literal"><span class="pre">Calibrantion</span> <span class="pre">mode</span></code> to be <code class="docutils literal"><span class="pre">Calibrant</span></code> instead of <code class="docutils literal"><span class="pre">self</span></code> as we want
a precise calibration result.</p>
<blockquote>
<div><a class="reference internal image-reference" href="_images/calib_04.png"><img alt="_images/calib_04.png" class="align-center" src="_images/calib_04.png" style="width: 400px; height: 300px;" /></a>
<p>At this window, we need to specify <strong>three</strong> fields:</p>
<blockquote>
<div><ul class="simple">
<li><code class="docutils literal"><span class="pre">image</span> <span class="pre">file</span></code>: Calibration image you wish to perform calibration on</li>
<li><code class="docutils literal"><span class="pre">D-spacing</span> <span class="pre">file</span></code>: A required file for known calibrants with <code class="docutils literal"><span class="pre">.D</span></code> extension.
Supply it <strong>based on your calibrant</strong>. For major D-space files, you can find
them at <a class="reference external" href="https://github.com/pyFAI/pyFAI/tree/master/calibration">here</a></li>
<li><code class="docutils literal"><span class="pre">Wavelength</span></code> : Wavelength for your current experiment. Please obtain from
beamline scientist.</li>
</ul>
</div></blockquote>
<p>When all three fields are correctly assigned, click <code class="docutils literal"><span class="pre">OK</span></code> for next step.</p>
</div></blockquote>
<ol class="arabic simple" start="5">
<li>First you will see an image window like this:</li>
</ol>
<blockquote>
<div><a class="reference internal image-reference" href="_images/calib_05.png"><img alt="_images/calib_05.png" class="align-center" src="_images/calib_05.png" style="width: 400px; height: 300px;" /></a>
<p>That is the image we want to perform azimuthal calibration with. Use magnify
tool at the tool bar to zoom in and <strong>right click</strong> rings. Starting from
the first, inner ring and to outer rings. Usually a few rings (~5) should be
enough.</p>
<a class="reference internal image-reference" href="_images/calib_07.png"><img alt="_images/calib_07.png" class="align-center" src="_images/calib_07.png" style="width: 400px; height: 300px;" /></a>
<p>Remember to check information pop out in <em>the</em> terminal you used to
open <code class="docutils literal"><span class="pre">xPDFsuite</span></code>. It will provide you useful information.</p>
</div></blockquote>
<p>6. After selecting rings, click on <em>the</em> terminal you used to
open <code class="docutils literal"><span class="pre">xPDFsuite</span></code> and hit <code class="docutils literal"><span class="pre"><enter></span></code>. Then you will be requested to supply
indices of rings you just selected. Remember we are using <code class="docutils literal"><span class="pre">python</span></code>,
index <strong>starts from 0</strong>. After supplying all indices, you should have a window
like this to show your calibration:</p>
<blockquote>
<div><a class="reference internal image-reference" href="_images/calib_08.png"><img alt="_images/calib_08.png" class="align-center" src="_images/calib_08.png" style="width: 400px; height: 300px;" /></a>
<p>Program will ask you if you want to modify parameters, in most of case, you
don’t have to. So just hit <code class="docutils literal"><span class="pre"><enter></span></code> in the terminal and integration will be
done.</p>
</div></blockquote>
<ol class="arabic simple" start="7">
<li>Finally 1D integration and 2D regrouping results will pop out:</li>
</ol>
<blockquote>
<div><a class="reference internal image-reference" href="_images/calib_09.png"><img alt="_images/calib_09.png" class="align-center" src="_images/calib_09.png" style="width: 400px; height: 300px;" /></a>
<p>You can qualitatively interrogate your calibration by looking if lines in
2D regrouping are straight or not.</p>
</div></blockquote>
<p>8. Given all these hard works, let’s go back to <code class="docutils literal"><span class="pre">SrXgui</span></code> window and select the
<code class="docutils literal"><span class="pre">Geometry</span> <span class="pre">parameters</span></code> to see calibrated geometry parameters:</p>
<blockquote>
<div><a class="reference internal image-reference" href="_images/calib_11.png"><img alt="_images/calib_11.png" class="align-center" src="_images/calib_11.png" style="width: 400px; height: 300px;" /></a>
<p><strong>Don’t forget</strong> to save your calibration parameters! Click <code class="docutils literal"><span class="pre">Save</span> <span class="pre">Config</span></code>
at the bottom and choose directory to place this file. It should be
<code class="docutils literal"><span class="pre">/home/xf28id1/xpdUser/config_base</span></code> at XPD beamline.</p>
</div></blockquote>
<p>Alright, you are done then! With <span class="xref std std-ref">automated calibration capture</span> feature, <code class="docutils literal"><span class="pre">xpdAcq</span></code>
will load calibration parameters from the most recent config file in
<code class="docutils literal"><span class="pre">/home/xf28id1/xpdUser/config_base</span></code></p>
<p>For more detailed information, please click <code class="docutils literal"><span class="pre">Help</span></code> in <code class="docutils literal"><span class="pre">SrXgui</span></code> window.</p>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright (c) 2016 trustees of Columbia University in the City of New York.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.3',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>