Package org.anchoranalysis.overlay

Class Overlay

Object
Overlay
Direct Known Subclasses:
OverlayMark, OverlayObjectMask
public abstract class Overlay extends Object
An entity that will eventually be drawn on top of an image.
Author:
Owen Feehan

  • Constructor Details

    • Overlay

      protected Overlay()

  • Method Details

    • box

      public abstract BoundingBox box(DrawOverlay overlayWriter, Dimensions dimensions)
      A bounding-box around the overlay.
      Parameters:
      overlayWriter - writes the overlay on the image.
      dimensions - the dimensions of the containing-image or scene.
      Returns:
      the bounding-box.

    • createObject

      public abstract ObjectWithProperties createObject(Dimensions dimensionsEntireImage, BinaryValuesByte binaryValuesOut) throws CreateException
      Derives an object-mask representation of the overlay to be drawn with overlayWriter.
      Parameters:
      dimensionsEntireImage - how large the image is onto which the overlay will be drawn.
      binaryValuesOut - what constitutes on and off pixels in the produced object-mask.
      Returns:
      the created object-mask with associated properties.
      Throws:
      CreateException - if the object cannot be created successfully.

    • equals

      public abstract boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public abstract int hashCode()
      Overrides:
      hashCode in class Object