bluesky.plan_stubs.collect#

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

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

Parameters:

objA device with a ‘collect’ method.
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: