nabs.optimize.walk_to_target

nabs.optimize.walk_to_target(signal, motor, target, tolerance, **kwargs)[source]

Walk the motor until a signal reaches our target

Similar to the maximize and minimize. There are options for multiple algorithms to dictate the scanning procedure. This may change the interpretation of values passed into this scanning procedure.

Parameters:
  • signal (ophyd.signal.Signal) – Signal to maximize

  • motor (ophyd.ophydobj.OphydObject) – Any set-able object

  • tolerance (float, optional) – The tolerance in which our motor is

  • average (int, optional) – Choice to take an average of points at each point in the scan

  • limits (tuple, optional) – Limit the region the scan will search within. If this is not provided, the soft limits of the signal will be used. In this case, these must be configured or the scan will not be allowed to continue.

  • method (str, optional) – Choice of optimization methods

  • md (dict, optional) – metadata