pybic.BicAn.PlotHelper

BicAn.PlotHelper(whatPlot, X, Y, IsFreq=False, CheckNeighbors=False, fig=None, ax=None, Ntrials=200, b2bins=100, cVal=0.999, SaveAs=None, NoXLabel=False)[source]

Estimate and plot distribution of bispectrum/bicoherence for single point.

Parameters:

whatPlot (str) – Input string indicating desired plot. Accepts 'b2Prob', 'Phasor', or 'BvsTime'.
X (list) – Frequency 1 (fv bin or frequency).
Y (list) – Frequency 2 (fv bin or frequency).
IsFreq (bool) – True for X and Y in frequency units.
CheckNeighbors (bool) – Perform analysis on nearby points.
fig (Figure) – Input figure.
ax (Axes) – Input axes.
Ntrials (int) – Number of random trials for uncertainty analysis (whatPlot='b2Prob').
b2bins (int) – Number of bicoherence bins in uncertainty analysis (whatPlot='b2Prob').
cVal (float) – Critical level for random phase b2 estimate (whatPlot='b2Prob').
SaveAs (str) – Name of output file (if not None.)
NoXLabel (bool) – Omit x axis label.

Returns:

Output of uncertainty analysis (i.e., empty list if whatPlot!='b2Prob').

[<bootstrap mean>, <bootstrap std>, <critical b2>, <noise floor>]

Return type:

list

Caution

When IsFreq = True, the corresponding frequency bin is dependent on the FScale attribute, i.e., X=[6],Y=[7] indicates 6 and 7 kHz for FScale=3 but 6 and 7 nHz for FScale=-9.