Commit03517d0

committed

DOC: Improve NonUniformImage docs

1 parent677d990 commit03517d0Copy full SHA for 03517d0

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` 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`.
`9`	`12`	`"""`
`10`	`13`
`11`	`14`	`importmatplotlib.pyplotasplt`

Lines changed: 9 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -808,7 +808,7 @@ def get_filterrad(self):`
`808`	`808`
`809`	`809`	`classAxesImage(_ImageBase):`
`810`	`810`	`"""`
`811`		`- An image attached to an Axes.`
	`811`	`+ An image, i.e. data on a regular grid, attached to an Axes.`
`812`	`812`
`813`	`813`	`Parameters`
`814`	`814`	`----------`
`@@ -995,6 +995,14 @@ def get_cursor_data(self, event):`
`995`	`995`
`996`	`996`
`997`	`997`	`classNonUniformImage(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`	`+ """`
`998`	`1006`
`999`	`1007`	`def__init__(self,ax,,interpolation='nearest',*kwargs):`
`1000`	`1008`	`"""`

Comments

(0)