csep.utils.plots.plot_number_test
- csep.utils.plots.plot_number_test(evaluation_result, axes=None, show=True, plot_args=None)[source]
Takes result from evaluation and generates a specific histogram plot to show the results of the statistical evaluation for the n-test.
- Parameters:
evaluation_result – object-like var that implements the interface of the above EvaluationResult
axes (matplotlib.Axes) – axes object used to chain this plot
show (bool) – if true, call pyplot.show()
plot_args (dict) – optional argument containing a dictionary of plotting arguments, with keys as strings and items as described below
- Optional plotting arguments:
title: (
str
) - default: name of the first evaluation result typetitle_fontsize: (
float
) Fontsize of the plot title - default: 10xlabel: (
str
) - default: ‘X’xlabel_fontsize: (
float
) - default: 10xticks_fontsize: (
float
) - default: 10ylabel_fontsize: (
float
) - default: 10text_fontsize: (
float
) - default: 14tight_layout: (
bool
) Set matplotlib.figure.tight_layout to remove excess blank space in the plot - default: Truepercentile (
float
) Critial region to shade on histogram - default: 95bins: (
str
) - Set binning type. see matplotlib.hist for more info - default: ‘auto’
- Returns:
can be used to modify the figure
- Return type:
ax (matplotlib.axes.Axes)