mirror of
https://github.com/wassname/scikit-image.git
synced 2026-07-16 11:21:25 +08:00
Add docstring to matplotlib imshow plugin
The image is now named as an argument, and the axes are returned, in keeping with matplotlib convention.
This commit is contained in:
@@ -1,12 +1,27 @@
|
||||
import matplotlib.pyplot as plt
|
||||
|
||||
|
||||
def imshow(*args, **kwargs):
|
||||
def imshow(im, *args, **kwargs):
|
||||
"""Show the input image and return the current axes.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
im : array, shape (M, N[, 3])
|
||||
The image to display.
|
||||
|
||||
*args, **kwargs : positional and keyword arguments
|
||||
These are passed directly to `matplotlib.pyplot.imshow`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
ax : `matplotlib.pyplot.Axes`
|
||||
The axes showing the image.
|
||||
"""
|
||||
if plt.gca().has_data():
|
||||
plt.figure()
|
||||
kwargs.setdefault('interpolation', 'nearest')
|
||||
kwargs.setdefault('cmap', 'gray')
|
||||
plt.imshow(*args, **kwargs)
|
||||
return plt.imshow(im, *args, **kwargs)
|
||||
|
||||
imread = plt.imread
|
||||
show = plt.show
|
||||
|
||||
Reference in New Issue
Block a user