pyrfu.mms.vdf_omni module#

pyrfu.mms.vdf_omni.vdf_omni(vdf, method: str = 'mean')[source]#

Computes omni-directional distribution, without changing the units.

Parameters:
  • vdf (xarray.Dataset) –

    Time series of the 3D velocity distribution with :
    • time : Time samples.

    • data : 3D velocity distribution.

    • energy : Energy levels.

    • phi : Azimuthal angles.

    • theta : Elevation angle.

  • method ({"mean", "sum"}, Optional) – Method of computation. Use “sum” for counts and “mean” for everything else. Default is “mean”.

Returns:

out – Time series of the omnidirectional velocity distribution function.

Return type:

xarray.DataArray