AbstractOverlay (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.space.AbstractAnnotatedSpace<A>
- - net.imagej.space.AbstractTypedSpace<A>
  - - net.imagej.space.AbstractCalibratedSpace<A>
    - - net.imagej.interval.AbstractCalibratedRealInterval<CalibratedAxis>
      - net.imagej.AbstractData
        
        net.imagej.overlay.AbstractOverlay

All Implemented Interfaces:

Externalizable, Serializable, Comparable<Data>, Data, CalibratedRealInterval<CalibratedAxis>, TypedRealInterval<CalibratedAxis>, Overlay, AnnotatedSpace<CalibratedAxis>, CalibratedSpace<CalibratedAxis>, TypedSpace<CalibratedAxis>, EuclideanSpace, RealInterval, Contextual, Named

Direct Known Subclasses:

AbstractROIOverlay
```
public abstract class AbstractOverlay
extends AbstractData
implements Overlay
```
Abstract superclass of Overlay implementations.

Author:

Lee Kamentsky, Curtis Rueden

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface net.imagej.overlay.Overlay
  Overlay.ArrowStyle, Overlay.LineStyle

Constructor Summary

Constructors
Constructor and Description

AbstractOverlay(Context context, RealInterval interval)

AbstractOverlay(RealInterval interval)

Constructors
Constructor and Description
`AbstractOverlay(Context context, RealInterval interval)`
`AbstractOverlay(RealInterval interval)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()` Informs interested parties that the data object is no longer relevant and should be deleted.
`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.
`int`	`numDimensions()`
`void`	`readExternal(ObjectInput in)`
`void`	`realMax(double[] max)`
`double`	`realMax(int d)`
`void`	`realMax(RealPositionable max)`
`void`	`realMin(double[] min)`
`double`	`realMin(int d)`
`void`	`realMin(RealPositionable min)`
`void`	`rebuild()` Informs interested parties that the data object has undergone a major change, such as the dimensional extents changing.
`protected void`	`register()` Informs interested parties that the data object has become relevant and should be registered.
`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 lineStyle)` 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.
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class net.imagej.AbstractData
compareTo, context, decrementReferences, getContext, getName, incrementReferences, publish, setContext, setName, toString

Methods inherited from class net.imagej.interval.AbstractCalibratedRealInterval
averageScale

Methods inherited from class net.imagej.space.AbstractAnnotatedSpace
axes, axis, setAxis

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.imagej.overlay.Overlay
move

Methods inherited from interface net.imagej.Data
decrementReferences, incrementReferences

Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint

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 org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Named
getName, setName

- Constructor Detail
  - AbstractOverlay
```
public AbstractOverlay(RealInterval interval)
```
  - AbstractOverlay
```
public AbstractOverlay(Context context,
                       RealInterval interval)
