TracePlot

class sherpa.plot.TracePlot

Bases: DataPlot

Attributes Summary

plot_prefs

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(points[, xlabel, name])	The data to plot.
vline(x[, ymin, ymax, linecolor, linestyle, ...])	Draw a line at constant x, extending over the plot.

Attributes Documentation

plot_prefs = {}

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:

• 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(points, xlabel='x', name='x')

The data to plot.

Parameters:

• points – The trace to plot (one dimensional). The X axis is set to consecutive integers, starting at 0.

• xlabel (optional) – This value is ignored.

• name (optional, string) – Used to create the Y-axis label and plot title.

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.