pyrfu.pyrf.mean module#
- pyrfu.pyrf.mean.mean(inp, r_xyz, b_xyz, dipole_axis: DataArray | None = None)[source]#
Put inp into mean field coordinates defined by position vector r and magnetic field b if earth magnetic dipole axis z is given then uses another algorithm (good for auroral passages)
- Parameters:
inp (xarray.DataArray) – Input field to put into MF coordinates.
r_xyz (xarray.DataArray) – Time series of the spacecraft position.
b_xyz (xarray.DataArray) – Time series of the background magnetic field.
dipole_axis (xarray.DataArray, Optional) – Earth magnetic dipole axis.
- Returns:
out – Input field in mean field coordinates.
- Return type: