bluesky.plan_stubs.collect

bluesky.plan_stubs.collect(obj: Flyable, *args, stream: bool = False, return_payload: bool = True, name: str | None = None) → Generator[Msg, Any, list[PartialEvent]]

Collect data cached by one or more fly-scanning devices and emit documents.

Parameters:

objA device with ‘kickoff’, ‘complete’, and ‘collect’ methods.

streamboolean, optional

If False (default), emit Event documents in one bulk dump. If True, emit events one at time.

return_payload: boolean, optional

If True (default), return the collected Events. If False, return None. Using stream=True and return_payload=False together avoids accumulating the documents in memory: they are emitted as they are collected, and they are not accumulated.

name: str, optional

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

Yields:

msgMsg

Msg(‘collect’, obj)

See also

bluesky.plan_stubs.kickoff()

bluesky.plan_stubs.complete()

bluesky.plan_stubs.wait()