bluesky.plans.spiral¶

bluesky.plans.spiral(detectors, x_motor, y_motor, x_start, y_start, x_range, y_range, dr, nth, *, tilt=0.0, per_step=None, md=None)¶

Spiral scan, centered around (x_start, y_start)

Parameters:

x_motor (object) – any ‘setable’ object (motor, temp controller, etc.)
y_motor (object) – any ‘setable’ object (motor, temp controller, etc.)
x_start (float) – x center
y_start (float) – y center
x_range (float) – x width of spiral
y_range (float) – y width of spiral
dr (float) – Delta radius
nth (float) – Number of theta steps
tilt (float, optional) – Tilt angle in radians, default 0.0
per_step (callable, optional) – hook for cutomizing action of inner loop (messages per step) See docstring of bluesky.plans.one_nd_step (the default) for details.
md (dict, optional) – metadata