@@ -5039,23 +5039,25 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
50395039
50405040 Parameters
50415041 ----------
5042- X : array_like, shape (n, m) or (n, m, 3) or (n, m, 4)
5042+ X : array_like, shape (n, m) or (n, m, 3) or (n, m, 4) or (2, n, m)
50435043 Display the image in `X` to current axes. `X` may be an
50445044 array or a PIL image. If `X` is an array, it
50455045 can have the following shapes and types:
50465046
5047- - MxN -- values to be mapped (float or int)
5047+ - MxN -- univariate values to be mapped (float or int)
50485048 - MxNx3 -- RGB (float or uint8)
50495049 - MxNx4 -- RGBA (float or uint8)
5050+ - 2xMxN -- bivariate values to be mapped (float or int)
50505051
50515052 The value for each component of MxNx3 and MxNx4 float arrays
5052- should be in the range 0.0 to 1.0. MxN arrays are mapped
5053+ should be in the range 0.0 to 1.0. MxN and 2xMxN arrays are mapped
50535054 to colors based on the `norm` (mapping scalar to scalar)
50545055 and the `cmap` (mapping the normed scalar to a color).
50555056
5056- cmap : `~matplotlib.colors.Colormap`, optional, default: None
5057+ cmap : `~matplotlib.colors.Colormap`,
5058+ `~matplotlib.colors.BivariateColormap`optional, default: None
50575059 If None, default to rc `image.cmap` value. `cmap` is ignored
5058- if `X` is 3-D, directly specifying RGB(A) values.
5060+ if `X` is 3-D but not bivariate , directly specifying RGB(A) values.
50595061
50605062 aspect : ['auto' | 'equal' | scalar], optional, default: None
50615063 If 'auto', changes the image aspect ratio to match that of the
@@ -5079,7 +5081,8 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
50795081 on the Agg, ps and pdf backends. Other backends will fall back to
50805082 'nearest'.
50815083
5082- norm : `~matplotlib.colors.Normalize`, optional, default: None
5084+ norm : `~matplotlib.colors.Normalize`, `matplotlib.colors.BivariateNorm`
5085+ optional, default: None
50835086 A `~matplotlib.colors.Normalize` instance is used to scale
50845087 a 2-D float `X` input to the (0, 1) range for input to the
50855088 `cmap`. If `norm` is None, use the default func:`normalize`.
@@ -5259,7 +5262,7 @@ def _pcolorargs(funcname, *args, **kw):
52595262 @docstring .dedent_interpd
52605263 def pcolor (self , * args , ** kwargs ):
52615264 """
5262- Create a pseudocolor plot of a 2-D array.
5265+ Create a pseudocolor plot of a 2-D univariate or 3-D bivariate array.
52635266
52645267 Call signatures::
52655268
@@ -5557,11 +5560,13 @@ def pcolormesh(self, *args, **kwargs):
55575560 Keyword arguments:
55585561
55595562 *cmap*: [ *None* | Colormap ]
5560- A :class:`matplotlib.colors.Colormap` instance. If *None*, use
5561- rc settings.
5563+ A :class:`matplotlib.colors.Colormap` or
5564+ :class:`matplotlib.colors.BivariateColormap`instance. If *None*,
5565+ use rc settings.
55625566
55635567 *norm*: [ *None* | Normalize ]
5564- A :class:`matplotlib.colors.Normalize` instance is used to
5568+ A :class:`matplotlib.colors.Normalize` or
5569+ :class:`matplotlib.colors.BivariateNorm` instance is used to
55655570 scale luminance data to 0,1. If *None*, defaults to
55665571 :func:`normalize`.
55675572
@@ -5679,7 +5684,7 @@ def pcolormesh(self, *args, **kwargs):
56795684 @docstring .dedent_interpd
56805685 def pcolorfast (self , * args , ** kwargs ):
56815686 """
5682- pseudocolor plot of a 2-D array
5687+ pseudocolor plot of a 2-D univariate or 3-D bivariate array
56835688
56845689 Experimental; this is a pcolor-type method that
56855690 provides the fastest possible rendering with the Agg
@@ -5738,11 +5743,13 @@ def pcolorfast(self, *args, **kwargs):
57385743 Optional keyword arguments:
57395744
57405745 *cmap*: [ *None* | Colormap ]
5741- A :class:`matplotlib.colors.Colormap` instance from cm. If *None*,
5746+ A :class:`matplotlib.colors.Colormap` or
5747+ :class:`matplotlib.colors.BivariateColormap` instance from cm. If *None*,
57425748 use rc settings.
57435749
57445750 *norm*: [ *None* | Normalize ]
5745- A :class:`matplotlib.colors.Normalize` instance is used to scale
5751+ A :class:`matplotlib.colors.Normalize` or
5752+ :class:`matplotlib.colors.BivariateNorm` instance is used to scale
57465753 luminance data to 0,1. If *None*, defaults to normalize()
57475754
57485755 *vmin*/*vmax*: [ *None* | scalar ]
0 commit comments