-
Notifications
You must be signed in to change notification settings - Fork 1
/
usb_GlobalOptions.html
289 lines (185 loc) · 11.6 KB
/
usb_GlobalOptions.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
285
286
287
288
289
<!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>xpdAcq Configuration — xpdAcq 0.5 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="xpdAcq 0.5 documentation" href="index.html"/>
<link rel="up" title="For XPD Users" href="xpdusers.html"/>
<link rel="next" title="For Beamline Staff" href="beamlinestaff.html"/>
<link rel="prev" title="Initial assessment of your data" href="usb_QuickAssess.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.5
</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 class="current">
<li class="toctree-l1 current"><a class="reference internal" href="xpdusers.html">For XPD Users</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="sb_overview.html">Overview of xpd acquisition environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="sb_icollection.html">Overview of the bsui+xpdAcq environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="usb_Beamtime.html">Setting up your Beamtime</a></li>
<li class="toctree-l2"><a class="reference internal" href="usb_Experiment.html">Setting up your XPD acuisition objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="usb_Scan.html">ScanPlan objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="usb_Where.html">Where did all my Sample and Scan objects go?????</a></li>
<li class="toctree-l2"><a class="reference internal" href="usb_Where.html#bt-list-is-your-friends">bt.list() is your friends</a></li>
<li class="toctree-l2"><a class="reference internal" href="usb_Where.html#bt-list-gotchas">bt.list() Gotchas</a></li>
<li class="toctree-l2"><a class="reference internal" href="usb_Running.html">Running scans</a></li>
<li class="toctree-l2"><a class="reference internal" href="usb_QuickAssess.html">Initial assessment of your data</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">xpdAcq Configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#funtionality-related-options">Funtionality related options</a></li>
<li class="toctree-l3"><a class="reference internal" href="#device-related-options">Device-related options</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="beamlinestaff.html">For Beamline Staff</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="release_note.html">Release Notes</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><a href="xpdusers.html">For XPD Users</a> »</li>
<li>xpdAcq Configuration</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/usb_GlobalOptions.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="xpdacq-configuration">
<span id="usb-globaloptions"></span><h1>xpdAcq Configuration<a class="headerlink" href="#xpdacq-configuration" title="Permalink to this headline">¶</a></h1>
<p><code class="docutils literal"><span class="pre">xpdAcq</span></code> uses <code class="docutils literal"><span class="pre">glbl</span></code> and <code class="docutils literal"><span class="pre">xpd_configuration</span></code> to controls the overall behavior of the beamtime.
All of the values of the <code class="docutils literal"><span class="pre">glbl</span></code> and <code class="docutils literal"><span class="pre">xpd_configuration</span></code> have reasonable default values, but these can be interrogated and overwritten.</p>
<div class="section" id="funtionality-related-options">
<h2>Funtionality related options<a class="headerlink" href="#funtionality-related-options" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><p>Functionality related options are managed by <code class="docutils literal"><span class="pre">glbl</span></code> and you can
interrogate the default values by typing:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">glbl</span>
</pre></div>
</div>
<p>You can also change them if needed. Here are few possible scenarios:</p>
<p><strong>No automated dark collection logic at all:</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">glbl</span><span class="p">[</span><span class="s1">'auto_dark'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">glbl</span><span class="p">[</span><span class="s1">'shutter_control'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">False</span>
</pre></div>
</div>
<p><strong>Want a fresh dark frame every time ``xrun`` is triggered:</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">glbl</span><span class="p">[</span><span class="s1">'dk_window'</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.1</span> <span class="c1"># dark window is 0.1 min = 6 secs</span>
</pre></div>
</div>
<p><strong>Want a 0.2s exposure time per frame instead of 0.1s:</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">glbl</span><span class="p">[</span><span class="s1">'frame_acq_time'</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.2</span>
</pre></div>
</div>
<p>changes made to <code class="docutils literal"><span class="pre">glbl</span></code> will be recovered after coming back to <code class="docutils literal"><span class="pre">ipython</span></code> session.
So you don’t have to redo the changes from time to time.</p>
</div></blockquote>
</div>
<div class="section" id="device-related-options">
<span id="usb-deviceoptions"></span><h2>Device-related options<a class="headerlink" href="#device-related-options" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><p>Device related configurations are stored in <code class="docutils literal"><span class="pre">xpd_configuration</span></code>
and you can interrogate the default values by typing:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">xpd_configuration</span>
</pre></div>
</div>
<p>You may also change the defaults:</p>
<p><strong>Want to run temperature ramp with different device:</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">xpd_configuration</span><span class="p">[</span><span class="s1">'temp_controller'</span><span class="p">]</span> <span class="o">=</span> <span class="n">eurotherm</span>
</pre></div>
</div>
<p><strong>Want to use alternative shutter:</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">xpd_configuration</span><span class="p">[</span><span class="s1">'shutter'</span><span class="p">]</span> <span class="o">=</span> <span class="n">shctl2</span>
</pre></div>
</div>
<p>All of the changes applied to <code class="docutils literal"><span class="pre">xpd_configuration</span></code> only lives
within one <code class="docutils literal"><span class="pre">ipython</span></code> session. So if you exit out the terminal and
come back, remeber to repeat the configuration step <em>again</em>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">desired objects (<code class="docutils literal"><span class="pre">eurotherm</span></code> and <code class="docutils literal"><span class="pre">shctl2</span></code> above, for example) should be properly <em>configured</em>. How to properly configure a device is beyond the scode of this website, if you have specific requests, please contact beamline staff for more details.</p>
</div>
</div></blockquote>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="beamlinestaff.html" class="btn btn-neutral float-right" title="For Beamline Staff" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="usb_QuickAssess.html" class="btn btn-neutral" title="Initial assessment of your data" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<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.5',
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>