Package qupath.lib.gui.viewer

Class QuPathViewerPlus

java.lang.Object

qupath.lib.gui.viewer.QuPathViewer

qupath.lib.gui.viewer.QuPathViewerPlus

All Implemented Interfaces:

EventListener, TileListener<BufferedImage>, PathObjectHierarchyListener, PathObjectSelectionListener

public class QuPathViewerPlus
extends QuPathViewer

A whole slide viewer with optional extras... i.e. an overview, scalebar, location string...

Author:

Pete Bankhead

Property Summary

Properties inherited from class qupath.lib.gui.viewer.QuPathViewer

gamma, imageData, rotation, tPosition, zPosition

Field Summary

Fields inherited from class qupath.lib.gui.viewer.QuPathViewer

imageUpdated, locationUpdated

Constructor Summary

Constructors

Constructor	Description
QuPathViewerPlus(DefaultImageRegionStore regionStore, OverlayOptions overlayOptions, ViewerPlusDisplayOptions viewerDisplayOptions)	Create a new viewer.

Method Summary

Modifier and Type	Method	Description
void	closeViewer()	Request that this viewer is closed.
void	initializeForServer(ImageServer<BufferedImage> server)
boolean	isLocationVisible()	Returns true if the cursor location is visible, false otherwise.
boolean	isOverviewVisible()	Returns true if the image overview is visible, false otherwise.
boolean	isScalebarVisible()	Returns true if the scalebar is visible, false otherwise.
void	repaintEntireImage()	Request that the entire image is repainted, including the thumbnail.
void	setSlidersPosition(boolean down)	Sets the Z and T sliders' position to allow space for command bar
protected void	updateAffineTransform()

Methods inherited from class qupath.lib.gui.viewer.QuPathViewer

addViewerListener, centerImage, centerROI, componentContains, componentPointToImagePoint, componentPointToImagePoint, fireImageDataChanged, fireVisibleRegionChangedEvent, forceOverlayUpdate, gammaProperty, getActiveTool, getAllSelectedObjects, getAllThumbnails, getBorderColor, getCenterPixelX, getCenterPixelY, getCurrentROI, getCursor, getCustomOverlayLayers, getCustomPixelLayerOverlay, getDefaultZoomFactor, getDisplayedClipShape, getDisplayedRegionShape, getDownsampleFactor, getFullLocationString, getFullMagnification, getGamma, getGammaOp, getHierarchy, getImageData, getImageDisplay, getImageObjectClassificationString, getImagePlane, getImageRegionStore, getMagnification, getMaxDownsample, getMaxROIHandleSize, getMinDownsample, getMousePosition, getObjectClassificationString, getOverlayLayers, getOverlayOptions, getRenderer, getRGBThumbnail, getROIEditor, getRotation, getSelectedObject, getServer, getServerBounds, getServerHeight, getServerWidth, getThumbnail, getTPosition, getView, getZoomToFitDownsampleFactor, getZPosition, hasServer, hierarchyChanged, imageDataProperty, imagePointToComponentPoint, isImageDataChanging, isRotated, isShowing, isSpaceDown, paintComponent, paintViewer, removeViewerListener, repaint, repaintTimestamp, requestCancelDirection, requestDecelerate, requestStartMoving, requestStopMoving, requiresTileRegion, resetCustomPixelLayerOverlay, resetImageData, resetMinimumRepaintSpacingMillis, rotationProperty, selectedPathObjectChanged, setActiveTool, setBorderColor, setCenterPixelLocation, setCursor, setCustomPixelLayerOverlay, setDoFasterRepaint, setDownsampleFactor, setDownsampleFactor, setDownsampleFactor, setGamma, setImageData, setMagnification, setMinimumRepaintSpacingMillis, setRotation, setSelectedObject, setSelectedObject, setSpaceDown, setTPosition, setZPosition, tileAvailable, toString, tPositionProperty, updateCursor, zoomIn, zoomIn, zoomOut, zoomOut, zoomToFit, zPositionProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

QuPathViewerPlus

public QuPathViewerPlus(DefaultImageRegionStore regionStore,
 OverlayOptions overlayOptions,
 ViewerPlusDisplayOptions viewerDisplayOptions)

Create a new viewer.

Parameters:

regionStore - store used to tile caching

overlayOptions - overlay options to control the viewer display

viewerDisplayOptions - viewer options to control additional panes and labels

Method Details

initializeForServer

public void initializeForServer(ImageServer<BufferedImage> server)

Overrides:

initializeForServer in class QuPathViewer

isLocationVisible

public boolean isLocationVisible()

Returns true if the cursor location is visible, false otherwise.

Returns:

isScalebarVisible

public boolean isScalebarVisible()

Returns true if the scalebar is visible, false otherwise.

Returns:

isOverviewVisible

public boolean isOverviewVisible()

Returns true if the image overview is visible, false otherwise.

Returns:

setSlidersPosition

public void setSlidersPosition(boolean down)

Sets the Z and T sliders' position to allow space for command bar

Parameters:

down -

closeViewer

public void closeViewer()

Description copied from class: QuPathViewer

Request that this viewer is closed. This unbinds the viewer from any properties it may be observing, and also triggers QuPathViewerListener.viewerClosed(QuPathViewer) calls for any viewer listeners.

Overrides:

closeViewer in class QuPathViewer

updateAffineTransform

protected void updateAffineTransform()

Overrides:

updateAffineTransform in class QuPathViewer

repaintEntireImage

public void repaintEntireImage()

Description copied from class: QuPathViewer

Request that the entire image is repainted, including the thumbnail. This should be called whenever a major change in display is triggered, such as changing the brightness/contrast or lookup table. Otherwise, QuPathViewer.repaint() is preferable.

Overrides:

repaintEntireImage in class QuPathViewer

See Also:

• QuPathViewer.repaint()