matplotlib.image

图像模块支持基本的图像加载、重新缩放和显示操作。

class matplotlib.image.AxesImage(ax, cmap=None, norm=None, interpolation=None, origin=None, extent=None, filternorm=True, filterrad=4.0, resample=False, **kwargs)

基类：matplotlib.image._ImageBase

附在轴上的图像。

参数:

ax ： Axes轴线

图像所属的轴。

cmap : str or Colormap, default: rcParams["image.cmap"] (default: 'viridis')str或

用于将标量数据映射到颜色的Colormap实例或注册的Colormap名称。

norm ： Normalize归一化

将亮度映射到0-1。

插值 : str, default: rcParams["image.interpolation"] (default: 'antialiased')str，默认值：

支持的值为“none”、“antialiased”、“nearest”、“双线性”、“bicubic”、“spline16”、“spline36”、“hanning”、“hamming”、“hermite”、“kaiser”、“quadric”、“catrom”、“gaussian”、“bessel”、“mitchell”、“sinc”、“lanczos”。

起源 : {{'upper', 'lower'}}, default: rcParams["image.origin"] (default: 'upper'){'upper'，'lower'}，默认值：

放置 [0, 0] 位于轴的左上角或左下角的数组的索引。约定“上”通常用于矩阵和图像。

extent可选元组

数据轴（左、右、下、上）用于使图像图与数据图注册。默认情况下，使用从零开始的行和列索引标记像素中心。

filternormbool，默认值：True

antigrain图像大小调整过滤器的参数（请参见antigrain文档）。如果设置了filternorm，则过滤器将规范整数值并更正舍入错误。它不处理源浮点值，它只根据1.0的规则校正整数，这意味着任何像素权重的总和必须等于1.0。因此，过滤函数必须生成一个适当形状的图形。

filterrad浮点>0，默认值：4

具有半径参数的过滤器的过滤器半径，即当插值是“sinc”、“lanczos”或“blackman”之一时。

resamplebool，默认值：False

如果为True，请使用完全重新采样方法。如果为False，则仅在输出图像大于输入图像时重新采样。

**kwargs ： Artist 性质艺术家属性

参数:

norm ： matplotlib.colors.Normalize （或其子类）matplotlib.colors.Normalize（或其子类）

标准化对象，用于将数据按一定比例缩放到间隔中 [0, 1] .如果 None ， norm 默认为 colors.Normalize 对象，该对象根据处理的第一个数据初始化其缩放。

cmap STR或 Colormapstr或

用于将规范化数据值映射到rgba颜色的颜色映射。

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_cursor_data(event)

返回事件位置的图像值或 None 如果事件在图像之外。

参见

matplotlib.artist.Artist.get_cursor_data

get_extent()

以元组形式返回图像范围（左、右、下、上）。

get_window_extent(renderer=None)

获取显示空间中的轴边界框。

边界框的宽度和高度为非负。

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

使用此函数时要小心，如果艺术家窗口的范围发生更改，结果将不会更新。范围可能因变换堆栈中的任何更改而更改，例如更改轴限制、图形大小或使用的画布（如保存图形时所做）。这可能会导致意想不到的行为，在屏幕上交互式图形看起来很好，但保存不正确。

make_image(renderer, magnification=1.0, unsampled=False)

规格化、重缩放和颜色映射此图像的数据，以便使用 渲染器 ，与给定的 放大倍率 .

如果 未取样 为True，则不会缩放图像，但将返回适当的仿射变换。

返回:

image（M，N，4）uint8阵列

RGBA图像，重新采样，除非 未取样 是True。

x, y浮动

应绘制图像的左上角，以像素空间为单位。

trans仿射2d

从图像到像素空间的仿射变换。

set_extent(extent)

设置图像范围。

参数:

extent四元组浮点数

图像作为元组的位置和大小 (left, right, bottom, top) 在数据坐标中。

笔记

此更新 ax.dataLim ，如果是自动缩放，则设置 ax.viewLim 为了紧密贴合图像，不管 dataLim . 自动缩放状态未更改，因此在下面使用 ax.autoscale_view() 将根据 dataLim .

class matplotlib.image.BboxImage(bbox, cmap=None, norm=None, interpolation=None, origin=None, filternorm=True, filterrad=4.0, resample=False, **kwargs)

基类：matplotlib.image._ImageBase

其大小由给定bbox确定的图像类。

CMAP是一种颜色。颜色映射实例norm是一种颜色。规范化实例以将亮度映射到0-1

Kwargs是艺术家关键字args的可选列表

contains(mouseevent)

测试鼠标事件是否发生在图像中。

get_transform()

返回 Transform 此艺术家使用的实例。

get_window_extent(renderer=None)

获取显示空间中的轴边界框。

边界框的宽度和高度为非负。

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

使用此函数时要小心，如果艺术家窗口的范围发生更改，结果将不会更新。范围可能因变换堆栈中的任何更改而更改，例如更改轴限制、图形大小或使用的画布（如保存图形时所做）。这可能会导致意想不到的行为，在屏幕上交互式图形看起来很好，但保存不正确。

