You are reading an old version of the documentation (v3.1.3). For the latest version see https://matplotlib.org/stable/gallery/images_contours_and_fields/image_clip_path.html
Version 3.1.3
matplotlib
Fork me on GitHub

Table of Contents

Related Topics

Clipping images with patches

Demo of image that's been clipped by a circular patch.

import matplotlib.pyplot as plt
import matplotlib.patches as patches
import matplotlib.cbook as cbook


with cbook.get_sample_data('grace_hopper.png') as image_file:
    image = plt.imread(image_file)

fig, ax = plt.subplots()
im = ax.imshow(image)
patch = patches.Circle((260, 200), radius=200, transform=ax.transData)
im.set_clip_path(patch)

ax.axis('off')
plt.show()
../../_images/sphx_glr_image_clip_path_001.png

References

The use of the following functions and methods is shown in this example:

import matplotlib
matplotlib.axes.Axes.imshow
matplotlib.pyplot.imshow
matplotlib.artist.Artist.set_clip_path

Out:

<function Artist.set_clip_path at 0x7f18a862d1f0>

Keywords: matplotlib code example, codex, python plot, pyplot Gallery generated by Sphinx-Gallery