matplotlib 3.5.1

NotesOther ParametersParametersReturns
figimage(self, X, xo=0, yo=0, alpha=None, norm=None, cmap=None, vmin=None, vmax=None, origin=None, resize=False, **kwargs)

The image is attached to the lower or upper left corner depending on origin.

Notes

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].

Other Parameters

**kwargs :

Additional kwargs are .Artist kwargs passed on to .FigureImage .

Parameters

X :

The image data. This is an array of one of the following shapes:

  • MxN: luminance (grayscale) values

  • MxNx3: RGB values

  • MxNx4: RGBA values

xo, yo : int

The x/y image offset in pixels.

alpha : None or float

The alpha blending value.

norm : `matplotlib.colors.Normalize`

A .Normalize instance to map the luminance to the interval [0, 1].

cmap : str or `matplotlib.colors.Colormap`, default: :rc:`image.cmap`

The colormap to use.

vmin, vmax : float

If norm is not given, these values set the data limits for the colormap.

origin : {'upper', 'lower'}, default: :rc:`image.origin`

Indicates where the [0, 0] index of the array is in the upper left or lower left corner of the axes.

resize : bool

If True, resize the figure to match the given image size.

Returns

`matplotlib.image.FigureImage`

Add a non-resampled image to the figure.

Examples

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()

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /matplotlib/figure.py#2543
type: <class 'function'>
Commit: