### Navigation

- index
- modules |
- next |
- previous |
- home|
- examples|
- tutorials|
- pyplot|
- docs »
- The Matplotlib API »
- matplotlib.pyplot »

# matplotlib.pyplot.figimage

`matplotlib.pyplot.``figimage`(*args, **kwargs)

  Adds a non-resampled image to the figure.

  call signatures:

      figimage(X, **kwargs)

  adds a non-resampled array X to the figure.

      figimage(X, xo, yo)

  with pixel offsets xo, yo,

  X must be a float array:

  - If X is MxN, assume luminance (grayscale)
  - If X is MxNx3, assume RGB
  - If X is MxNx4, assume RGBA

  Optional keyword arguments:

  > Keyword | Description
  > --- | ---
  > resize | a boolean, True or False. If “True”, then re-size the Figure to match the given image size.
  > xo or yo | An integer, the x and y image offset in pixels
  > cmap | a `matplotlib.colors.Colormap` instance, e.g., cm.jet. If None, default to the rc `image.cmap` value
  > norm | a `matplotlib.colors.Normalize` instance. The default is normalization(). This scales luminance -> 0-1
  > vmin|vmax | are used to scale a luminance image to 0-1. If either is None, the min and max of the luminance values will be used. Note if you pass a norm instance, the settings for vmin and vmax will be ignored.
  > alpha | the alpha blending value, default is None
  > origin | [ ‘upper’ | ‘lower’ ] Indicates where the [0,0] index of the array is in the upper left or lower left corner of the axes. Defaults to the rc image.origin value

  figimage complements the axes image (`imshow()`) which will be resampled to fit the current axes. If you want a resampled image to fill the entire figure, you can define an `Axes` with extent [0,0,1,1].

  An `matplotlib.image.FigureImage` instance is returned.

  Additional kwargs are Artist kwargs passed on to `FigureImage`