pyrfu.pyrf.filt module#

pyrfu.pyrf.filt.filt(inp, f_min: float = 0.0, f_max: float = 1.0, order: int = -1)[source]#

Filters input quantity.

Parameters:

  • inp (xarray.DataArray) – Time series of the variable to filter.

  • f_min (float, Optional) – Lower limit of the frequency range. Default is 0. (Highpass filter).

  • f_max (float, Optional) – Upper limit of the frequency range. Default is 1. (Highpass filter).

  • order (int, Optional) – Order of the elliptic filter. Default is -1.

Returns:

out – Time series of the filtered signal.

Return type:

xarray.DataArray

Examples

>>> from pyrfu import mms, pyrf

Time interval

>>> tint = ["2017-07-18T13:03:34.000", "2017-07-18T13:07:00.000"]

Spacecraft index

>>> mms_id = 1

Load magnetic and electric fields

>>> b_xyz = mms.get_data("B_gse_fgm_brst_l2", tint, mms_id)
>>> e_xyz = mms.get_data("E_gse_edp_brst_l2", tint, mms_id)

Convert E to field aligned coordinates

>>> e_xyzfac = pyrf.convert_fac(e_xyz, b_xyz, [1,0,0])

Bandpass filter E waveform

>>> e_xyzfac_hf = pyrf.filt(e_xyzfac, 4, 0, 3)
>>> e_xyzfac_lf = pyrf.filt(e_xyzfac, 0, 4, 3)