dodal.plans

Functions

count(detectors[, num, delay, metadata])	Reads from a number of devices.
spec_scan(detectors, spec[, metadata])	Generic plan for reading detectors at every point of a ScanSpec Spec.

dodal.plans.count(detectors: set[Readable], num: int = 1, delay: float | Sequence[float] = 0.0, metadata: dict[str, Any] | None = None) → Generator[Msg, Any, P]

Reads from a number of devices. Wraps bluesky.plans.count(det, num, delay, md=metadata) exposing only serializable parameters and metadata.

Parameters:

• detectors (set[Readable])

• num (int, default: 1)

• delay (Union[float, Sequence[float]], default: 0.0)

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

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]

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)]