pyrfu.pyrf.wavelet module#

pyrfu.pyrf.wavelet.wavelet(inp, **kwargs)[source]#

Computes wavelet spectrogram based on fast FFT algorithm. :param inp: Input quantity. :type inp: xarray.DataArray :param **kwargs:

Hash table of keyword arguments with :
  • fsint or float

    Sampling frequency of the input time series.

  • flist or ndarray

    Vector [f_min f_max], calculate spectra between frequencies f_min and f_max.

  • nfint or float

    Number of frequency bins.

  • wavelet_widthint or float

    Width of the Morlet wavelet. Default 5.36.

  • linearfloat

    Linear spacing between frequencies of df.

  • return_powerbool

    Set to True to return the power, False for complex wavelet transform. Default True.

  • cut_edgebool

    Set to True to set points affected by edge effects to NaN, False to keep edge affect points. Default True

Returns:

out – Wavelet transform of the input.

Return type:

xarray.DataArray or xarray.Dataset