DefaultImageDisplay (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.plugin.AbstractRichPlugin
  - - org.scijava.display.AbstractDisplay<DataView>
    - - net.imagej.display.DefaultImageDisplay

All Implemented Interfaces:

Comparable<Prioritized>, Iterable<DataView>, Collection<DataView>, List<DataView>, ImageDisplay, CalibratedRealInterval<CalibratedAxis>, TypedRealInterval<CalibratedAxis>, PositionableByAxis, AnnotatedSpace<CalibratedAxis>, CalibratedSpace<CalibratedAxis>, TypedSpace<CalibratedAxis>, Dimensions, EuclideanSpace, Interval, Localizable, Positionable, RealInterval, RealLocalizable, Contextual, Display<DataView>, Identifiable, Locatable, Logged, Named, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, Versioned
```
public class DefaultImageDisplay
extends AbstractDisplay<DataView>
implements ImageDisplay
```
Default implementation of ImageDisplay.

Author:

Lee Kamentsky, Curtis Rueden

Field Summary
- Fields inherited from class org.scijava.display.AbstractDisplay
  isClosed
- Fields inherited from interface net.imagej.display.ImageDisplay
  CONTEXT_MENU_ROOT

Constructor Summary

Constructors
Constructor and Description

DefaultImageDisplay()

Constructors
Constructor and Description
`DefaultImageDisplay()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`averageScale(int d)` Returns the average scale along the given axis, for some reasonable interval.
`void`	`axes(CalibratedAxis[] axes)` Copies the space's axes into the given array.
`CalibratedAxis`	`axis(int d)` Gets the axis associated with the given dimension of the space.
`void`	`bck(int d)`
`boolean`	`canDisplay(Class<?> c)`
`long`	`dimension(int d)`
`int`	`dimensionIndex(AxisType axis)` Gets the dimensional index of the axis with the given type.
`void`	`dimensions(long[] dimensions)`
`void`	`display(Object o)`
`void`	`fwd(int d)`
`AxisType`	`getActiveAxis()` Gets the axis currently designated as active.
`DataView`	`getActiveView()` Gets the view currently designated as active.
`ImageCanvas`	`getCanvas()`
`double`	`getDoublePosition(int d)`
`float`	`getFloatPosition(int d)`
`int`	`getIntPosition(AxisType axis)` Returns the current position in a given dimension.
`int`	`getIntPosition(int d)`
`long`	`getLongPosition(AxisType axis)` Returns the current position in a given dimension.
`long`	`getLongPosition(int d)`
`RealRect`	`getPlaneExtents()` Gets a rectangle defining the extents of the image in the current X/Y plane.
`boolean`	`isDisplaying(Object o)`
`boolean`	`isVisible(DataView view)` Tests whether the given view should currently be visible in this display.
`void`	`localize(double[] position)`
`void`	`localize(float[] position)`
`void`	`localize(int[] position)`
`void`	`localize(long[] position)`
`long`	`max(int d)`
`void`	`max(long[] max)`
`void`	`max(Positionable max)`
`long`	`min(int d)`
`void`	`min(long[] min)`
`void`	`min(Positionable min)`
`void`	`move(int[] distance)`
`void`	`move(int distance, int d)`
`void`	`move(Localizable localizable)`
`void`	`move(long[] distance)`
`void`	`move(long distance, int d)`
`int`	`numDimensions()`
`protected void`	`onEvent(DataRestructuredEvent event)`
`protected void`	`onEvent(DataUpdatedEvent event)`
`protected void`	`onEvent(DisplayDeletedEvent event)`
`void`	`realMax(double[] max)`
`double`	`realMax(int d)`
`void`	`realMax(RealPositionable max)`
`void`	`realMin(double[] min)`
`double`	`realMin(int d)`
`void`	`realMin(RealPositionable min)`
`protected void`	`rebuild()`
`void`	`setActiveAxis(AxisType axis)` Sets the axis currently designated as active.
`void`	`setAxis(CalibratedAxis axis, int d)` Sets the dimensional axis associated with the given dimension.
`void`	`setPosition(int[] position)`
`void`	`setPosition(int position, int d)`
`void`	`setPosition(Localizable localizable)`
`void`	`setPosition(long[] position)`
`void`	`setPosition(long position, AxisType axis)` Sets the position of the element for one dimension.
`void`	`setPosition(long position, int d)`
`String`	`toString()`
`void`	`update()`

Methods inherited from class org.scijava.display.AbstractDisplay
add, add, addAll, addAll, checkObject, clear, close, contains, containsAll, get, getName, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, noteStructureChange, remove, remove, removeAll, retainAll, set, setName, size, subList, toArray, toArray

Methods inherited from class org.scijava.plugin.AbstractRichPlugin
getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual
context, getContext

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

Methods inherited from interface org.scijava.display.Display
canDisplay, close

Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface org.scijava.plugin.RichPlugin
getIdentifier, log

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized
compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo

Methods inherited from interface org.scijava.Locatable
getLocation

Methods inherited from interface org.scijava.Versioned
getVersion

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

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

Methods inherited from interface net.imglib2.Localizable
localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealLocalizable
localize, positionAsDoubleArray, positionAsRealPoint

Methods inherited from interface net.imglib2.Interval
maxAsLongArray, maxAsPoint, minAsLongArray, minAsPoint

Methods inherited from interface net.imglib2.Dimensions
allPositive, allPositive, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositive

- Constructor Detail
  - DefaultImageDisplay
```
public DefaultImageDisplay()
```
- Method Detail
  - rebuild
```
protected void rebuild()
```
    Overrides:
    
    rebuild in class AbstractDisplay<DataView>
  - getActiveView
```
public DataView getActiveView()
```
    Description copied from interface: ImageDisplay
    
    Gets the view currently designated as active.
    
    Specified by:
    
    getActiveView in interface ImageDisplay
  - getActiveAxis
```
public AxisType getActiveAxis()
```
    Description copied from interface: ImageDisplay
    
    Gets the axis currently designated as active.
    
    Specified by:
    
    getActiveAxis in interface ImageDisplay
  - setActiveAxis
```
public void setActiveAxis(AxisType axis)
```
    Description copied from interface: ImageDisplay
    
    Sets the axis currently designated as active.
    
    Specified by:
    
    setActiveAxis in interface ImageDisplay
  - isVisible
```
public boolean isVisible(DataView view)
```
    Description copied from interface: ImageDisplay
    
    Tests whether the given view should currently be visible in this display. A view is visible when the current position falls within the bounds of the view's space, including constant-value dimensions beyond the view's linked data's space.
    
    Specified by:
    
    isVisible in interface ImageDisplay
  - getCanvas
```
public ImageCanvas getCanvas()
```
    Specified by:
    
    getCanvas in interface ImageDisplay
  - getPlaneExtents
```
public RealRect getPlaneExtents()
```
    Description copied from interface: ImageDisplay
    
    Gets a rectangle defining the extents of the image in the current X/Y plane.
    
    Specified by:
    
    getPlaneExtents in interface ImageDisplay
  - canDisplay
```
public boolean canDisplay(Class<?> c)
```
    Specified by:
    
    canDisplay in interface Display<DataView>
    
    Overrides:
    
    canDisplay in class AbstractDisplay<DataView>
  - display
```
public void display(Object o)
```
    Specified by:
    
    display in interface Display<DataView>
    
    Overrides:
    
    display in class AbstractDisplay<DataView>
  - isDisplaying
```
public boolean isDisplaying(Object o)
```
    Specified by:
    
    isDisplaying in interface Display<DataView>
  - update
```
public void update()
```
    Specified by:
    
    update in interface Display<DataView>
    
    Overrides:
    
    update in class AbstractDisplay<DataView>
  - min
```
public long min(int d)
```
    Specified by:
    
    min in interface Interval
  - min
```
public void min(long[] min)
```
    Specified by:
    
    min in interface Interval
  - min
```
public void min(Positionable min)
```
    Specified by:
    
    min in interface Interval
  - max
```
public long max(int d)
```
    Specified by:
    
    max in interface Interval
  - max
```
public void max(long[] max)
```
    Specified by:
    
    max in interface Interval
  - max
```
public void max(Positionable max)
```
    Specified by:
    
    max in interface Interval
  - dimensions
```
public void dimensions(long[] dimensions)
```
    Specified by:
    
    dimensions in interface Dimensions
  - dimension
```
public long dimension(int d)
```
    Specified by:
    
    dimension in interface Dimensions
    
    Specified by:
    
    dimension in interface Interval
  - realMin
```
public double realMin(int d)
```
    Specified by:
    
    realMin in interface Interval
    
    Specified by:
    
    realMin in interface RealInterval
  - realMin
```
public void realMin(double[] min)
```
    Specified by:
    
    realMin in interface RealInterval
  - realMin
```
public void realMin(RealPositionable min)
```
    Specified by:
    
    realMin in interface RealInterval
  - realMax
```
public double realMax(int d)
```
    Specified by:
    
    realMax in interface Interval
    
    Specified by:
    
    realMax in interface RealInterval
  - realMax
```
public void realMax(double[] max)
```
    Specified by:
    
    realMax in interface RealInterval
  - realMax
```
public void realMax(RealPositionable max)
```
    Specified by:
    
    realMax in interface RealInterval
  - numDimensions
```
public int numDimensions()
```
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - averageScale
```
public double averageScale(int d)
```
    Description copied from interface: CalibratedSpace
    
    Returns the average scale along the given axis, for some reasonable interval.
    The exact interval used is implementation dependent, but reasonable effort will be made to use the largest in-bounds range for the space; e.g., for RealIntervals, the range used is RealInterval.realMin(int) to RealInterval.realMax(int). For spaces in general, the default range is [0, 1].
    
    Specified by:
    
    averageScale in interface CalibratedSpace<CalibratedAxis>
  - dimensionIndex
```
public int dimensionIndex(AxisType axis)
```
    Description copied from interface: TypedSpace
    
    Gets the dimensional index of the axis with the given type.
    Note that by convention, each AxisType may only be used in a single dimension of the space.
    
    Specified by:
    
    dimensionIndex in interface TypedSpace<CalibratedAxis>
    
    Returns:
    
    the dimensional index of the specified axis type. Return -1 if the specified axis type is not found.
  - axis
```
public CalibratedAxis axis(int d)
```
    Description copied from interface: AnnotatedSpace
    
    Gets the axis associated with the given dimension of the space.
    
    Specified by:
    
    axis in interface AnnotatedSpace<CalibratedAxis>
  - axes
```
public void axes(CalibratedAxis[] axes)
```
    Description copied from interface: AnnotatedSpace
    
    Copies the space's axes into the given array.
    
    Specified by:
    
    axes in interface AnnotatedSpace<CalibratedAxis>
  - setAxis
```
public void setAxis(CalibratedAxis axis,
                    int d)
```
    Description copied from interface: AnnotatedSpace
    
    Sets the dimensional axis associated with the given dimension.
    
    Specified by:
    
    setAxis in interface AnnotatedSpace<CalibratedAxis>
  - getIntPosition
```
public int getIntPosition(AxisType axis)
```
    Description copied from interface: PositionableByAxis
    
    Returns the current position in a given dimension.
    
    Specified by:
    
    getIntPosition in interface PositionableByAxis
  - getLongPosition
```
public long getLongPosition(AxisType axis)
```
    Description copied from interface: PositionableByAxis
    
    Returns the current position in a given dimension.
    
    Specified by:
    
    getLongPosition in interface PositionableByAxis
  - setPosition
```
public void setPosition(long position,
                        AxisType axis)
```
    Description copied from interface: PositionableByAxis
    
    Sets the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface PositionableByAxis
  - localize
```
public void localize(int[] position)
```
    Specified by:
    
    localize in interface Localizable
  - localize
```
public void localize(long[] position)
```
    Specified by:
    
    localize in interface Localizable
  - getIntPosition
```
public int getIntPosition(int d)
```
    Specified by:
    
    getIntPosition in interface Localizable
  - getLongPosition
```
public long getLongPosition(int d)
```
    Specified by:
    
    getLongPosition in interface Localizable
  - localize
```
public void localize(float[] position)
```
    Specified by:
    
    localize in interface RealLocalizable
  - localize
```
public void localize(double[] position)
```
    Specified by:
    
    localize in interface RealLocalizable
  - getFloatPosition
```
public float getFloatPosition(int d)
```
    Specified by:
    
    getFloatPosition in interface Localizable
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
  - getDoublePosition
```
public double getDoublePosition(int d)
```
    Specified by:
    
    getDoublePosition in interface Localizable
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
  - fwd
```
public void fwd(int d)
```
    Specified by:
    
    fwd in interface Positionable
  - bck
```
public void bck(int d)
```
    Specified by:
    
    bck in interface Positionable
  - move
```
public void move(int distance,
                 int d)
```
    Specified by:
    
    move in interface Positionable
  - move
```
public void move(long distance,
                 int d)
```
    Specified by:
    
    move in interface Positionable
  - move
```
public void move(Localizable localizable)
```
    Specified by:
    
    move in interface Positionable
  - move
```
public void move(int[] distance)
```
    Specified by:
    
    move in interface Positionable
  - move
```
public void move(long[] distance)
```
    Specified by:
    
    move in interface Positionable
  - setPosition
```
public void setPosition(Localizable localizable)
```
    Specified by:
    
    setPosition in interface Positionable
  - setPosition
```
public void setPosition(int[] position)
```
    Specified by:
    
    setPosition in interface Positionable
  - setPosition
```
public void setPosition(long[] position)
```
    Specified by:
    
    setPosition in interface Positionable
  - setPosition
```
public void setPosition(int position,
                        int d)
```
    Specified by:
    
    setPosition in interface Positionable
  - setPosition
```
public void setPosition(long position,
                        int d)
```
    Specified by:
    
    setPosition in interface Positionable
  - onEvent
```
protected void onEvent(DataRestructuredEvent event)
```
  - onEvent
```
protected void onEvent(DataUpdatedEvent event)
```
  - onEvent
```
protected void onEvent(DisplayDeletedEvent event)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractDisplay<DataView>

Class DefaultImageDisplay

Field Summary

Fields inherited from class org.scijava.display.AbstractDisplay

Fields inherited from interface net.imagej.display.ImageDisplay

Constructor Summary

Method Summary

Methods inherited from class org.scijava.display.AbstractDisplay

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.display.Display

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Methods inherited from interface org.scijava.Named

Methods inherited from interface net.imglib2.RealInterval

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Methods inherited from interface net.imglib2.Interval

Methods inherited from interface net.imglib2.Dimensions

Constructor Detail

DefaultImageDisplay

Method Detail

rebuild

getActiveView

getActiveAxis

setActiveAxis

isVisible

getCanvas

getPlaneExtents

canDisplay

display

isDisplaying

update

min

min

min

max

max

max

dimensions

dimension

realMin

realMin

realMin

realMax

realMax

realMax

numDimensions

averageScale

dimensionIndex

axis

axes

setAxis

getIntPosition

getLongPosition

setPosition

localize

localize

getIntPosition

getLongPosition

localize

localize

getFloatPosition

getDoublePosition

fwd

bck

move

move

move

move

move

setPosition

setPosition