bluesky.plan_stubs.collect_while_completing

bluesky.plan_stubs.collect_while_completing(flyers: Sequence[Flyable], dets: Sequence[Collectable], flush_period: float | None = None, stream_name: str | None = None, watch: Sequence[str] = ()) → Generator[Msg, Any, None]

Collect data from one or more fly-scanning devices and emit documents, then collect and emit data from one or more Collectable detectors until all are done.

Parameters:

flyers: An iterable sequence of fly-able devices with ‘kickoff’, ‘complete’ and

‘collect’ methods.

dets: An iterable sequence of collectable devices with ‘describe_collect’ method.

flush_period: float, int

Time period in seconds between each yield from collect while waiting for triggered objects to be done

stream_name: str, optional

If not None, will collect for the named string specifically, else collect will be performed on all streams.

watch: set of watch groups, optional

Additional groups to monitor while collecting from flyers.

Yields

——

msgMsg

A ‘complete’ message or ‘collect’ message

See also

bluesky.plan_stubs.complete()

bluesky.plan_stubs.collect()