Package org.anchoranalysis.overlay
Class Overlay
Object
org.anchoranalysis.overlay.Overlay
- Direct Known Subclasses:
OverlayObjectMask
public abstract class Overlay extends Object
An entity that will eventually be drawn on top of an image.
- Author:
- Owen Feehan
-
Constructor Summary
Constructors Modifier Constructor Description protectedOverlay() -
Method Summary
Modifier and Type Method Description abstract org.anchoranalysis.spatial.box.BoundingBoxbox(DrawOverlay overlayWriter, Dimensions dimensions)A bounding-box around the overlay.abstract ObjectWithPropertiescreateObject(Dimensions dimensionsEntireImage, org.anchoranalysis.image.voxel.binary.values.BinaryValuesByte binaryValuesOut)Derives an object-mask representation of the overlay to be drawn withoverlayWriter.abstract booleanequals(Object obj)abstract inthashCode()
-
Constructor Details
-
Overlay
protected Overlay()
-
-
Method Details
-
box
public abstract org.anchoranalysis.spatial.box.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, org.anchoranalysis.image.voxel.binary.values.BinaryValuesByte binaryValuesOut) throws CreateExceptionDerives an object-mask representation of the overlay to be drawn withoverlayWriter.- 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
-
hashCode
public abstract int hashCode()
-