id4_common.plans.move_plans#

Local move plans: mv, mvr, abs_set.

Thin wrappers around the corresponding bluesky plan stubs that also stage the 9-Tesla magnet (magnet911) when its field is one of the targets.

Module Contents#

id4_common.plans.move_plans.mv(*args, **kwargs)#

Move one or more devices to a setpoint, and wait for all to complete.

This is a local version of bluesky.plan_stubs.mv. If more than one device is specifed, the movements are done in parallel.

Parameters:

  • args – device1, value1, device2, value2, …

  • kwargs – passed to bluesky.plan_stubs.mv

Yields:

msg (Msg)

See also

bluesky.plan_stubs.mv()

id4_common.plans.move_plans.mvr(*args, **kwargs)#

Move one or more devices to a relative setpoint. Wait for all to complete.

If more than one device is specified, the movements are done in parallel.

This is a local version of bluesky.plan_stubs.mvr.

Parameters:

  • args – device1, value1, device2, value2, …

  • kwargs – passed to bluesky.plan_stub.mvr

Yields:

msg (Msg)

See also

bluesky.plan_stubs.rel_set(), bluesky.plan_stubs.mv()

id4_common.plans.move_plans.abs_set(*args, **kwargs)#

Set a value. Optionally, wait for it to complete before continuing.

This is a local version of bluesky.plan_stubs.abs_set. If more than one device is specifed, the movements are done in parallel.

Parameters:

  • obj (Device)

  • group (string (or any hashable object), optional) – identifier used by ‘wait’

  • wait (boolean, optional) – If True, wait for completion before processing any more messages. False by default.

  • args – passed to obj.set()

  • kwargs – passed to obj.set()

Yields:

msg (Msg)

See also

bluesky.plan_stubs.rel_set(), bluesky.plan_stubs.wait(), bluesky.plan_stubs.mv()