Commitc778bd9

committed

Add docstring to _get_scalar_alpha.

1 parent5a263e9 commitc778bd9Copy full SHA for c778bd9

File tree

-0

lines changed

-0

lines changed

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -293,6 +293,15 @@ def set_alpha(self, alpha):`
`293`	`293`	`self._imcache=None`
`294`	`294`
`295`	`295`	`def_get_scalar_alpha(self):`
	`296`	`+"""`
	`297`	`+ Get a scalar alpha value to be applied to the artist as a whole.`
	`298`	`+`
	`299`	`+ If the alpha value is a matrix, the method returns 1.0 because pixels`
	`300`	+ have individual alpha values (see `~._ImageBase._make_image` for
	`301`	`+ details). If the alpha value is a scalar, the method returns said value`
	`302`	`+ to be applied to the artist as a whole because pixels do not have`
	`303`	`+ individual alpha values.`
	`304`	`+ """`
`296`	`305`	`return1.0ifself._alphaisNoneornp.ndim(self._alpha)>0 \`
`297`	`306`	`elseself._alpha`
`298`	`307`

Comments

(0)