mth5.processing.spectre.stft

This module has methods for applying the short-time-Fourier-transform.

Functions

run_ts_to_stft_scipy(...)

Converts a runts object into a time series of Fourier coefficients.

Module Contents

mth5.processing.spectre.stft.run_ts_to_stft_scipy(decimation_obj: mt_metadata.processing.aurora.decimation_level.DecimationLevel | mt_metadata.processing.fourier_coefficients.Decimation, run_xrds_orig: xarray.Dataset) → mth5.timeseries.spectre.spectrogram.Spectrogram[source]

Converts a runts object into a time series of Fourier coefficients. This method uses scipy.signal.spectrogram.

TODO: consider making this a method of RunTS; runts.to_spectrogram(decimation_obj)

Parameters:

  • decimation_obj (Union[AuroraDecimationLevel, FCDecimation]) – Information about how the decimation level is to be processed

  • run_xrds_orig (: xarray.core.dataset.Dataset) – Time series to be processed

Returns:

stft_obj – Time series of Fourier coefficients

Return type:

xarray.core.dataset.Dataset