Module: viewer.viewers
¶
skimage.viewer.viewers.CollectionViewer (…) |
Viewer for displaying image collections. |
skimage.viewer.viewers.ImageViewer (image[, …]) |
Viewer for displaying images. |
skimage.viewer.viewers.core |
ImageViewer class for viewing and interacting with images. |
CollectionViewer
¶
-
class
skimage.viewer.viewers.
CollectionViewer
(image_collection, update_on='move', **kwargs)[source]¶ Bases:
skimage.viewer.viewers.core.ImageViewer
Viewer for displaying image collections.
Select the displayed frame of the image collection using the slider or with the following keyboard shortcuts:
- left/right arrows
- Previous/next image in collection.
- number keys, 0–9
- 0% to 90% of collection. For example, “5” goes to the image in the middle (i.e. 50%) of the collection.
- home/end keys
- First/last image in collection.
Parameters: image_collection : list of images
List of images to be displayed.
update_on : {‘move’ | ‘release’}
Control whether image is updated on slide or release of the image slider. Using ‘on_release’ will give smoother behavior when displaying large images or when writing a plugin/subclass that requires heavy computation.
ImageViewer
¶
-
class
skimage.viewer.viewers.
ImageViewer
(image, useblit=True)[source]¶ Bases:
object
Viewer for displaying images.
This viewer is a simple container object that holds a Matplotlib axes for showing images.
ImageViewer
doesn’t subclass the Matplotlib axes (or figure) because of the high probability of name collisions.Subclasses and plugins will likely extend the
update_image
method to add custom overlays or filter the displayed image.Parameters: image : array
Image being viewed.
Examples
>>> from skimage import data >>> image = data.coins() >>> viewer = ImageViewer(image) # doctest: +SKIP >>> viewer.show() # doctest: +SKIP
Attributes
canvas, fig, ax (Matplotlib canvas, figure, and axes) Matplotlib canvas, figure, and axes used to display image. image (array) Image being viewed. Setting this value will update the displayed frame. original_image (array) Plugins typically operate on (but don’t change) the original image. plugins (list) List of attached plugins. -
__init__
(image, useblit=True)[source]¶ Initialize self. See help(type(self)) for accurate signature.
-
connect_event
(event, callback)[source]¶ Connect callback function to matplotlib event and return id.
-
disconnect_event
(callback_id)[source]¶ Disconnect callback by its id (returned by
connect_event
).
-
dock_areas
= {'bottom': None, 'left': None, 'right': None, 'top': None}¶
-
image
¶
-
original_image_changed
= None¶
-
save_to_file
(filename=None)[source]¶ Save current image to file.
The current behavior is not ideal: It saves the image displayed on screen, so all images will be converted to RGB, and the image size is not preserved (resizing the viewer window will alter the size of the saved image).
-
show
(main_window=True)[source]¶ Show ImageViewer and attached plugins.
This behaves much like
matplotlib.pyplot.show
and QWidget.show.
-