pyrfu.mms.remove_edist_background module#

pyrfu.mms.remove_edist_background.remove_edist_background(vdf, n_sec: float = 0.0, n_art: float = -1.0)[source]#

Remove secondary photoelectrons from electron distribution function according to [1].

Parameters:

  • vdf (xarray.Dataset) – Measured electron velocity distribution function.

  • n_sec (float, Optional) – Artificial secondary electron density (isotropic). Default is 0.

  • n_art (float, Optional) – Artificial photoelectron density (sun-angle dependant), Default is ephoto_scale from des-emoms GlobalAttributes.

Returns:

  • vdf_new (xarray.Dataset) – Electron VDF with photoelectrons removed.

  • vdf_bkg (xarray.Dataset) – Photoelectron VDF.

  • photoe_scle (float) – Artificial photoelectron and secondary electron density

References

[1]

Gershman, D. J., Avanov, L. A., Boardsen,S. A., Dorelli, J. C., Gliese, U., Barrie, A. C.,… Pollock, C. J. (2017). Spacecraft and instrument photoelectrons measured by the dual electron spectrometers on MMS. Journal of Geophysical Research:Space Physics,122, 11,548–11,558. https://doi.org/10.1002/2017JA024518