pyrfu.mms.vdf_reduce module#

pyrfu.mms.vdf_reduce.vdf_frame_transformation(vdf, v_gse)[source]#

Move the skymap into the desired frame associated with the bulk velocity v_gse.

Parameters:
Returns:

out – Skymap distribution into the new frame.

Return type:

xarray.Dataset

Notes

The new skymap grid is identical to the original one. The bulk velocity must be in the same coordinates system as the skymap (i.e spacecraft for FPI and GSE for EIS)

See also

_interp_skymap_cart.py, _interp_skymap_sphe.py

pyrfu.mms.vdf_reduce.vdf_reduce(vdf, tint, dim, x_vec, z_vec: list | None = None, v_int: list | None = None, n_vpt: int = 100)[source]#

Interpolate the skymap distribution onto the velocity grid defined by the velocity interval v_int along the axes x_vec and z_vec, and reduce (integrate) it along 1 (if dim is “2d”) or 2 (if dim is “1d”).

Parameters:

  • vdf (xarray.Dataset) – Skymap distribution to reduce.

  • tint (list of strs) – Time interval over which the time series of the skymap distribution is averaged.

  • dim ({"1d", "2d"}) – Dimension of the output reduced distribution.

  • x_vec (array_like) – X axis. For the “1d” case, it is the axis on which the skymap is plotted. For the “2d” case, it is the first of the two axes on which the skymap is plotted.

  • z_vec (array_like, Optional) – Axis along which the skymap is integrated. Needed only for the “2d” case.

  • v_int (array_like, Optional) – Velocity interval.

  • n_vpt (int, Optional) – Number of points along the plot direction(s).

Returns:

out – Reduced distribution.

Return type:

xarray.DataArray