bluesky.plans.rel_spiral

bluesky.plans.rel_spiral(detectors, x_motor, y_motor, x_range, y_range, dr, nth, *, dr_y=None, tilt=0.0, per_step=None, md=None)[source]

Relative spiral scan

Parameters:
x_motorobject

any ‘settable’ object (motor, temp controller, etc.)

y_motorobject

any ‘settable’ object (motor, temp controller, etc.)

x_rangefloat

x width of spiral

y_rangefloat

y width of spiral

drfloat

Delta radius along the minor axis of the ellipse.

dr_yfloat, optional

Delta radius along the major axis of the ellipse. If None, it defaults to dr.

nthfloat

Number of theta steps

tiltfloat, optional

Tilt angle in radians, default 0.0

per_stepcallable, optional

hook for customizing action of inner loop (messages per step). See docstring of bluesky.plan_stubs.one_nd_step() (the default) for details.

mddict, optional

metadata