JointPlot

class sherpa.plot.JointPlot(rows=2, cols=1)

Bases: SplitPlot

Multiple plots that share a common axis

This supports two plots, where the top plot is twice as tall as the bottom plot, the top plot is a FitPlot class, and the bottom plot a “residual” plot class.

Attributes Summary

contour_prefs	The preferences for the plot.
plot_prefs	The preferences for the plot.

Methods Summary

addcontour(plot, *args, **kwargs)	Add the contour plot to the next space.
addplot(plot, *args, **kwargs)	Add the plot to the next space.
contour(row, col, plot, *args, **kwargs)	Add the contour in the given space.
hline(y[, xmin, xmax, linecolor, linestyle, ...])	Draw a line at constant y, extending over the plot.
overcontour(row, col, plot, *args, **kwargs)	Add a contour plot to the given space without destroying the contents.
overlaycontour(plot, *args, **kwargs)	Add the contour to the current space without destroying the contents.
overlayplot(plot, *args, **kwargs)	Add the plot to the current space without destroying the contents.
overplot(row, col, plot, *args, **kwargs)	Add a plot to the given space without destroying the contents.
plot(row, col, plot, *args, **kwargs)	Add the plot in the given space.
plotbot(plot, *args[, overplot])	Display the bottom (residual-style) plot
plottop(plot, *args[, overplot, clearwindow])	Display the top (fit-style) plot
reset([rows, cols])	Prepare for a new set of plots or contours.
vline(x[, ymin, ymax, linecolor, linestyle, ...])	Draw a line at constant x, extending over the plot.

Attributes Documentation

contour_prefs: dict[str, Any] = {'alpha': None, 'colors': None, 'label': None, 'levels': None, 'linestyles': 'solid', 'linewidths': None, 'xlog': False, 'ylog': False}

The preferences for the plot.

plot_prefs: dict[str, Any] = {}

The preferences for the plot.

Methods Documentation

addcontour(plot, *args, **kwargs)

Add the contour plot to the next space.

addplot(plot, *args, **kwargs)

Add the plot to the next space.

contour(row, col, plot, *args, **kwargs)

Add the contour in the given space.

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.

overcontour(row, col, plot, *args, **kwargs)

Add a contour plot to the given space without destroying the contents.

overlaycontour(plot, *args, **kwargs)

Add the contour to the current space without destroying the contents.

overlayplot(plot, *args, **kwargs)

Add the plot to the current space without destroying the contents.

overplot(row, col, plot, *args, **kwargs)

Add a plot to the given space without destroying the contents.

plot(row, col, plot, *args, **kwargs)

Add the plot in the given space.

plotbot(plot, *args, overplot=False, **kwargs)

Display the bottom (residual-style) plot

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

Display the top (fit-style) plot

reset(rows=2, cols=1)

Prepare for a new set of plots or contours.

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.