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)

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_collectionlist 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.

__init__(self, image_collection, update_on='move', **kwargs)

Initialize self. See help(type(self)) for accurate signature.

keyPressEvent(self, QKeyEvent)

update_index(self, name, index)

Select image on display using index into image collection.

ImageViewer

class skimage.viewer.viewers.ImageViewer(image, useblit=True)

Bases: PyQt5.QtWidgets.QMainWindow

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

imagearray

Image being viewed.

Examples

>>> from skimage import data
>>> image = data.coins()
>>> viewer = ImageViewer(image) 
>>> viewer.show()               

Attributes

canvas, fig, axMatplotlib canvas, figure, and axes

Matplotlib canvas, figure, and axes used to display image.

imagearray

Image being viewed. Setting this value will update the displayed frame.

original_imagearray

Plugins typically operate on (but don’t change) the original image.

pluginslist

List of attached plugins.

__init__(self, image, useblit=True)

Initialize self. See help(type(self)) for accurate signature.

add_tool(self, tool)

closeEvent(self, QCloseEvent)

connect_event(self, event, callback)

Connect callback function to matplotlib event and return id.

disconnect_event(self, callback_id)

Disconnect callback by its id (returned by connect_event).

dock_areas = {'bottom': 8, 'left': 1, 'right': 2, 'top': 4}

property image

open_file(self, filename=None)

Open image file and display in viewer.

original_image_changed

redraw(self)

remove_tool(self, tool)

reset_image(self)

save_to_file(self, filename=None)

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(self, main_window=True)

Show ImageViewer and attached plugins.

This behaves much like matplotlib.pyplot.show and QWidget.show.

update_image(self, image)

Update displayed image.

This method can be overridden or extended in subclasses and plugins to react to image changes.