calculate_sampling_rate

brainsets.utils.misc_utils.calculate_sampling_rate(timestamps, rtol=0.001)[source]

Calculates median sampling rate from an array of timestamps.

Parameters:

  • timestamps (ndarray) – 1D array of timestamps in seconds, expected to be monotonically increasing.

  • rtol (float) – Maximum allowed relative variation in sampling interval, defined as (max_diff - min_diff) / median_diff. Defaults to 1e-3.

Returns:

Sampling rate in Hz.

Return type:

float

Raises:

  • ValueError – If fewer than 2 timestamps are provided.

  • ValueError – If the timestamps are not strictly monotonically increasing.

  • ValueError – If the timestamps are not uniformly sampled within the given relative tolerance.