mne_denoise.viz.plot_null_distribution#

mne_denoise.viz.plot_null_distribution(null_values, observed, metric_label='Statistic', ci=95, n_bins=60, suptitle=None, series_color=None, figsize=None, fname=None, show=True)[source]#

Plot a null-distribution histogram with observed statistic and CI.

Parameters:
null_valuesarray-like

Samples from the null distribution.

observedfloat

Observed statistic to compare against the null.

metric_labelstr

Label for the x-axis.

cifloat

Central interval width in percent.

n_binsint

Number of histogram bins.

suptitlestr | None

Figure title override.

series_colorstr | None

Color for the observed-statistic marker/annotation.

figsizetuple | None

Figure size in inches.

fnamepath-like | None

Optional output path.

showbool

Whether to display the figure.

Returns:
figmatplotlib.figure.Figure

Figure handle.

p_valuefloat

Two-sided empirical p-value under null_values.