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
-
Property Summary
PropertiesTypePropertyDescriptionObjectProperty<qupath.lib.images.servers.ZProjectedImageServer.Projection> Get theImageRendererproperty 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 -
Method Summary
Modifier and TypeMethodDescriptionstatic ZProjectOverlaycreate(QuPathViewer viewer) qupath.lib.images.servers.ZProjectedImageServer.ProjectionGets the value of theprojectionproperty.Get theImageRendererused with this overlay, which may be null.voidpaintOverlay(Graphics2D g2d, qupath.lib.regions.ImageRegion imageRegion, double downsampleFactor, qupath.lib.images.ImageData<BufferedImage> imageData, boolean paintCompletely) Paint the overlay to a graphics object.ObjectProperty<qupath.lib.images.servers.ZProjectedImageServer.Projection> Get theImageRendererproperty used with this overlay.voidsetProjection(qupath.lib.images.servers.ZProjectedImageServer.Projection projection) Sets the value of theprojectionproperty.voidsetRenderer(ImageRenderer renderer) Set theImageRendererproperty used with this overlay.Methods inherited from class qupath.lib.gui.viewer.overlays.AbstractImageOverlay
getInterpolation, interpolationProperty, setInterpolation, setInterpolationMethods inherited from class qupath.lib.gui.viewer.overlays.AbstractOverlay
getAlphaComposite, getLocationString, getLocationStringFunction, getOpacity, getOverlayOptions, getPreferredOverlayColor, isVisible, setAlphaComposite, setLocationStringFunction, setOpacity, setPreferredOverlayColor
-
Property Details
-
projection
public ObjectProperty<qupath.lib.images.servers.ZProjectedImageServer.Projection> projectionProperty- See Also:
-
renderer
Get theImageRendererproperty used with this overlay.- See Also:
-
-
Constructor Details
-
ZProjectOverlay
-
-
Method Details
-
create
-
getProjection
public qupath.lib.images.servers.ZProjectedImageServer.Projection getProjection()Gets the value of theprojectionproperty.- Property description:
- Returns:
- the value of the
projectionproperty - See Also:
-
projectionProperty
public ObjectProperty<qupath.lib.images.servers.ZProjectedImageServer.Projection> projectionProperty()- Returns:
- the
projectionproperty - See Also:
-
setProjection
public void setProjection(qupath.lib.images.servers.ZProjectedImageServer.Projection projection) Sets the value of theprojectionproperty.- Property description:
- Parameters:
projection- the value for theprojectionproperty- See Also:
-
rendererProperty
Get theImageRendererproperty used with this overlay.- Returns:
- See Also:
-
setRenderer
Set theImageRendererproperty used with this overlay. -
getRenderer
Get theImageRendererused with this overlay, which may be null.- Returns:
-
paintOverlay
public void paintOverlay(Graphics2D g2d, qupath.lib.regions.ImageRegion imageRegion, double downsampleFactor, qupath.lib.images.ImageData<BufferedImage> imageData, boolean paintCompletely) Description copied from interface:PathOverlayPaint 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:
paintOverlayin interfacePathOverlay- Overrides:
paintOverlayin classAbstractImageOverlay- 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 theGraphics2Das part of itsAffineTransform, however it may optionally be needed within the method e.g. to correct line thicknesses.imageData- theImageDataassociated with this overlay. If the overlay is being displayed on a viewer, this is theImageDataopen 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.
-