pyrfu.mms.reduce module#

pyrfu.mms.reduce.reduce(vdf, xyz, dim: str = '1d', base: str = 'pol', **kwargs)[source]#

Reduces (integrates) 3D distribution to 1D (line) or 2D (plane). Draft do not use!!

Parameters:
  • vdf (xarray.Dataset) – 3D skymap velocity distribution function.

  • xyz (xarray.DataArray or numpy.ndarray) – Transformation matrix from instrument frame to desired frame.

  • base (str, Optional) – Base for the 2D projection either cartesian ‘cart’ (default) or polar ‘pol’.

  • **kwargs – Keyword arguments

Returns:

out – Time series of reduced velocity distribution function.

Return type:

xarray.DataArray