Parameters: |
- C : array-like(M, N)
A 2D array or masked array. The values will be color-mapped.
This argument can only be passed positionally.
C can in some cases be 3D with the last dimension as rgb(a).
This is available when C qualifies for image or pcolorimage type,
will throw a TypeError if C is 3D and quadmesh.
- X, Y : tuple or array-like, default:
(0, N) , (0, M)
X and Y are used to specify the coordinates of the
quadrilaterals. There are different ways to do this:
Use tuples X=(xmin, xmax) and Y=(ymin, ymax) to define
a uniform rectangular grid.
The tuples define the outer edges of the grid. All individual
quadrilaterals will be of the same size. This is the fastest
version.
Use 1D arrays X, Y to specify a non-uniform rectangular
grid.
In this case X and Y have to be monotonic 1D arrays of length
N+1 and M+1, specifying the x and y boundaries of the cells.
The speed is intermediate. Note: The grid is checked, and if
found to be uniform the fast version is used.
Use 2D arrays X, Y if you need an arbitrary quadrilateral
grid (i.e. if the quadrilaterals are not rectangular).
In this case X and Y are 2D arrays with shape (M, N),
specifying the x and y coordinates of the corners of the colored
quadrilaterals. See pcolormesh for details.
This is the most general, but the slowest to render. It may
produce faster and more compact output using ps, pdf, and
svg backends, however.
These arguments can only be passed positionally.
- cmap : str or
Colormap , optional
A Colormap instance or registered colormap name. The colormap
maps the C values to colors. Defaults to rcParams["image.cmap"] = 'viridis' .
- norm :
Normalize , optional
The Normalize instance scales the data values to the canonical
colormap range [0, 1] for mapping to colors. By default, the data
range is mapped to the colorbar range using linear scaling.
- vmin, vmax : scalar, optional, default: None
The colorbar range. If None, suitable min/max values are
automatically chosen by the Normalize instance (defaults to
the respective min/max values of C in case of the default linear
scaling).
- alpha : scalar, optional, default: None
The alpha blending value, between 0 (transparent) and 1 (opaque).
- snap : bool, optional, default: False
Whether to snap the mesh to pixel boundaries.
|