ScatterPlot

class sherpa.plot.ScatterPlot[source] [edit on github]

Bases: DataPlot

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(x, y[, xlabel, ylabel, 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 = {'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.

Methods Documentation

static hline(y, xmin=0, xmax=1, linecolor=None, linestyle=None, linewidth=None, overplot=False, clearwindow=True) [edit on github]

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

overplot(*args, **kwargs) [edit on github]

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) [edit on github]

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(x, y, xlabel='x', ylabel='y', name='(x,y)')[source] [edit on github]

The data to plot.

Parameters:
  • x – The points to plot. The number of points in the two sequences should be the same.

  • y – The points to plot. The number of points in the two sequences should be the same.

  • xlabel (optional, str) – The axis labels and name for the plot title.

  • ylabel (optional, str) – The axis labels and name for the plot title.

  • name (optional, str) – The axis labels and name for the plot title.

See also

plot

static vline(x, ymin=0, ymax=1, linecolor=None, linestyle=None, linewidth=None, overplot=False, clearwindow=True) [edit on github]

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