bluesky.suspenders.SuspendWhenOutsideBand

class bluesky.suspenders.SuspendWhenOutsideBand(signal, band_bottom, band_top, **kwargs)[source]

Suspend when a scalar signal leaves a given band of values.

Parameters:
signalophyd.Signal

The signal to watch for changes to determine if the scan should be suspended

band_bottom, band_topfloat

The top and bottom of the band. band_top must be strictly greater than band_bottom.

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, band_bottom, band_top, **kwargs)

Methods

__init__(signal, band_bottom, band_top, **kwargs)

get_futures()

Return a list of futures to wait on.

install(RE, *[, event_type])

Install callback on signal

remove()

Disable the suspender

Attributes

tripped