bluesky.plan_stubs.collect_while_completing#

bluesky.plan_stubs.collect_while_completing(flyers, dets, flush_period=None, stream_name=None)[source]#

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.

Yields:
msgMsg

A ‘complete’ message or ‘collect’ message