```
- Method Detail
  - register
```
protected void register()
```
    Description copied from class: AbstractData
    
    Informs interested parties that the data object has become relevant and should be registered. Called the first time the reference count is incremented. Classes that extend this class may choose to override this method to publish more specific events.
    
    Overrides:
    
    register in class AbstractData
  - delete
```
public void delete()
```
    Description copied from class: AbstractData
    
    Informs interested parties that the data object is no longer relevant and should be deleted. Called when the reference count is decremented to zero. Classes that extend this class may choose to override this method to publish more specific events.
    
    Overrides:
    
    delete in class AbstractData
  - getRegionOfInterest
```
public RegionOfInterest getRegionOfInterest()
```
    Description copied from interface: Overlay
    
    Retrieves the ImgLib region of interest, if any, that knows how to determine whether a pixel is included in the overlay.
    
    Specified by:
    
    getRegionOfInterest in interface Overlay
    
    Returns:
    
    the region of interest or null if none supported.
  - getAlpha
```
public int getAlpha()
```
    Specified by:
    
    getAlpha in interface Overlay
    
    Returns:
    
    the opacity of the interior of the overlay, from 0-255
  - setAlpha
```
public void setAlpha(int alpha)
```
    Specified by:
    
    setAlpha in interface Overlay
    
    Parameters:
    
    alpha - the opacity of the interior of the overlay, from 0-255
  - getFillColor
```
public ColorRGB getFillColor()
```
    Specified by:
    
    getFillColor in interface Overlay
    
    Returns:
    
    the fill color for overlays that have an interior
  - setFillColor
```
public void setFillColor(ColorRGB fillColor)
```
    Specified by:
    
    setFillColor in interface Overlay
    
    Parameters:
    
    fillColor - the fill color for overlays that have an interior
  - getLineColor
```
public ColorRGB getLineColor()
```
    Specified by:
    
    getLineColor in interface Overlay
    
    Returns:
    
    the color of the outline line of the overlay
  - setLineColor
```
public void setLineColor(ColorRGB lineColor)
```
    Description copied from interface: Overlay
    
    Set the color of the outline line of the overlay, if appropriate
    
    Specified by:
    
    setLineColor in interface Overlay
  - getLineWidth
```
public double getLineWidth()
```
    Specified by:
    
    getLineWidth in interface Overlay
    
    Returns:
    
    the width of the outline line in pixels
  - setLineWidth
```
public void setLineWidth(double lineWidth)
```
    Description copied from interface: Overlay
    
    Set the width of the outline line of the overlay, if appropriate
    
    Specified by:
    
    setLineWidth in interface Overlay
    
    Parameters:
    
    lineWidth - the width to be used when painting lines and shape borders, in pixels.
  - getLineStyle
```
public Overlay.LineStyle getLineStyle()
```
    Description copied from interface: Overlay
    
    Get the style of the outline line
    
    Specified by:
    
    getLineStyle in interface Overlay
    
    Returns:
    
    the outline line style.
  - setLineStyle
```
public void setLineStyle(Overlay.LineStyle lineStyle)
```
    Description copied from interface: Overlay
    
    Set the style of the outline line of the overlay, if appropriate
    
    Specified by:
    
    setLineStyle in interface Overlay
    
    Parameters:
    
    lineStyle - - style of line
  - getLineStartArrowStyle
```
public Overlay.ArrowStyle getLineStartArrowStyle()
```
    Specified by:
    
    getLineStartArrowStyle in interface Overlay
    
    Returns:
    
    the arrow style at the start of a line or path (if appropriate)
  - setLineStartArrowStyle
```
public void setLineStartArrowStyle(Overlay.ArrowStyle style)
```
    Specified by:
    
    setLineStartArrowStyle in interface Overlay
    
    Parameters:
    
    style - the arrow style to be shown at the start of a line or path
  - getLineEndArrowStyle
```
public Overlay.ArrowStyle getLineEndArrowStyle()
```
    Specified by:
    
    getLineEndArrowStyle in interface Overlay
    
    Returns:
    
    the arrow style at the end of a line or path (if appropriate)
  - setLineEndArrowStyle
```
public void setLineEndArrowStyle(Overlay.ArrowStyle style)
```
    Specified by:
    
    setLineEndArrowStyle in interface Overlay
    
    Parameters:
    
    style - the arrow style to be shown at the end of a line or path
  - duplicate
```
public Overlay duplicate()
```
    Specified by:
    
    duplicate in interface Overlay
  - update
```
public void update()
```
    Description copied from interface: Overlay
    
    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
    
    Specified by:
    
    update in interface Overlay
    
    See Also:
    
    OverlayUpdatedEvent
  - rebuild
```
public void rebuild()
```
    Description copied from interface: Overlay
    
    Informs interested parties that the data object has undergone a major change, such as the dimensional extents changing.
    
    Specified by:
    
    rebuild in interface Data
    
    Specified by:
    
    rebuild in interface Overlay
    
    See Also:
    
    OverlayRestructuredEvent
  - numDimensions
```
public int numDimensions()
```
    Specified by:
    
    numDimensions in interface EuclideanSpace
    
    Overrides:
    
    numDimensions in class AbstractAnnotatedSpace<CalibratedAxis>
  - realMin
```
public double realMin(int d)
```
    Specified by:
    
    realMin in interface RealInterval
    
    Overrides:
    
    realMin in class AbstractCalibratedRealInterval<CalibratedAxis>
  - realMin
```
public void realMin(double[] min)
```
    Specified by:
    
    realMin in interface RealInterval
    
    Overrides:
    
    realMin in class AbstractCalibratedRealInterval<CalibratedAxis>
  - realMin
```
public void realMin(RealPositionable min)
```
    Specified by:
    
    realMin in interface RealInterval
    
    Overrides:
    
    realMin in class AbstractCalibratedRealInterval<CalibratedAxis>
  - realMax
```
public double realMax(int d)
```
    Specified by:
    
    realMax in interface RealInterval
    
    Overrides:
    
    realMax in class AbstractCalibratedRealInterval<CalibratedAxis>
  - realMax
```
public void realMax(double[] max)
```
    Specified by:
    
    realMax in interface RealInterval
    
    Overrides:
    
    realMax in class AbstractCalibratedRealInterval<CalibratedAxis>
  - realMax
```
public void realMax(RealPositionable max)
```
    Specified by:
    
    realMax in interface RealInterval
    
    Overrides:
    
    realMax in class AbstractCalibratedRealInterval<CalibratedAxis>
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Overrides:
    
    writeExternal in class AbstractData
    
    Throws:
    
    IOException
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Overrides:
    
    readExternal in class AbstractData
    
    Throws:
    
    IOException
    
    ClassNotFoundException

Class AbstractOverlay

Nested Class Summary

Nested classes/interfaces inherited from interface net.imagej.overlay.Overlay

Constructor Summary

Method Summary

Methods inherited from class net.imagej.AbstractData

Methods inherited from class net.imagej.interval.AbstractCalibratedRealInterval

Methods inherited from class net.imagej.space.AbstractAnnotatedSpace

Methods inherited from class java.lang.Object

Methods inherited from interface net.imagej.overlay.Overlay

Methods inherited from interface net.imagej.Data

Methods inherited from interface net.imglib2.RealInterval

Methods inherited from interface net.imagej.space.CalibratedSpace

Methods inherited from interface net.imagej.space.TypedSpace

Methods inherited from interface net.imagej.space.AnnotatedSpace

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Named

Constructor Detail

AbstractOverlay

AbstractOverlay

Method Detail

register

delete

getRegionOfInterest

getAlpha

setAlpha

getFillColor

setFillColor

getLineColor

setLineColor

getLineWidth

setLineWidth

getLineStyle

setLineStyle

getLineStartArrowStyle

setLineStartArrowStyle

getLineEndArrowStyle

setLineEndArrowStyle

duplicate

update

rebuild

numDimensions

realMin

realMin

realMin

realMax

realMax

realMax

writeExternal

readExternal