bluesky.plans.scan

bluesky.plans.scan(detectors: Sequence[Readable], *args: Movable | Any, num: int | None = None, 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]

Scan over one multi-motor trajectory.

Parameters:

detectorslist or tuple

list of ‘readable’ objects

*args

For one dimension, motor, start, stop. In general:

motor1, start1, stop1,
motor2, start2, stop2,
...,
motorN, startN, stopN

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

numinteger

number of points

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

See also

bluesky.plans.relative_inner_product_scan()

bluesky.plans.grid_scan()

bluesky.plans.scan_nd()