Commit2322a8f

authored

Merge pull request#29987 from meeseeksmachine/auto-backport-of-pr-29370-on-v3.10.x

Backport PR#29370 on branch v3.10.x (DOC: Improve NonUniformImage docs)

2 parents495fb64 +7dab28b commit2322a8fCopy full SHA for 2322a8f

File tree

+15

-4

lines changed

+15

-4

lines changed

Lines changed: 6 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,12 @@`
`3`	`3`	`Image nonuniform`
`4`	`4`	`================`
`5`	`5`
`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.Axes` or `.pyplot` to
	`10`	`+create a NonUniformImage. Instead, you have to instantiate the image`
	`11`	+explicitly add it to the Axes using `.Axes.add_image`.
`9`	`12`	`"""`
`10`	`13`
`11`	`14`	`importmatplotlib.pyplotasplt`

Lines changed: 9 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -818,7 +818,7 @@ def get_filterrad(self):`
`818`	`818`
`819`	`819`	`classAxesImage(_ImageBase):`
`820`	`820`	`"""`
`821`		`- An image attached to an Axes.`
	`821`	`+ An imagewith pixels on a regular grid,attached to an Axes.`
`822`	`822`
`823`	`823`	`Parameters`
`824`	`824`	`----------`
`@@ -1005,6 +1005,14 @@ def get_cursor_data(self, event):`
`1005`	`1005`
`1006`	`1006`
`1007`	`1007`	`classNonUniformImage(AxesImage):`
	`1008`	`+"""`
	`1009`	`+ An image with pixels on a rectilinear grid.`
	`1010`	`+`
	`1011`	+ In contrast to `.AxesImage`, where pixels are on a regular grid,
	`1012`	`+ NonUniformImage allows rows and columns with individual heights / widths.`
	`1013`	`+`
	`1014`	+ See also :doc:`/gallery/images_contours_and_fields/image_nonuniform`.
	`1015`	`+ """`
`1008`	`1016`
`1009`	`1017`	`def__init__(self,ax,,interpolation='nearest',*kwargs):`
`1010`	`1018`	`"""`

Comments

(0)