matplotlib.pyplot.tripcolor#
- matplotlib.pyplot.tripcolor(*args,alpha=1.0,norm=None,cmap=None,vmin=None,vmax=None,shading='flat',facecolors=None,**kwargs)[source]#
Create a pseudocolor plot of an unstructured triangular grid.
Call signatures:
tripcolor(triangulation,c,*,...)tripcolor(x,y,c,*,[triangles=triangles],[mask=mask],...)
The triangular grid can be specified either by passing a
Triangulation
object as the first parameter, or by passing the pointsx,y andoptionally thetriangles and amask. SeeTriangulation
for anexplanation of these parameters.It is possible to pass the triangles positionally, i.e.
tripcolor(x,y,triangles,c,...)
. However, this is discouraged.For more clarity, passtriangles via keyword argument.If neither oftriangulation ortriangles are given, the triangulationis calculated on the fly. In this case, it does not make sense to providecolors at the triangle faces viac orfacecolors because there aremultiple possible triangulations for a group of points and you don't knowwhich triangles will be constructed.
- Parameters:
- triangulation
Triangulation
An already created triangular grid.
- x, y, triangles, mask
Parameters defining the triangular grid. See
Triangulation
.This is mutually exclusive with specifyingtriangulation.- carray-like
The color values, either for the points or for the triangles. Which oneis automatically inferred from the length ofc, i.e. does it matchthe number of points or the number of triangles. If there are the samenumber of points and triangles in the triangulation it is assumed thatcolor values are defined at points; to force the use of color values attriangles use the keyword argument
facecolors=c
instead of justc
.This parameter is position-only.- facecolorsarray-like, optional
Can be used alternatively toc to specify colors at the trianglefaces. This parameter takes precedence overc.
- shading{'flat', 'gouraud'}, default: 'flat'
If 'flat' and the color valuesc are defined at points, the colorvalues used for each triangle are from the mean c of the triangle'sthree points. Ifshading is 'gouraud' then color values must bedefined at points.
- cmapstr or
Colormap
, default:rcParams["image.cmap"]
(default:'viridis'
) The Colormap instance or registered colormap name used to map scalar datato colors.
- normstr or
Normalize
, optional The normalization method used to scale scalar data to the [0, 1] rangebefore mapping to colors usingcmap. By default, a linear scaling isused, mapping the lowest value to 0 and the highest to 1.
If given, this can be one of the following:
An instance of
Normalize
or one of its subclasses(seeColormap normalization).A scale name, i.e. one of "linear", "log", "symlog", "logit", etc. For alist of available scales, call
matplotlib.scale.get_scale_names()
.In that case, a suitableNormalize
subclass is dynamically generatedand instantiated.
- vmin, vmaxfloat, optional
When using scalar data and no explicitnorm,vmin andvmax definethe data range that the colormap covers. By default, the colormap coversthe complete value range of the supplied data. It is an error to usevmin/vmax when anorm instance is given (but using a
str
normname together withvmin/vmax is acceptable).- colorizer
Colorizer
or None, default: None The Colorizer object used to map color to data. If None, a Colorizerobject is created from anorm andcmap.
- triangulation
- Returns:
PolyCollection
orTriMesh
The result depends onshading: For
shading='flat'
the result is aPolyCollection
, forshading='gouraud'
the result is aTriMesh
.
- Other Parameters:
- **kwargs
Collection
properties Property
Description
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image
array-like or float or None
bool
bool or list of bools
array-like or None
CapStyle
or {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
BboxBase
or Nonebool
Patch or (Path, Transform) or None
Colormap
or str or Nonecolor or list of RGBA tuples
edgecolor
orec
oredgecolors
facecolor
orfacecolors
orfc
str
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
unknown
bool
JoinStyle
or {'miter', 'round', 'bevel'}object
linestyle
ordashes
orlinestyles
orls
str or tuple or list thereof
linewidth
orlinewidths
orlw
float or list of floats
bool
Normalize
or str or None(N, 2) or (2,) array-like
list of
AbstractPathEffect
unknown
None or bool or float or callable
float
bool
(scale: float, length: float, randomness: float)
bool or None
str
list of str or None
bool
float
- **kwargs
Notes
Note
This is thepyplot wrapper for
axes.Axes.tripcolor
.