plotting

set_plot_default([use_bold=True])

Sets the default fonts for the matplotlib plots.

Parameters:

use_bold (bool) – Determines whether the fonts used are in bold.

plot_histogram_line(x_min, histogram[, x_edges=None, ax=None, color='C0', alpha=1., linewidth=1., linestyle='-'])

Outputs the histogram line boxes without using the histogram function.

Parameters:
  • x_mid (array) – Midpoint of each histogram bar.

  • histogram (array) – Histogram height.

  • x_edges (array) – The edges of each histogram bar. Ideal for unequal spacings between histograms.

  • ax (class) – The matplotlib plotting axis.

  • color (str) – The color of the histogram error plot.

  • alpha (float) – The transparency fraction of the histogram error plot.

  • linewidth (float) – The linewidth of histogram line.

  • linestyle (str) – The linestyle used.

plot_histogram_confidence(x_mid, histogram_min, histogram_max[, x_edges=None, ax=None, color='C0', alpha=0.25])

Plots the confidence envelopes for a histogram.

Parameters:
  • x_mid (array) – Midpoint of each histogram bar.

  • histogram_min (array) – Histogram minimum envelope.

  • histogram_max (array) – Histogram maximum envelope.

  • x_edges (array) – The edges of each histogram bar. Ideal for unequal spacings between histograms.

  • ax (class) – The matplotlib plotting axis.

  • color (str) – The color of the histogram error plot.

  • alpha (float) – The transparency fraction of the histogram error plot.

plot_histogram_error(x_mid, histogram, histogram_error[, x_edges=None, ax=None, color='C0', alpha=0.25])
Parameters:
  • x_mid (array) – Midpoint of each histogram bar.

  • histogram (array) – Histogram.

  • histogram_error (array) – The error associated to each histogram bar.

  • x_edges (array) – The edges of each histogram bar. Ideal for unequal spacings between histograms.

  • ax (class) – The matplotlib plotting axis.

  • color (str) – The color of the histogram error plot.

  • alpha (float) – The transparency fraction of the histogram error plot.