perda.units#

class perda.units.Timescale(*values)[source]#

Bases: Enum

Supported timestamp units for time-series data.

MS = 'ms'#
S = 's'#
US = 'us'#
perda.units.convert_time(timestamp, source_time_unit, target_time_unit)[source]#

Convert a timestamp between two timescale units.

Parameters:

  • timestamp (float | NDArray) – Timestamp(s) to convert.

  • source_time_unit (Timescale) – Unit of the input timestamp.

  • target_time_unit (Timescale) – Desired output unit.

Returns:

Timestamp(s) in the target unit.

Return type:

float | NDArray

Examples

>>> convert_time(5000.0, Timescale.MS, Timescale.S)
5.0
perda.units.mph_seconds_to_meters(value)[source]#

Convert a value in mph·s (e.g. integrated speed) to meters.

Parameters:

value (float | NDArray) – Value in mph·s, such as the result of integrating a speed signal in mph over a time axis in seconds.

Returns:

Equivalent distance in meters.

Return type:

float | NDArray

Examples

>>> mph_seconds_to_meters(3600.0)
1609.34