Package qupath.lib.gui.viewer.overlays

Class GridOverlay

java.lang.Object

qupath.lib.gui.viewer.overlays.AbstractOverlay

qupath.lib.gui.viewer.overlays.GridOverlay

All Implemented Interfaces:

PathOverlay

public class GridOverlay
extends AbstractOverlay

An overlay used to show a (counting) grid on top of an image.

Author:

Pete Bankhead

Nested Class Summary

Nested classes/interfaces inherited from class qupath.lib.gui.viewer.overlays.AbstractOverlay

AbstractOverlay.LocationStringFunction

Constructor Summary

Constructors

Constructor	Description
GridOverlay(OverlayOptions overlayOptions)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	isVisible()	Check overlay visibility status.
void	paintOverlay(Graphics2D g, ImageRegion imageRegion, double downsampleFactor, ImageData<BufferedImage> imageData, boolean paintCompletely)	Paint the overlay to a graphics object.

Methods inherited from class qupath.lib.gui.viewer.overlays.AbstractOverlay

getAlphaComposite, getLocationString, getLocationStringFunction, getOpacity, getOverlayOptions, getPreferredOverlayColor, setAlphaComposite, setLocationStringFunction, setOpacity, setPreferredOverlayColor

Methods inherited from class java.lang.Object

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

Constructor Details

GridOverlay

public GridOverlay(OverlayOptions overlayOptions)

Constructor.

Parameters:

overlayOptions - overlay options to control the grid display

Method Details

isVisible

public boolean isVisible()

Description copied from class: AbstractOverlay

Check overlay visibility status. If isVisible() returns false, then calls to paintOverlay() will not do anything.

Overrides:

isVisible in class AbstractOverlay

Returns:

paintOverlay

public void paintOverlay(Graphics2D g,
 ImageRegion imageRegion,
 double downsampleFactor,
 ImageData<BufferedImage> imageData,
 boolean paintCompletely)

Description copied from interface: PathOverlay

Paint the overlay to a graphics object. The graphics object will have a transform applied to it, so the painting should make use of coordinates in the original image space.

Parameters:

g - Graphics2D object to which drawing should be performed. This should have any transform already applied to it.

imageRegion - The maximum image region that should be shown.

downsampleFactor - The downsample factor at which the overlay will be viewed. There is no need for rescaling according to this value since it has already been applied to the Graphics2D as part of its AffineTransform, however it may optionally be needed within the method e.g. to correct line thicknesses.

imageData - the ImageData associated with this overlay. If the overlay is being displayed on a viewer, this is the ImageData open within the viewer. Not all overlays require this, and it may be null.

paintCompletely - If true, the method is permitted to return without completely painting everything, for performance reasons.