bluesky.plans.spiral_square#
- bluesky.plans.spiral_square(detectors: Sequence[Readable], x_motor: NamedMovable, y_motor: NamedMovable, x_center: float, y_center: float, x_range: float, y_range: float, x_num: float, y_num: float, *, per_step: Callable[[Sequence[Readable], Movable, Any, Callable[[Sequence[Readable]], Generator[Msg, Any, Mapping[str, Reading]]] | None], Generator[Msg, Any, P]] | Callable[[Sequence[Readable], Mapping[Movable, Any], dict[Movable, Any], Callable[[Sequence[Readable]], Generator[Msg, Any, Mapping[str, Reading]]] | None], Generator[Msg, Any, P]] | None = None, md: dict[str, Any] | None = None) Generator[Msg, Any, str][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
See also
bluesky.plans.relative_spiral_square()bluesky.plans.spiral()bluesky.plans.relative_spiral()bluesky.plans.spiral_fermat()bluesky.plans.relative_spiral_fermat()