bluesky.plans.spiral_square¶

bluesky.plans.spiral_square(detectors, x_motor, y_motor, x_center, y_center, x_range, y_range, x_num, y_num, *, per_step=None, md=None)[source]¶

Absolute square spiral scan, centered around (x_center, y_center)

Parameters

detectorslist: list of ‘readable’ objects
x_motorobject: any ‘settable’ object (motor, temp controller, etc.)
y_motorobject: any ‘settable’ object (motor, temp controller, etc.)
x_centerfloat: x center
y_centerfloat: y center
x_rangefloat: x width of spiral
y_rangefloat: y width of spiral
x_numfloat: number of x axis points
y_numfloat: Number of y axis points.
per_stepcallable, optional: hook for cutomizing action of inner loop (messages per step). See docstring of bluesky.plans.one_nd_step() (the default) for details.
mddict, optional: metadata