parse_time#

pypillometry.parse_time(value, to='ms', default='ms', fs=None)[source]#

Convert a time (or tuple/array of times) to unit to.

Parameters:

  • value (float, array-like, str, Quantity, tuple or None) – time value(s), e.g. 500, "2 sec", 3 * u.min, (-200, 800) * u.ms or ("1 min", "2 min")

  • to (str or Unit, optional) – target unit; default “ms”

  • default (str, Unit or None, optional) – unit of plain numbers; default “ms”. If None, plain numbers raise a ValueError.

  • fs (float, optional) – sampling rate in Hz; needed to convert from or to “samples”

Return type:

float, ndarray or None

Returns:

the value in unit to (an ndarray for tuples, lists and arrays)

Examples

>>> parse_time("2 sec")
2000.0
>>> parse_time(3 * u.min, to="sec")
180.0
>>> parse_time((-200, 800), to="sec")
array([-0.2,  0.8])
>>> parse_time(10 * u.samples, fs=500)
20.0