make_image(renderer, magnification=1.0, unsampled=False)

规格化、重缩放和颜色映射此图像的数据，以便使用 渲染器 ，与给定的 放大倍率 .

如果 未取样 为True，则不会缩放图像，但将返回适当的仿射变换。

返回:

image（M，N，4）uint8阵列

RGBA图像，重新采样，除非 未取样 是True。

x, y浮动

应绘制图像的左上角，以像素空间为单位。

trans仿射2d

从图像到像素空间的仿射变换。

class matplotlib.image.FigureImage(fig, cmap=None, norm=None, offsetx=0, offsety=0, origin=None, **kwargs)

基类：matplotlib.image._ImageBase

附在图形上的图像。

CMAP是一种颜色。颜色映射实例norm是一种颜色。规范化实例以将亮度映射到0-1

Kwargs是艺术家关键字args的可选列表

get_extent()

以元组形式返回图像范围（左、右、下、上）。

make_image(renderer, magnification=1.0, unsampled=False)

规格化、重缩放和颜色映射此图像的数据，以便使用 渲染器 ，与给定的 放大倍率 .

如果 未取样 为True，则不会缩放图像，但将返回适当的仿射变换。

返回:

image（M，N，4）uint8阵列

RGBA图像，重新采样，除非 未取样 是True。

x, y浮动

应绘制图像的左上角，以像素空间为单位。

trans仿射2d

从图像到像素空间的仿射变换。

set_data(A)

设置图像数组。

zorder = 0

class matplotlib.image.NonUniformImage(ax, *, interpolation='nearest', **kwargs)

基类：matplotlib.image.AxesImage

参数:

interpolation{'nearest'，'bilinear'}，默认值：'nearest'

**kwargs

所有其他关键字参数都与 AxesImage .

get_extent()

以元组形式返回图像范围（左、右、下、上）。

property is_grayscale

make_image(renderer, magnification=1.0, unsampled=False)

规格化、重缩放和颜色映射此图像的数据，以便使用 渲染器 ，与给定的 放大倍率 .

如果 未取样 为True，则不会缩放图像，但将返回适当的仿射变换。

返回:

image（M，N，4）uint8阵列

RGBA图像，重新采样，除非 未取样 是True。

x, y浮动

应绘制图像的左上角，以像素空间为单位。

trans仿射2d

从图像到像素空间的仿射变换。

set_array(*args)

保留为向后兼容-使用set_data代替。

参数:

A类数组

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_data(x, y, A)

为像素中心和像素值设置网格。

参数:

x, y一维阵列状

分别指定像素中心的形状（N，）和（M，）的单调数组。

A类数组

（M，N）N数组或要进行颜色映射的值的掩码数组，或（M，N，3）RGB数组，或（M，N，4）RGBA数组。

set_filternorm(s)

设置调整大小过滤器是否规范化权重。

查看帮助 imshow .

参数:

filternorm布尔

set_filterrad(s)

设置只适用于某些插值方案的调整大小过滤器半径--有关imshow，请参阅帮助

参数:

filterrad正浮标

set_interpolation(s)

参数:

