spiketools.plts.stats.plot_surrogates¶
- spiketools.plts.stats.plot_surrogates(surrogates, data_value=None, p_value=None, ax=None, **plt_kwargs)[source]¶
Plot a distribution of surrogate data.
- Parameters:
- surrogates1d array
The collection of values computed on surrogates.
- data_valuefloat, optional
The statistic value of the real data, to draw on the plot.
- p_valuefloat, optional
The p-value to print on the plot.
- axAxes, optional
Axis object upon which to plot.
- plt_kwargs
Additional arguments to pass into the plot function. Custom kwargs: ‘data_value_color’, ‘data_value_linestyle’, ‘data_value_lw’.