Image

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

Bases: NoNewAttributesAfterInit

Base class for image plots

Warning

This class is experimental and subject to change in the future. Currently, is is only used within _repr_html_ methods.

Attributes Summary

image_prefs

The preferences for the plot.

Methods Summary

plot(x0, x1, y[, overplot, clearwindow])

Draw a point at the given location.

Attributes Documentation

image_prefs = {}

The preferences for the plot.

Methods Documentation

plot(x0, x1, y, overplot=True, clearwindow=False, **kwargs)[source] [edit on github]

Draw a point at the given location.

Parameters:

  • x0 (array-like) – Value for the image axes.

  • x1 (array-like) – Value for the image axes.

  • y (array-like, 2D) – The coordinates of the plot.

  • 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 image_prefs dictionary.