matplotlib.figure.Figure.figimage#
- Figure.figimage(X, xo=0, yo=0, alpha=None, norm=None, cmap=None, vmin=None, vmax=None, origin=None, resize=False, *, colorizer=None, **kwargs)[source]#
向图形添加非重采样图像。
图像会根据 origin 参数附加到左下角或左上角。
- 参数:
- X
图像数据。这是一个以下形状之一的数组
(M, N):标量数据图像。颜色映射由 cmap、norm、vmin 和 vmax 控制。
(M, N, 3):带有 RGB 值(0-1 浮点或 0-255 整数)的图像。
(M, N, 4):带有 RGBA 值(0-1 浮点或 0-255 整数)的图像,即包含透明度。
- xo, yoint
x/y 图像偏移量(像素)。
- alphaNone 或 float
alpha 混合值。
- cmapstr 或
Colormap
, 默认值:rcParams["image.cmap"]
(默认值:'viridis'
) 用于将标量数据映射到颜色的颜色映射实例或已注册的颜色映射名称。
如果 X 是 RGB(A),则此参数将被忽略。
- normstr 或
Normalize
, 可选 在采用 cmap 映射颜色之前,用于将标量数据缩放到 [0, 1] 范围的归一化方法。默认情况下,使用线性缩放,将最低值映射到 0,最高值映射到 1。
如果给定,可以是以下之一
一个刻度名称,例如 "linear"、"log"、"symlog"、"logit" 等。有关可用刻度的列表,请调用
matplotlib.scale.get_scale_names()
。在这种情况下,将动态生成并实例化一个合适的Normalize
子类。
如果 X 是 RGB(A),则此参数将被忽略。
- vmin, vmax浮点型,可选
当使用标量数据且没有显式 norm 时,vmin 和 vmax 定义了颜色图覆盖的数据范围。默认情况下,颜色图覆盖所提供数据的完整值范围。当给定 norm 实例时使用 vmin/vmax 会导致错误(但将
str
norm 名称与 vmin/vmax 一起使用是可以接受的)。如果 X 是 RGB(A),则此参数将被忽略。
- origin{'upper', 'lower'}, 默认值:
rcParams["image.origin"]
(默认值:'upper'
) 指示数组的 [0, 0] 索引位于 Axes 的左上角还是左下角。
- resizebool
如果为 True,则调整图形大小以匹配给定的图像大小。
- colorizer
Colorizer
或 None, 默认值: None 用于将颜色映射到数据的 Colorizer 对象。如果为 None,则从 norm 和 cmap 创建一个 Colorizer 对象。
如果 X 是 RGB(A),则此参数将被忽略。
- 返回:
- 其他参数:
- **kwargs
附加的 kwargs 是传递给
Artist
的 kwargs,会传递给FigureImage
。
备注
figimage 补充了 Axes 图像(
imshow
),后者将被重新采样以适应当前的 Axes。如果你希望重新采样的图像填充整个图形,可以定义一个范围为 [0, 0, 1, 1] 的Axes
。示例
f = plt.figure() nx = int(f.get_figwidth() * f.dpi) ny = int(f.get_figheight() * f.dpi) data = np.random.random((ny, nx)) f.figimage(data) plt.show()