-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathbluesky.plans.relative_spiral.html
277 lines (172 loc) · 11.1 KB
/
bluesky.plans.relative_spiral.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
<!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>bluesky.plans.relative_spiral — bluesky 0.0.1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="bluesky 0.0.1 documentation" href="index.html"/>
<link rel="up" title="Plans" href="plans.html"/>
<link rel="next" title="bluesky.plans.relative_spiral_fermat" href="bluesky.plans.relative_spiral_fermat.html"/>
<link rel="prev" title="bluesky.plans.spiral_fermat" href="bluesky.plans.spiral_fermat.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"> bluesky
</a>
<div class="version">
0.0.1
</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 class="current">
<li class="toctree-l1 current"><a class="reference internal" href="plans.html">Plans</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="plans.html#standard-plans-ready-to-use">Standard Plans (ready to use)</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.count.html">bluesky.plans.count</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.scan.html">bluesky.plans.scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.relative_scan.html">bluesky.plans.relative_scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.list_scan.html">bluesky.plans.list_scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.relative_list_scan.html">bluesky.plans.relative_list_scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.log_scan.html">bluesky.plans.log_scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.relative_log_scan.html">bluesky.plans.relative_log_scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.inner_product_scan.html">bluesky.plans.inner_product_scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.outer_product_scan.html">bluesky.plans.outer_product_scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.relative_inner_product_scan.html">bluesky.plans.relative_inner_product_scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.relative_outer_product_scan.html">bluesky.plans.relative_outer_product_scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.scan_nd.html">bluesky.plans.scan_nd</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.spiral.html">bluesky.plans.spiral</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.spiral_fermat.html">bluesky.plans.spiral_fermat</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">bluesky.plans.relative_spiral</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.relative_spiral_fermat.html">bluesky.plans.relative_spiral_fermat</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.adaptive_scan.html">bluesky.plans.adaptive_scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.relative_adaptive_scan.html">bluesky.plans.relative_adaptive_scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.tweak.html">bluesky.plans.tweak</a></li>
<li class="toctree-l3"><a class="reference internal" href="bluesky.plans.fly.html">bluesky.plans.fly</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="plans.html#basic-usage">Basic Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="plans.html#stub-plans-ingredients-for-remixing">Stub Plans (ingredients for remixing)</a></li>
<li class="toctree-l2"><a class="reference internal" href="plans.html#combining-plans">Combining Plans</a></li>
<li class="toctree-l2"><a class="reference internal" href="plans.html#plan-context-managers">Plan Context Managers</a></li>
<li class="toctree-l2"><a class="reference internal" href="plans.html#plan-preprocessors">Plan Preprocessors</a></li>
<li class="toctree-l2"><a class="reference internal" href="plans.html#plan-utilities">Plan Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="plans.html#object-oriented-standard-plans">Object-Oriented Standard Plans</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="callbacks.html">Live Feedback and Processing</a></li>
<li class="toctree-l1"><a class="reference internal" href="state-machine.html">Interruptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="metadata.html">Recording Metadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="simple_api.html">(Optional) SPEC-like Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes.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">bluesky</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="plans.html">Plans</a> »</li>
<li>bluesky.plans.relative_spiral</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/bluesky.plans.relative_spiral.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="bluesky-plans-relative-spiral">
<h1>bluesky.plans.relative_spiral<a class="headerlink" href="#bluesky-plans-relative-spiral" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="bluesky.plans.relative_spiral">
<code class="descclassname">bluesky.plans.</code><code class="descname">relative_spiral</code><span class="sig-paren">(</span><em>detectors</em>, <em>x_motor</em>, <em>y_motor</em>, <em>x_range</em>, <em>y_range</em>, <em>dr</em>, <em>nth</em>, <em>*</em>, <em>tilt=0.0</em>, <em>per_step=None</em>, <em>md=None</em><span class="sig-paren">)</span><a class="headerlink" href="#bluesky.plans.relative_spiral" title="Permalink to this definition">¶</a></dt>
<dd><p>Relative spiral scan</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>x_motor</strong> (<em>object</em>) – any ‘setable’ object (motor, temp controller, etc.)</li>
<li><strong>y_motor</strong> (<em>object</em>) – any ‘setable’ object (motor, temp controller, etc.)</li>
<li><strong>x_start</strong> (<em>float</em>) – x center</li>
<li><strong>y_start</strong> (<em>float</em>) – y center</li>
<li><strong>x_range</strong> (<em>float</em>) – x width of spiral</li>
<li><strong>y_range</strong> (<em>float</em>) – y width of spiral</li>
<li><strong>dr</strong> (<em>float</em>) – Delta radius</li>
<li><strong>nth</strong> (<em>float</em>) – Number of theta steps</li>
<li><strong>tilt</strong> (<em>float, optional</em>) – Tilt angle in radians, default 0.0</li>
<li><strong>per_step</strong> (<em>callable, optional</em>) – hook for cutomizing action of inner loop (messages per step)
See docstring of bluesky.plans.one_nd_step (the default) for
details.</li>
<li><strong>md</strong> (<em>dict, optional</em>) – metadata</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><cite>bluesky.plans.spiral</cite>
<cite>bluesky.plans.spiral_fermat</cite></p>
</div>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="bluesky.plans.relative_spiral_fermat.html" class="btn btn-neutral float-right" title="bluesky.plans.relative_spiral_fermat" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="bluesky.plans.spiral_fermat.html" class="btn btn-neutral" title="bluesky.plans.spiral_fermat" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2015, Brookhaven National Lab.
</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.0.1',
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>