BkgFitPlot

class sherpa.astro.plot.BkgFitPlot

Bases: FitPlot

Derived class for creating plots of background counts with fitted model

Methods

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

Attributes Summary

plot_prefs

The preferences for the plot.

Methods Summary

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

Attributes Documentation

plot_prefs: dict[str, Any] = {}

The preferences for the plot. Note that the display for the data and model plots are controlled by the preferences for the dataplot and modelplot objects, so this is currently unused.

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)

Add the data to an existing plot.

This is the same as calling the plot method with overplot set to True.

See also

plot

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

Plot the data.

This will plot the data sent to the prepare method.

Parameters:

overplotbool, optional

If True then add the data to an existing plot, otherwise create a new plot.

clearwindowbool, 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. They are sent to both the dataplot and modelplot instances.

See also

prepare, overplot

prepare(dataplot, modelplot)

Create the data to plot

Parameters:

dataplot

The Sherpa plot object representing the data (normally a DataPlot instance).

modelplot

The Sherpa plot object representing the model (normally a ModelPlot instance).

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.