SpiralNavigator.fit

SpiralNavigator.fit#

SpiralNavigator.fit()[source]#

Return the navigator count that fits a time window.

Parameters:

  • window (float) – Dead time available (s).

  • requested (int or str, default='auto') – "auto" takes as many as fit, up to limit; an integer requests exactly that many and raises if they do not fit.

  • limit (int, default=None) – Ceiling on the "auto" count. Ignored for an explicit integer request.

Returns:

Navigators to play.

Return type:

int

Raises:

ValueError – If requested is negative, or exceeds the number that fits in window.