Class TMAGridOverlay

java.lang.Object
qupath.lib.gui.viewer.overlays.AbstractOverlay
qupath.lib.gui.viewer.overlays.TMAGridOverlay
All Implemented Interfaces:
PathOverlay

public class TMAGridOverlay extends AbstractOverlay
An overlay capable of painting a TMA Grid.
Author:
Pete Bankhead
See Also:
  • Constructor Details

    • TMAGridOverlay

      public TMAGridOverlay(OverlayOptions overlayOptions)
      Constructor.
      Parameters:
      overlayOptions - overlay options to control the display of this overlay.
  • 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.