id4_common.plans.local_preprocessors#

Local decorators

Module Contents#

id4_common.plans.local_preprocessors.extra_devices_wrapper(plan, extras)#: Stage extra devices during a plan without adding them to the plot hints.

id4_common.plans.local_preprocessors.configure_counts_wrapper(plan, detectors, count_time)#

Set all devices with a preset_monitor to the same value.

The original setting is stashed and restored at the end.

Parameters:

plan (iterable or iterator) – a generator, list, or similar containing Msg objects
monitor (float or None) – If None, the plan passes through unchanged.

Yields:

msg (Msg) – messages from plan, with ‘set’ messages inserted

id4_common.plans.local_preprocessors.stage_dichro_wrapper(plan, dichro, lockin, sgz, positioner)#

Stage dichoic scans.

Parameters:

plan (iterable or iterator) – a generator, list, or similar containing Msg objects
dichro (boolean) – Flag that triggers the stage/unstage process of dichro scans.
lockin (boolean) – Flag that triggers the stage/unstage process of lockin scans.

Yields:

msg (Msg) – messages from plan, with ‘subscribe’ and ‘unsubscribe’ messages inserted and appended

id4_common.plans.local_preprocessors.stage_magnet911_wrapper(plan, magnet, persistent=True)#

Stage the 911T magnet.

Turns on/off the persistence switch heater before/after the magnetic field scan or move.

Parameters:

plan (iterable or iterator) – a generator, list, or similar containing Msg objects
magnet (boolean) – Flag that triggers the stage/unstage.

Yields:

msg (Msg) – messages from plan, with ‘subscribe’ and ‘unsubscribe’ messages inserted and appended

id4_common.plans.local_preprocessors.stage_4idg_softglue_wrapper(plan, use_sg)#: Stage the 4IDG SoftGlue FPGA for fly-scan position streaming.