s{nearest'，双线性}或无

如果没有，使用 rcParams["image.interpolation"] (default: 'antialiased') .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

class matplotlib.image.PcolorImage(ax, x=None, y=None, A=None, cmap=None, norm=None, **kwargs)

基类：matplotlib.image.AxesImage

使用不规则的矩形网格绘制PColor样式的绘图。

它使用原始不规则图像代码的变体，并由pcolorfast用于对应的网格类型。

参数:

ax ： Axes轴线

图像所属的轴。

x, y1D阵列式，可选

长度分别为N+1和M+1的单调数组，指定矩形边界。如果不违约 range(N + 1) 和 range(M + 1) ，分别。

A类数组

要进行颜色编码的数据。解释取决于形状：

• （M，N）ndarray或masked array：要进行颜色映射的值
• （M，N，3）：RGB阵列
• （M，N，4）：RGBA阵列

cmap : str or Colormap, default: rcParams["image.cmap"] (default: 'viridis')str或

用于将标量数据映射到颜色的Colormap实例或注册的Colormap名称。

norm ： Normalize归一化

将亮度映射到0-1。

**kwargs ： Artist 性质艺术家属性

get_cursor_data(event)

返回事件位置的图像值或 None 如果事件在图像之外。

参见

matplotlib.artist.Artist.get_cursor_data

property is_grayscale

make_image(renderer, magnification=1.0, unsampled=False)

规格化、重缩放和颜色映射此图像的数据，以便使用 渲染器 ，与给定的 放大倍率 .

如果 未取样 为True，则不会缩放图像，但将返回适当的仿射变换。

返回:

image（M，N，4）uint8阵列

RGBA图像，重新采样，除非 未取样 是True。

x, y浮动

应绘制图像的左上角，以像素空间为单位。

trans仿射2d

从图像到像素空间的仿射变换。

set_array(*args)

保留为向后兼容-使用set_data代替。

参数:

A类数组

set_data(x, y, A)

设置矩形边界的网格和数据值。

参数:

x, y1D阵列式，可选

长度分别为N+1和M+1的单调数组，指定矩形边界。如果不违约 range(N + 1) 和 range(M + 1) ，分别。

A类数组

要进行颜色编码的数据。解释取决于形状：

• （M，N）ndarray或masked array：要进行颜色映射的值
• （M，N，3）：RGB阵列
• （M，N，4）：RGBA阵列

matplotlib.image.composite_images(images, renderer, magnification=1.0)

将多个rgba图像合成一个。这些图像按它们在 图像 名单。

参数:

images图像列表

每个都必须有一个 make_image 方法。对于每个图像， can_composite 应该返回 True 尽管此函数不强制执行。每个图像必须有一个纯仿射变换，没有剪切。

渲染器 ： RendererBaseRendererBase

magnification浮点，默认值：1

要应用于正在使用的渲染器的附加放大倍数。

返回:

imageuint8 3d阵列

合成的RGBA图像。

offset_x, offset_y浮动

合成图像应放置在输出图形中的（左，下）偏移量。

matplotlib.image.imread(fname, format=None)

将文件中的图像读取到数组中。

参数:

fnamestr或类似文件

要读取的图像文件：以读取二进制模式打开的文件名、URL或类似文件的对象。

format可选的STR

用于读取数据的图像文件格式。如果没有给出，则从文件名中推断格式。如果无法推导出任何结果，则尝试使用png。

返回:

numpy.array

图像数据。返回的数组具有形状

• （m，n）用于灰度图像。
• （m，n，3）对于RGB图像。
• （m，n，4）对于rgba图像。

matplotlib.image.imsave(fname, arr, vmin=None, vmax=None, cmap=None, format=None, origin=None, dpi=100, *, metadata=None, pil_kwargs=None)

将数组另存为图像文件。

参数:

fnamestr或path like或file like

用于存储图像的路径或类似文件的对象。如果 格式 未设置，则从的扩展名推断输出格式 文件名 ，如果有的话，从 rcParams["savefig.format"] (default: 'png') 否则。如果 格式 设置时，它确定输出格式。

arr类数组

图像数据。形状可以是MXN（亮度）、MXNX3（RGB）或MXNX4（RGBA）之一。

VMN，Vmax可选浮动

vmin 和 vmax 通过将映射到颜色映射颜色限制的值固定，设置图像的颜色缩放。如果任一 vmin 或 vmax 为“无”，该限制由 arr 最小/最大值。

cmap : str or Colormap, default: rcParams["image.cmap"] (default: 'viridis')str或

Colormap实例或注册的Colormap名称。colormap将标量数据映射到颜色。对于RGB（A）数据，它被忽略。

format可选的STR

文件格式，例如“png”、“pdf”、“svg”。。。未设置此选项时的行为记录在下 文件名 .

起源 : {{'upper', 'lower'}}, default: rcParams["image.origin"] (default: 'upper'){'upper'，'lower'}，默认值：

指示是否 (0, 0) 数组的索引位于轴的左上角或左下角。

dpi浮动

要存储在文件元数据中的DPI。这不会影响输出图像的分辨率。根据文件格式，可以舍入到最接近的整数。

metadata可选的

图像文件中的元数据。支持的键取决于输出格式，有关详细信息，请参阅相应后端的文档。

pil_kwargs可选的

传递给的关键字参数 PIL.Image.Image.save . 如果存在“pnginfo”键，它将完全覆盖 元数据 ，包括默认的“软件”键。

matplotlib.image.pil_to_array(pilImage)

加载A PIL image 并将其作为numpy int数组返回。

返回:

numpy.array

数组形状取决于图像类型：

• （m，n）用于灰度图像。
• （m，n，3）对于RGB图像。
• （m，n，4）对于rgba图像。

matplotlib.image.thumbnail(infile, thumbfile, scale=0.1, interpolation='bilinear', preview=False)

在中制作图像的缩略图 因循守旧 带输出文件名 拇指文件 .

见 图像缩略图 .

参数:

infilestr或类似文件

图像文件。Matplotlib依赖于 Pillow 用于图像读取，因此支持多种文件格式，包括PNG、JPG、TIFF等。

thumbfilestr或类似文件

缩略图文件名。

scale浮点，默认值：0.1

缩略图的比例因子。

interpolationstr，默认值：'双线性'

重采样中使用的插值方案。见 插值 参数 imshow 对于可能的值。

previewbool，默认值：False

如果为真，则将使用默认的后端（可能是用户界面后端），如果 show 被称为。如果为假，则使用 FigureCanvasBase 绘图后端被选为 Figure.savefig 通常是这样。

返回:

Figure

包含缩略图的Figure实例。