Module quantum_inferno.utilities.sampling

This module contains methods used in resampling signals

Functions

def decimate_timeseries(timeseries: numpy.ndarray, decimation_factor: int) ‑> numpy.ndarray

Decimate a time series by a given factor using scipy.signal.decimate. Timeseries must be 28 samples or longer.

:param timeseries: input signal :param decimation_factor: factor to decimate by :return: decimated signal

def decimate_timeseries_collection(timeseries_collection: numpy.ndarray, decimation_factor: int) ‑> numpy.ndarray

Decimate a collection of time series with the same sample rate at once using scipy.signal.decimate. Each timeseries must be 28 samples or longer.

:param timeseries_collection: input signal :param decimation_factor: factor to decimate by :return: decimated signal

def resample_uneven_timeseries(timeseries: numpy.ndarray, timestamps_s: numpy.ndarray, new_sample_rate_hz: float = None) ‑> Tuple[numpy.ndarray, float]

Resample uneven time series using linear interpolation. If new_sample_rate_hz is None, the new sample rate is the average sample rate of the input signal.

:param timeseries: input signal :param timestamps_s: timestamps of the input signal in seconds :param new_sample_rate_hz: the sample rate to resample to in Hz (default is None) :return: resampled signal and new sample rate

def resample_with_sample_rate(timeseries: numpy.ndarray, sample_rate_hz: float, new_sample_rate_hz: float) ‑> Tuple[numpy.ndarray, float]

Resample a time series to a new sample rate using scipy.signal.resample.

:param timeseries: input signal :param sample_rate_hz: sample rate of the input signal :param new_sample_rate_hz: the sample rate to resample to in Hz :return: resampled signal and new sample rate

def subsample(timeseries: numpy.ndarray, sample_rate_hz: float, subsample_factor: int, method: str = 'nth') ‑> Tuple[numpy.ndarray, float]

Subsample a time series by given method (default is every nth sample). Truncates the signal if the length is not divisible by the subsample factor, except for the nth method. if subsample_factor is less than 2, return the original signal.

:param timeseries: input signal :param sample_rate_hz: sample rate of the signal :param subsample_factor: factor to subsample by (returns every nth sample) :param method: method to use for subsampling :return: subsampled signal and new sample rate

def subsample_2d(array: numpy.ndarray, subsample_factor: int, method: str = 'nth') ‑> numpy.ndarray

Subsample a 2D array along the second axis. Truncates the signal if the length is not divisible by the subsample factor. if subsample_factor is less than 2, return the original signal.

:param array: input 2D array :param subsample_factor: factor to subsample :param method: method to use for subsampling (default is every nth sample) :return: subsampled 2D array