pyrfu.mms.calculate_epsilon module#
- pyrfu.mms.calculate_epsilon.calculate_epsilon(vdf: Dataset, model_vdf: Dataset, n_s: DataArray, sc_pot: DataArray, en_channels: list | None = None) DataArray [source]#
Calculate epsilon parameter using model distribution.
- Parameters:
vdf (Dataset) – Observed particle distribution (skymap).
model_vdf (Dataset) – Model particle distribution (skymap).
n_s (DataArray) – Time series of the number density.
sc_pot (DataArray) – Time series of the spacecraft potential.
en_channels (list, Optional) – Set energy channels to integrate over [min max]; min and max between must be between 1 and 32.
- Returns:
Time series of the epsilon parameter.
- Return type:
DataArray
- Raises:
ValueError – If VDF and n_s have different times.
TypeError – If en_channels is not a list.
Examples
>>> from pyrfu import mms >>> options = {"en_channel": [4, 32]} >>> eps = mms.calculate_epsilon(vdf, model_vdf, n_s, sc_pot, **options)