DataPHAPlot

class sherpa.astro.plot.DataPHAPlot

Bases: DataHistogramPlot

Plot a PHA dataset.

Attributes Summary

histo_prefs	The preferences for the plot.
x	Return (xlo + xhi) / 2
xerr	Return abs(xhi - xlow) / 2

Methods Summary

hline(y[, xmin, xmax, linecolor, linestyle, ...])	Draw a line at constant y, extending over the plot.
overplot(*args, **kwargs)
plot([overplot, clearwindow])	Plot the data.
prepare(data[, stat])	Create the data to plot
vline(x[, ymin, ymax, linecolor, linestyle, ...])	Draw a line at constant x, extending over the plot.

Attributes Documentation

histo_prefs = {'alpha': None, 'capsize': None, 'color': None, 'ecolor': None, 'label': None, 'linestyle': 'None', 'linewidth': None, 'marker': '.', 'markerfacecolor': None, 'markersize': None, 'xerrorbars': False, 'xlog': False, 'yerrorbars': True, 'ylog': False}

The preferences for the plot.

x

Return (xlo + xhi) / 2

This is intended to make it easier to swap between plot- and histogram-style plots by providing access to an X value.

xerr

Return abs(xhi - xlow) / 2

The plotting backends actually calculate the xerr values explicitly rather than use this field, so it is provided as a property in case users need it.

Changed in version 4.16.1: This field is now a property.

Methods Documentation

static hline(y, xmin=0, xmax=1, linecolor=None, linestyle=None, linewidth=None, overplot=False, clearwindow=True)

Draw a line at constant y, extending over the plot.

overplot(*args, **kwargs)

plot(overplot=False, clearwindow=True, **kwargs)

Plot the data.

This will plot the data sent to the prepare method.

Parameters:

• overplot (bool, optional) – If True then add the data to an existing plot, otherwise create a new plot.

• clearwindow (bool, optional) – Should the existing plot area be cleared before creating this new plot (e.g. for multi-panel plots)?

• **kwargs – These values are passed on to the plot backend, and must match the names of the keys of the object’s plot_prefs dictionary.

See also

prepare, overplot

prepare(data, stat=None)

Create the data to plot

Parameters:

• data – The Sherpa data object to display (it is assumed to be one dimensional and represent binned data).

• stat (optional) – The Sherpa statistics object to use to add Y error bars if the data has none.

See also

plot

static vline(x, ymin=0, ymax=1, linecolor=None, linestyle=None, linewidth=None, overplot=False, clearwindow=True)

Draw a line at constant x, extending over the plot.