An image with pixels on a regular grid, attached to an Axes. Parameters ---------- ax : `~matplotlib.axes.Axes` The Axes the image will belong to. cmap : str or `~matplotlib.colors.Colormap`, default: :rc:`image.cmap` The Colormap instance or registered colormap
| 841 | |
| 842 | |
| 843 | class AxesImage(_ImageBase): |
| 844 | """ |
| 845 | An image with pixels on a regular grid, attached to an Axes. |
| 846 | |
| 847 | Parameters |
| 848 | ---------- |
| 849 | ax : `~matplotlib.axes.Axes` |
| 850 | The Axes the image will belong to. |
| 851 | cmap : str or `~matplotlib.colors.Colormap`, default: :rc:`image.cmap` |
| 852 | The Colormap instance or registered colormap name used to map scalar |
| 853 | data to colors. |
| 854 | norm : str or `~matplotlib.colors.Normalize` |
| 855 | Maps luminance to 0-1. |
| 856 | interpolation : str, default: :rc:`image.interpolation` |
| 857 | Supported values are 'none', 'auto', 'nearest', 'bilinear', |
| 858 | 'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite', |
| 859 | 'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell', |
| 860 | 'sinc', 'lanczos', 'blackman'. |
| 861 | interpolation_stage : {'data', 'rgba'}, default: 'data' |
| 862 | If 'data', interpolation |
| 863 | is carried out on the data provided by the user. If 'rgba', the |
| 864 | interpolation is carried out after the colormapping has been |
| 865 | applied (visual interpolation). |
| 866 | origin : {'upper', 'lower'}, default: :rc:`image.origin` |
| 867 | Place the [0, 0] index of the array in the upper left or lower left |
| 868 | corner of the Axes. The convention 'upper' is typically used for |
| 869 | matrices and images. |
| 870 | extent : tuple, optional |
| 871 | The data axes (left, right, bottom, top) for making image plots |
| 872 | registered with data plots. Default is to label the pixel |
| 873 | centers with the zero-based row and column indices. |
| 874 | filternorm : bool, default: True |
| 875 | A parameter for the antigrain image resize filter |
| 876 | (see the antigrain documentation). |
| 877 | If filternorm is set, the filter normalizes integer values and corrects |
| 878 | the rounding errors. It doesn't do anything with the source floating |
| 879 | point values, it corrects only integers according to the rule of 1.0 |
| 880 | which means that any sum of pixel weights must be equal to 1.0. So, |
| 881 | the filter function must produce a graph of the proper shape. |
| 882 | filterrad : float > 0, default: 4 |
| 883 | The filter radius for filters that have a radius parameter, i.e. when |
| 884 | interpolation is one of: 'sinc', 'lanczos' or 'blackman'. |
| 885 | resample : bool, default: False |
| 886 | When True, use a full resampling method. When False, only resample when |
| 887 | the output image is larger than the input image. |
| 888 | **kwargs : `~matplotlib.artist.Artist` properties |
| 889 | """ |
| 890 | |
| 891 | def __init__(self, ax, |
| 892 | *, |
| 893 | cmap=None, |
| 894 | norm=None, |
| 895 | colorizer=None, |
| 896 | interpolation=None, |
| 897 | origin=None, |
| 898 | extent=None, |
| 899 | filternorm=True, |
| 900 | filterrad=4.0, |
no outgoing calls
searching dependent graphs…