10000 Copy across parameter definitions · matplotlib/matplotlib@4d1e146 · GitHub
[go: up one dir, main page]

Skip to content

Commit 4d1e146

Browse files
committed
Copy across parameter definitions
1 parent 9f19571 commit 4d1e146

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

lib/matplotlib/image.py

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -826,17 +826,38 @@ class AxesImage(_ImageBase):
826826
Parameters
827827
----------
828828
cmap : colors.Colormap
829+
The Colormap instance or registered colormap name used to map scalar
830+
data to colors.
829831
norm : colors.Normalize
830-
Maps luminance to 0-1
831-
origin :
832+
Maps luminance to 0-1.
833+
interpolation : str
834+
Supported values are 'none', 'antialiased', 'nearest', 'bilinear',
835+
'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite',
836+
'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell',
837+
'sinc', 'lanczos'.
838+
origin : {'upper', 'lower'}
839+
Place the [0, 0] index of the array in the upper left or lower left
840+
corner of the axes. The convention 'upper' is typically used for
841+
matrices and images.
832842
extent : tuple
833843
The data axes (left, right, bottom, top) for making image plots
834844
registered with data plots. Default is to label the pixel
835845
centers with the zero-based row and column indices.
836-
filternorm :
837-
filterrad :
846+
filternorm : bool
847+
A parameter for the antigrain image resize filter
848+
(see the antigrain documentation).
849+
If filternorm is set, the filter normalizes integer values and corrects
850+
the rounding errors. It doesn't do anything with the source floating
851+
point values, it corrects only integers according to the rule of 1.0
852+
which means that any sum of pixel weights must be equal to 1.0. So,
853+
the filter function must produce a graph of the proper shape.
854+
filterrad : float > 0
855+
The filter radius for filters that have a radius parameter, i.e. when
856+
interpolation is one of: 'sinc', 'lanczos' or 'blackman'.
838857
resample : bool
839-
**kwargs :
858+
When True, use a full resampling method. When False, only resample when
859+
the output image is larger than the input image.
860+
**kwargs
840861
Additional kwargs are matplotlib.artist properties.
841862
842863
Notes

0 commit comments

Comments
 (0)
0