dodal.plans#

Functions

count(detectors[, num, delay, metadata])

Reads from a number of devices.

list_grid_rscan(detectors, params[, ...])

Scan independent trajectories, relative to current positions.

list_grid_scan(detectors, params[, ...])

Scan independent trajectories.

list_rscan(detectors, params[, metadata])

Scan concurrent trajector(y/ies), relative to current position.

list_scan(detectors, params[, metadata])

Scan concurrent single or multi-motor trajector(y/ies).

num_grid_rscan(detectors, params[, ...])

Scan independent trajectories, relative to current positions.

num_grid_scan(detectors, params[, ...])

Scan independent multi-motor trajectories.

num_rscan(detectors, params[, num, metadata])

Scan concurrent trajector(y/ies), relative to current position(s).

num_scan(detectors, params, num[, metadata])

Scan concurrent single or multi-motor trajector(y/ies).

spec_scan(detectors, spec[, metadata])

Generic plan for reading detectors at every point of a ScanSpec Spec.

step_grid_rscan(detectors, params[, ...])

Scan independent trajectories with specified step size, relative to position.

step_grid_scan(detectors, params[, ...])

Scan independent trajectories with specified step size.

step_rscan(detectors, params[, metadata])

Scan concurrent trajectories with specified step size, relative to position.

step_scan(detectors, params[, metadata])

Scan concurrent trajectories with specified step size.
dodal.plans.count(detectors: Sequence[Readable | AsyncReadable], num: int = 1, delay: float | Sequence[float] = 0.0, metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Reads from a number of devices.

Wraps bluesky.plans.count(det, num, delay, md=metadata) exposing only serializable parameters and metadata.

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.list_grid_rscan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], snake_axes: bool = True, metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan independent trajectories, relative to current positions.

The scan is defined by providing a list of points for each scan trajectory. Snakes all fast axes by default (all axes but the first axis provided). Wraps bluesky.plans.rel_list_grid_scan(det, *args, md=metadata).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.list_grid_scan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], snake_axes: bool = True, metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan independent trajectories.

The scan is defined by providing a list of points for each scan trajectory. Snakes all fast axes by default (all axes but the first axis provided). Wraps bluesky.plans.list_grid_scan(det, *args, md=metadata).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.list_rscan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan concurrent trajector(y/ies), relative to current position.

The scan is defined by providing a list of points for each scan trajectory. Wraps bluesky.plans.rel_list_scan(det, *args, md=metadata).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.list_scan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan concurrent single or multi-motor trajector(y/ies).

The scan is defined by providing a list of points for each scan trajectory. Wraps bluesky.plans.list_scan(det, *args, md=metadata).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.num_grid_rscan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], snake_axes: list | bool = True, metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan independent trajectories, relative to current positions.

The scan is defined by number of points along scan trajectories. Snakes all fast axes by default (all axes but the first axis provided). Wraps bluesky.plans.rel_grid_scan(det, *args, snake_axes, md=metadata).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.num_grid_scan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], snake_axes: list | bool = True, metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan independent multi-motor trajectories.

The scan is defined by number of points along scan trajectories. Snakes all fast axes by default (all axes but the first axis provided). Wraps bluesky.plans.grid_scan(det, *args, snake_axes, md=metadata).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.num_rscan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], num: int | None = None, metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan concurrent trajector(y/ies), relative to current position(s).

The scan is defined by number of points along scan trajector(y/ies). Wraps bluesky.plans.rel_scan(det, *args, num, md=metadata).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.num_scan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], num: int, metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan concurrent single or multi-motor trajector(y/ies).

The scan is defined by number of points along scan trajector(y/ies). Wraps bluesky.plans.scan(det, *args, num, md=metadata).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.spec_scan(detectors: set[Readable], spec: Spec[Movable], metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Generic plan for reading detectors at every point of a ScanSpec Spec. A Spec is an N-dimensional path.

Parameters:

  • detectors (set[Readable])

  • spec (Spec[Movable])

  • metadata (dict[str, Any] | None, default: None)

Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.step_grid_rscan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], snake_axes: bool = True, metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan independent trajectories with specified step size, relative to position.

Generates list(s) of points for each trajectory, used with bluesky.plans.list_grid_scan(det, *args, md=metadata). Snakes all fast axes by default (all axes but the first axis provided).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.step_grid_scan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], snake_axes: bool = True, metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan independent trajectories with specified step size.

Generates list(s) of points for each trajectory, used with bluesky.plans.list_grid_scan(det, *args, md=metadata). Snakes all fast axes by default (all axes but the first axis provided).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.step_rscan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan concurrent trajectories with specified step size, relative to position.

Generates list(s) of points for each trajectory, used with bluesky.plans.rel_list_scan(det, *args, md=metadata).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]

dodal.plans.step_scan(detectors: Sequence[Readable | AsyncReadable], params: list[tuple[Movable, list[float | int]]], metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P][source]#

Scan concurrent trajectories with specified step size.

Generates list(s) of points for each trajectory, used with bluesky.plans.list_scan(det, *args, md=metadata).

Parameters:
Return type:

Generator[Msg, Any, TypeVar(P)]