ResidPHAPlot

class sherpa.astro.plot.ResidPHAPlot

Bases: ResidHistogramPlot

Plot residuals for a PHA dataset.

Added in version 4.16.1.

Attributes Summary

histo_prefs	The preferences for the residual plot.
residual_axis	At what point on the y axis is the residual line drawn.
residual_color	The color of the residual line.
residual_lw	The line width of the residual line.
x	Return (xlo + xhi) / 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, model, stat)	Create the plot.
vline(x[, ymin, ymax, linecolor, linestyle, ...])	Draw a line at constant x, extending over the plot.

Attributes Documentation

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

The preferences for the residual plot.

residual_axis: float = 0

At what point on the y axis is the residual line drawn.

residual_color: str = 'k'

The color of the residual line.

residual_lw: float = 0.8

The line width of the residual line.

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.

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: bool = False, clearwindow: bool = True, **kwargs) → None

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: Data1DInt, model: Model, stat: Stat) → None

Create the plot.

The stat parameter is ignored.

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.