Package qupath.lib.gui.viewer.overlays

Class ZProjectOverlay

java.lang.Object

qupath.lib.gui.viewer.overlays.AbstractOverlay

qupath.lib.gui.viewer.overlays.AbstractImageOverlay

qupath.lib.gui.viewer.overlays.ZProjectOverlay

All Implemented Interfaces:

PathOverlay

public class ZProjectOverlay
extends AbstractImageOverlay

Property Summary

Properties

Type	Property	Description
ObjectProperty<ZProjectedImageServer.Projection>	projection
ObjectProperty<ImageRenderer>	renderer	Get the ImageRenderer property used with this overlay.

Properties inherited from class qupath.lib.gui.viewer.overlays.AbstractImageOverlay

interpolation

Nested Class Summary

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

AbstractOverlay.LocationStringFunction

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ZProjectOverlay(OverlayOptions options)

Method Summary

Modifier and Type	Method	Description
static ZProjectOverlay	create(QuPathViewer viewer)
ZProjectedImageServer.Projection	getProjection()	Gets the value of the projection property.
ImageRenderer	getRenderer()	Get the ImageRenderer used with this overlay, which may be null.
void	paintOverlay(Graphics2D g2d, ImageRegion imageRegion, double downsampleFactor, ImageData<BufferedImage> imageData, boolean paintCompletely)	Paint the overlay to a graphics object.
ObjectProperty<ZProjectedImageServer.Projection>	projectionProperty()
ObjectProperty<ImageRenderer>	rendererProperty()	Get the ImageRenderer property used with this overlay.
void	setProjection(ZProjectedImageServer.Projection projection)	Sets the value of the projection property.
void	setRenderer(ImageRenderer renderer)	Set the ImageRenderer property used with this overlay.

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

getInterpolation, interpolationProperty, setInterpolation, setInterpolation

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

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

Methods inherited from class java.lang.Object

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

Property Details

projection

public ObjectProperty<ZProjectedImageServer.Projection> projectionProperty

See Also:

• getProjection()
• setProjection(ZProjectedImageServer.Projection)
• projectionProperty()

renderer

public ObjectProperty<ImageRenderer> rendererProperty

Get the ImageRenderer property used with this overlay.

See Also:

• getRenderer()
• setRenderer(ImageRenderer)
• rendererProperty()

Constructor Details

ZProjectOverlay

protected ZProjectOverlay(OverlayOptions options)

Method Details

create

public static ZProjectOverlay create(QuPathViewer viewer)

getProjection

public ZProjectedImageServer.Projection getProjection()

Gets the value of the projection property.

Property description:

Returns:

the value of the projection property

See Also:

• setProjection(ZProjectedImageServer.Projection)
• projectionProperty()

projectionProperty

public ObjectProperty<ZProjectedImageServer.Projection> projectionProperty()

Returns:

the projection property

See Also:

• getProjection()
• setProjection(ZProjectedImageServer.Projection)

setProjection

public void setProjection(ZProjectedImageServer.Projection projection)

Sets the value of the projection property.

Property description:

Parameters:

projection - the value for the projection property

See Also:

• getProjection()
• projectionProperty()

rendererProperty

public ObjectProperty<ImageRenderer> rendererProperty()

Get the ImageRenderer property used with this overlay.

Returns:

See Also:

• getRenderer()
• setRenderer(ImageRenderer)

setRenderer

public void setRenderer(ImageRenderer renderer)

Set the ImageRenderer property used with this overlay.

getRenderer

public ImageRenderer getRenderer()

Get the ImageRenderer used with this overlay, which may be null.

Returns:

paintOverlay

public void paintOverlay(Graphics2D g2d,
 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.

Specified by:

paintOverlay in interface PathOverlay

Overrides:

paintOverlay in class AbstractImageOverlay

Parameters:

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