bluesky.suspenders.SuspendCeil

class bluesky.suspenders.SuspendCeil(signal, suspend_thresh, *, resume_thresh=None, **kwargs)

Suspend when a scalar rises above a threshold.

Optionally, the threshold to resume can be set to be less than the threshold to suspend.

Parameters:
  • signal (ophyd.Signal) – The signal to watch for changes to determine if the scan should be suspended
  • suspend_thresh (float) – Suspend if the signal value falls below this value
  • resume_thresh (float, optional) – Resume when the signal value rises above this value. If not given set to suspend_thresh. Must be greater than suspend_thresh.
  • sleep (float, optional) – How long to wait in seconds after the resume condition is met before marking the event as done. Defaults to 0
  • pre_plan (iterable or iterator, optional) – a generator, list, or similar containing Msg objects
  • post_plan (iterable or iterator, optional) – a generator, list, or similar containing Msg objects
__init__(signal, suspend_thresh, *, resume_thresh=None, **kwargs)

Methods

__init__(signal, suspend_thresh, *[, ...])
get_futures() Return a list of futures to wait on.
install(RE, *[, event_type]) Install callback on signal
remove() Disable the suspender

Attributes

tripped