bluesky.plans.rel_adaptive_scan#

bluesky.plans.rel_adaptive_scan(detectors: Sequence[Readable], target_field: str, motor: Movable, start: float, stop: float, min_step: float, max_step: float, target_delta: float, backstep: bool, threshold: float | None = 0.8, *, md: dict[str, Any] | None = None) → Generator[Msg, Any, str][source]#

Relative scan over one variable with adaptively tuned step size.

Parameters:

detectorslist or tuple: list of ‘readable’ objects
target_fieldstring: data field whose output is the focus of the adaptive tuning
motorobject: any ‘settable’ object (motor, temp controller, etc.)
startfloat: starting position of motor
stopfloat: ending position of motor
min_stepfloat: smallest step for fast-changing regions
max_stepfloat: largest step for slow-chaning regions
target_deltafloat: desired fractional change in detector signal between steps
backstepbool: whether backward steps are allowed – this is concern with some motors
thresholdfloat, optional: threshold for going backward and rescanning a region, default is 0.8
mddict, optional: metadata