pyrfu.pyrf.ts_skymap module#

pyrfu.pyrf.ts_skymap.ts_skymap(time: ndarray[tuple[int, ...], dtype[datetime64]], data: ndarray[tuple[int, ...], dtype[float32 | float64]], energy: ndarray[tuple[int, ...], dtype[float32 | float64]], phi: ndarray[tuple[int, ...], dtype[float32 | float64]], theta: ndarray[tuple[int, ...], dtype[float32 | float64]], energy0: ndarray[tuple[int, ...], dtype[float32 | float64]] | None = None, energy1: ndarray[tuple[int, ...], dtype[float32 | float64]] | None = None, esteptable: ndarray[tuple[int, ...], dtype[uint8]] | None = None, attrs: Mapping[str, object] | None = None, glob_attrs: Mapping[str, object] | None = None, coords_attrs: Mapping[str, Mapping[str, Iterable[Any]]] | None = None) Dataset[source]#

Creates a skymap of the distribution function.

Parameters:
  • time (np.ndarray) – List of times.

  • data (np.ndarray) – Values of the distribution function.

  • energy (np.ndarray) – Energy levels.

  • phi (np.ndarray) – Azimuthal angles.

  • theta (np.ndarray) – Elevation angles.

  • energy0 (np.ndarray, Optional) – Energy table 0 (odd time indices).

  • energy1 (np.ndarray, Optional) – Energy table 1 (even time indices).

  • esteptable (np.ndarray, Optional) – Time series of the stepping table between energies (burst).

  • attrs (dict, Optional) – Metadata for the VDF.

  • glob_attrs (dict, Optional) – Global attributes of the dataset.

  • coords_attrs (dict, Optional) – Coordinates attributes of the dataset.

Returns:

out – Skymap of the distribution function.

Return type:

xarray.Dataset

Raises:
  • TypeError – If time, data, energy, phi, or theta are not numpy.ndarray.

  • TypeError – If energy0, energy1, or esteptable are not numpy.ndarray.

  • TypeError – If attrs, glob_attrs, or coords_attrs are not dict.