sensortoolkit.datetime_utils._get_timestamp_interval.get_timestamp_interval

get_timestamp_interval(df, warning=False, as_timedelta=False)[source]

Compute recording interval for dataframe.

Compute time delta between successive timestamps and take the mode of recorded time deltas to be the device recording interval.

Parameters

df (pandas dataframe) – A dataframe with time-like index.

Returns

A string describing the most common (mode) recording interval in the dataframe.

Return type

interval_str (str)