scisalt.matplotlib.NonUniformImage

scisalt.matplotlib.NonUniformImage(x, y, z, ax=None, fig=None, cmap=None, alpha=None, scalex=True, scaley=True, add_cbar=True, **kwargs)

Used to plot a set of coordinates.

Parameters:

x, y : numpy.ndarray

1-D ndarrays of lengths N and M, respectively, specifying pixel centers

z : numpy.ndarray

An (M, N) ndarray or masked array of values to be colormapped, or a (M, N, 3) RGB array, or a (M, N, 4) RGBA array.

ax : matplotlib.axes.Axes, optional

The axis to plot to.

fig : matplotlib.figure.Figure, optional

The figure to plot to.

cmap : matplotlib.colors.Colormap, optional

The colormap to use.

alpha : float, optional

The transparency to use.

scalex : bool, optional

To set the x limits to available data

scaley : bool, optional

To set the y limits to available data

add_cbar : bool, optional

Whether ot add a colorbar or not.

Returns:

img : matplotlib.image.NonUniformImage

Object representing the matplotlib.image.NonUniformImage.