Development documentation · 0.2.3 30c2f8ba · Intro examples tested with 0.2.3 · Version details · Known limitations

gwexpy.interop.frequency

Functions

from_hdf5_frequencyseries(cls, group, path)	Read a FrequencySeries from an HDF5 group.
from_pandas_frequencyseries(cls, series, *)	Create a FrequencySeries from a pandas Series.
from_xarray_frequencyseries(cls, da, *[, ...])	Create a FrequencySeries from an xarray DataArray.
to_hdf5_frequencyseries(fs, group, path[, ...])	Write a FrequencySeries to an HDF5 group.
to_pandas_frequencyseries(fs[, index, name, ...])	Convert a FrequencySeries to a pandas Series.
to_xarray_frequencyseries(fs[, freq_coord])	Convert a FrequencySeries to an xarray DataArray.

gwexpy.interop.frequency.to_pandas_frequencyseries(fs: FrequencySeries, index: Literal['frequency'] = 'frequency', name: str | None = None, copy: bool = False) → pd.Series

Convert a FrequencySeries to a pandas Series.

gwexpy.interop.frequency.from_pandas_frequencyseries(cls: type[T], series: pd.Series, *, unit: str | None = None, frequencies: Any | None = None, df: float | None = None, f0: float | None = None, epoch: Any | None = None) → T

Create a FrequencySeries from a pandas Series.

gwexpy.interop.frequency.to_xarray_frequencyseries(fs: FrequencySeries, freq_coord: Literal['Hz'] = 'Hz') → xr.DataArray

Convert a FrequencySeries to an xarray DataArray.

gwexpy.interop.frequency.from_xarray_frequencyseries(cls: type[T], da: xr.DataArray, *, unit: str | None = None, freq_coord: str = 'frequency', epoch: Any | None = None) → T

Create a FrequencySeries from an xarray DataArray.

gwexpy.interop.frequency.to_hdf5_frequencyseries(fs: FrequencySeries, group: h5py.Group, path: str, overwrite: bool = False, compression: str | None = None, compression_opts: Any = None) → None

Write a FrequencySeries to an HDF5 group.

gwexpy.interop.frequency.from_hdf5_frequencyseries(cls: type[T], group: h5py.Group, path: str) → T

Read a FrequencySeries from an HDF5 group.