Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 03517d0

Browse filesBrowse files
committed
DOC: Improve NonUniformImage docs
1 parent 677d990 commit 03517d0
Copy full SHA for 03517d0

File tree

2 files changed

+15
-4
lines changed
Filter options

2 files changed

+15
-4
lines changed

‎galleries/examples/images_contours_and_fields/image_nonuniform.py

Copy file name to clipboardExpand all lines: galleries/examples/images_contours_and_fields/image_nonuniform.py
+6-3Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@
33
Image nonuniform
44
================
55
6-
This illustrates the NonUniformImage class. It is not
7-
available via an Axes method, but it is easily added to an
8-
Axes instance as shown here.
6+
`.NonUniformImage` is a generalized image with pixels on a rectilinear grid,
7+
i.e. it allows rows and columns with individual heights / widths.
8+
9+
There is no high-level plotting method on `.Axes` or `pyplot` to create a
10+
NonUniformImage. Instead, you have to instantiate the image explicitly and
11+
add it to the Axes using `.Axes.add_image`.
912
"""
1013

1114
import matplotlib.pyplot as plt

‎lib/matplotlib/image.py

Copy file name to clipboardExpand all lines: lib/matplotlib/image.py
+9-1Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -808,7 +808,7 @@ def get_filterrad(self):
808808

809809
class AxesImage(_ImageBase):
810810
"""
811-
An image attached to an Axes.
811+
An image, i.e. data on a regular grid, attached to an Axes.
812812
813813
Parameters
814814
----------
@@ -995,6 +995,14 @@ def get_cursor_data(self, event):
995995

996996

997997
class NonUniformImage(AxesImage):
998+
"""
999+
An image with pixel on a rectilinear grid.
1000+
1001+
In contrast to `.AxesImage`, where pixels are on a regular grid,
1002+
NonUniformImage allows rows and columns with individual heights / widths.
1003+
1004+
See also :doc:`/gallery/images_contours_and_fields/image_nonuniform`.
1005+
"""
9981006

9991007
def __init__(self, ax, *, interpolation='nearest', **kwargs):
10001008
"""

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.