plopp.backends.matplotlib.image.Image#

class plopp.backends.matplotlib.image.Image(canvas, colormapper, data, uid=None, shading='auto', rasterized=True, **kwargs)[source]#

Artist to represent two-dimensional data.

Parameters:

  • canvas (Canvas) – The canvas that will display the image.

  • colormapper (ColorMapper) – The colormapper to use for the image.

  • data (DataArray) – The initial data to create the image from.

  • uid (Optional[str], default: None) – The unique identifier of the artist. If None, a random UUID is generated.

  • shading (str, default: 'auto') – The shading to use for the pcolormesh.

  • rasterized (bool, default: True) – Rasterize the mesh/image if True.

  • **kwargs – Additional arguments are forwarded to Matplotlib’s pcolormesh.

__init__(canvas, colormapper, data, uid=None, shading='auto', rasterized=True, **kwargs)[source]#

Methods

__init__(canvas, colormapper, data[, uid, ...])

bbox(xscale, yscale)

The bounding box of the image.

format_coord(xslice, yslice)

Format the coordinates of the mouse pointer to show the value of the data at that point.

notify_artist(message)

Receive notification from the colormapper that its state has changed.

remove()

Remove the image artist from the canvas.

update(new_values)

Update image array with new values.

Attributes

data

Get the Mesh's data in a form that may have been tweaked, compared to the original data, in the case of a two-dimensional coordinate.