fsdata§

typed_lisa_toolkit.fsdata(mapping: Mapping[str, FrequencySeries[Axis[Linspace, ModuleType]]], /, *, times: Axis[Array[Any, ModuleType] | ndarray[tuple[Any, ...], dtype[Any]] | Linspace, ModuleType] | Array[Any, ModuleType] | ndarray[tuple[Any, ...], dtype[Any]] | Linspace, name: str | None = None) → TimedFSData[source]§
typed_lisa_toolkit.fsdata(mapping: Mapping[str, FrequencySeries[Axis[Linspace, ModuleType]]], /, *, name: str | None = None) → FSData
typed_lisa_toolkit.fsdata(*, frequencies: Axis[Array[Any, ModuleType] | ndarray[tuple[Any, ...], dtype[Any]] | Linspace, ModuleType] | Array[Any, ModuleType] | ndarray[tuple[Any, ...], dtype[Any]] | Linspace, entries: Array[Any, ModuleType] | ndarray[tuple[Any, ...], dtype[Any]], channels: tuple[str, ...], times: None = None, name: str | None = None) → FSData
typed_lisa_toolkit.fsdata(*, frequencies: Axis[Array[Any, ModuleType] | ndarray[tuple[Any, ...], dtype[Any]] | Linspace, ModuleType] | Array[Any, ModuleType] | ndarray[tuple[Any, ...], dtype[Any]] | Linspace, entries: Array[Any, ModuleType] | ndarray[tuple[Any, ...], dtype[Any]], channels: tuple[str, ...], times: Axis[Array[Any, ModuleType] | ndarray[tuple[Any, ...], dtype[Any]] | Linspace, ModuleType] | Array[Any, ModuleType] | ndarray[tuple[Any, ...], dtype[Any]] | Linspace, name: str | None = None) → TimedFSData

Construct FSData or TimedFSData.

This function provides two mutually exclusive construction ways:

First, from a positional-only mapping argument:

Parameters:

  • mapping – A mapping from channel names to FrequencySeries with Linspace axes.

  • times (Axis, optional) – A uniform array of shape (n_times,) or a Linspace object representing the associated time grid of the data. Returns a TimedFSData if provided, otherwise returns a FSData.

  • name (str, optional) – Name of the data.

Second, from several keyword arguments:

Parameters:

  • frequencies (Axis) – A uniform array of shape (n_freqs,) or a Linspace object representing the frequency grid of the data.

  • entries (AnyArray) – A array of shape (n_batch, n_channels, n_harmonics, n_features, Nf) where Nf is the size of frequencies. See the convention for more details.

  • channels – A tuple of channel names in the data.

  • times (Axis, optional) – A uniform array of shape (n_times,) or a Linspace object representing the associated time grid of the data. Returns a TimedFSData if provided, otherwise returns a FSData.

  • name (str, optional) – Name of the data.

Note

The associated time grid does not count as a grid dimension of the data, hence the shape of entries does include the time dimension.