net.imagej.overlay

Interface Overlay

All Superinterfaces:

AnnotatedSpace<CalibratedAxis>, CalibratedRealInterval<CalibratedAxis>, CalibratedSpace<CalibratedAxis>, Contextual, Data, EuclideanSpace, Named, RealInterval, TypedRealInterval<CalibratedAxis>, TypedSpace<CalibratedAxis>

All Known Implementing Classes:

AbstractOverlay, AbstractROIOverlay, AngleOverlay, BinaryMaskOverlay, CompositeOverlay, EllipseOverlay, GeneralPathOverlay, LineOverlay, PointOverlay, PolygonOverlay, RectangleOverlay, TextOverlay

public interface Overlay
extends Data

An overlay is a vector object, typically displayed with Datasets. Many (but not all) overlays have an associated ImgLib RegionOfInterest allowing iteration over pixel values deemed included in the overlay.

Author:

Lee Kamentsky, Curtis Rueden

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Overlay.ArrowStyle Arrow decorations for the start and end.
static class	Overlay.LineStyle The style used to render the bounding line of the overlay.

Method Summary

Modifier and Type	Method and Description
Overlay	duplicate()
int	getAlpha()
ColorRGB	getFillColor()
ColorRGB	getLineColor()
Overlay.ArrowStyle	getLineEndArrowStyle()
Overlay.ArrowStyle	getLineStartArrowStyle()
Overlay.LineStyle	getLineStyle() Get the style of the outline line
double	getLineWidth()
RegionOfInterest	getRegionOfInterest() Retrieves the ImgLib region of interest, if any, that knows how to determine whether a pixel is included in the overlay.
void	move(double[] deltas)
void	rebuild() Informs interested parties that the data object has undergone a major change, such as the dimensional extents changing.
void	setAlpha(int alpha)
void	setFillColor(ColorRGB fillColor)
void	setLineColor(ColorRGB lineColor) Set the color of the outline line of the overlay, if appropriate
void	setLineEndArrowStyle(Overlay.ArrowStyle style)
void	setLineStartArrowStyle(Overlay.ArrowStyle style)
void	setLineStyle(Overlay.LineStyle style) Set the style of the outline line of the overlay, if appropriate
void	setLineWidth(double lineWidth) Set the width of the outline line of the overlay, if appropriate
void	update() Informs interested parties that the data object has undergone a non-structural change, such as sample values being updated.

Methods inherited from interface net.imagej.Data

decrementReferences, incrementReferences

Methods inherited from interface net.imglib2.RealInterval

maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMax, realMin, realMin, realMin

Methods inherited from interface net.imagej.space.CalibratedSpace

averageScale

Methods inherited from interface net.imagej.space.TypedSpace

dimensionIndex

Methods inherited from interface net.imagej.space.AnnotatedSpace

axes, axis, setAxis

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Named

getName, setName

Method Detail

getRegionOfInterest

RegionOfInterest getRegionOfInterest()

Retrieves the ImgLib region of interest, if any, that knows how to determine whether a pixel is included in the overlay.

Returns:

the region of interest or null if none supported.

getAlpha

int getAlpha()

Returns:

the opacity of the interior of the overlay, from 0-255

setAlpha

void setAlpha(int alpha)

Parameters:

alpha - the opacity of the interior of the overlay, from 0-255

getFillColor

ColorRGB getFillColor()

Returns:

the fill color for overlays that have an interior

setFillColor

void setFillColor(ColorRGB fillColor)

Parameters:

fillColor - the fill color for overlays that have an interior

getLineColor

ColorRGB getLineColor()

Returns:

the color of the outline line of the overlay

setLineColor

void setLineColor(ColorRGB lineColor)

Set the color of the outline line of the overlay, if appropriate

Parameters:

lineColor -

getLineWidth

double getLineWidth()

Returns:

the width of the outline line in pixels

setLineWidth

void setLineWidth(double lineWidth)

Set the width of the outline line of the overlay, if appropriate

Parameters:

lineWidth - the width to be used when painting lines and shape borders, in pixels.

getLineStyle

Overlay.LineStyle getLineStyle()

Get the style of the outline line

Returns:

the outline line style.

setLineStyle

void setLineStyle(Overlay.LineStyle style)

Set the style of the outline line of the overlay, if appropriate

Parameters:

style - - style of line

getLineStartArrowStyle

Overlay.ArrowStyle getLineStartArrowStyle()

Returns:

the arrow style at the start of a line or path (if appropriate)

setLineStartArrowStyle

void setLineStartArrowStyle(Overlay.ArrowStyle style)

Parameters:

style - the arrow style to be shown at the start of a line or path

getLineEndArrowStyle

Overlay.ArrowStyle getLineEndArrowStyle()

Returns:

the arrow style at the end of a line or path (if appropriate)

setLineEndArrowStyle

void setLineEndArrowStyle(Overlay.ArrowStyle style)

Parameters:

style - the arrow style to be shown at the end of a line or path

duplicate

Overlay duplicate()

move

void move(double[] deltas)

update

void update()

Informs interested parties that the data object has undergone a non-structural change, such as sample values being updated.

Specified by:

update in interface Data

See Also:

OverlayUpdatedEvent

rebuild

void rebuild()

Informs interested parties that the data object has undergone a major change, such as the dimensional extents changing.

Specified by:

rebuild in interface Data

See Also:

OverlayRestructuredEvent