pybic.BicAn.PlotInstFreq

BicAn.PlotInstFreq(j, k, diff_freq=True, freq_type='hilbert', fband=0, fwindow=0, realBPF=True, SaveStr='', dWin=None)[source]

Perform instantaneous frequency analysis.

Hint

See BicAn.InstDiffFreq() for more info on the instantaneous difference frequency!

Parameters:
  • j (int) – Index 1.

  • k (int) – Index 2.

  • diff_freq (bool) – Plot difference frequency instead of individual inst freqs (False).

  • freq_type (str) – Desired means of estimatinf instantaneous frequencies. Present support for time derivative of spectrogram ('spectro'), Hilbert transform ('hilbert'), or zero crossings ('zerocross').

  • fband (float) – Bandpass filter bandwidth.

  • fwindow (float) – Limits for x (frequency) axis.

  • realBPF (bool) – Use Butterworth bandpass (brickwall if False).

  • SaveStr (str) – Output filename.

  • dWin (list of int) – Plot “region of interest” from dWin[0] to dWin[1].

Returns:

Array of instantaneous frequencies.

Return type:

ndarray