bluesky.suspenders.SuspendFloor#
- class bluesky.suspenders.SuspendFloor(signal, suspend_thresh, *, resume_thresh=None, **kwargs)[source]#
Suspend when a scalar falls below a threshold.
Optionally, the threshold to resume can be set to be greater than the threshold to suspend.
- Parameters:
- signalophyd.Signal
The signal to watch for changes to determine if the scan should be suspended
- suspend_threshfloat
Suspend if the signal value falls below this value
- resume_threshfloat, optional
Resume when the signal value rises above this value. If not given set to suspend_thresh. Must be greater than suspend_thresh.
- sleepfloat, optional
How long to wait in seconds after the resume condition is met before marking the event as done. Defaults to 0
- pre_planiterable or iterator, optional
a generator, list, or similar containing Msg objects
- post_planiterable 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