bluesky.preprocessors.relative_set_wrapper

bluesky.preprocessors.relative_set_wrapper(plan, devices=None)[source]

Interpret ‘set’ messages on devices as relative to initial position.

Parameters:
planiterable or iterator

a generator, list, or similar containing Msg objects

devicescollection or None, optional

if default (None), apply to all devices that are moved by the plan

Yields:
msgMsg

messages from plan, with ‘read’ messages inserted and ‘set’ messages mutated