Matplotlib.axes.Axes.get_clip_path() in Python

Matplotlib is a library in Python and it is numerical – mathematical extension for NumPy library. The Axes Class contains most of the figure elements: Axis, Tick, Line2D, Text, Polygon, etc., and sets the coordinate system. And the instances of Axes supports callbacks through a callbacks attribute.

matplotlib.axes.Axes.get_clip_path() Function

The Axes.get_clip_path() function in axes module of matplotlib library is used to get the clip path.

Syntax: Axes.get_clip_path(self)

Parameters: This method does not accepts any parameter.

Returns: This method return the clip path.

Below examples illustrate the matplotlib.axes.Axes.get_clip_path() function in matplotlib.axes:

Example 1:

Input Image:

# Implementation of matplotlib function
import matplotlib.pyplot as plt
import matplotlib.patches as patches
import matplotlib.cbook as cbook


with cbook.get_sample_data('geek.jpg') as image_file:
    image = plt.imread(image_file)

fig, ax = plt.subplots()
im = ax.imshow(image)

patch = patches.Rectangle((0, 0),
                          260,
                          200,
                          transform = ax.transData)

if im.get_clip_path() is None:
    im.set_clip_path(patch)

fig.suptitle('matplotlib.axes.Axes.get_clip_path() \
function Example\n\n', fontweight ="bold")

plt.show()

Output:

Example 2:

# Implementation of matplotlib function
import numpy as np
import matplotlib.cm as cm
import matplotlib.pyplot as plt
from matplotlib.path import Path
from matplotlib.patches import PathPatch


delta = 0.025

x = y = np.arange(-3.0, 3.0, delta)
X, Y = np.meshgrid(x, y)

Z1 = np.exp(-X**2 - Y**2)
Z2 = np.exp(-(X - 1)**2 - (Y - 1)**2)
Z = (Z1 - Z2) * 2

path = Path([[0, 1], [1, 0], [0, -1],
             [-1, 0], [0, 1]])

patch = PathPatch(path, facecolor ='none')

fig, ax = plt.subplots()
ax.add_patch(patch)

im = ax.imshow(Z,
               interpolation ='bilinear',
               cmap = cm.gray,
               origin ='lower',
               extent =[-3, 3, -3, 3],
               clip_path = patch,
               clip_on = True)

ax.text(-2.8, 2, str(im.get_clip_path()))

fig.suptitle('matplotlib.axes.Axes.get_clip_path() \
function Example\n\n', fontweight ="bold")

plt.show()

Output: