bluesky.plan_stubs.collect

bluesky.plan_stubs.collect(obj, *, stream=False, return_payload=True)[source]

Collect data cached by a fly-scanning device and emit documents.

Parameters
objfly-able

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.

Yields
msgMsg

Msg(‘collect’, obj)