DefaultDatasetView (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - net.imagej.display.AbstractDataView
  - - net.imagej.display.DefaultDatasetView

All Implemented Interfaces:

DatasetView, DataView, ImageJPlugin, PositionableByAxis, EuclideanSpace, Localizable, Positionable, RealLocalizable, Contextual, SciJavaPlugin
```
public class DefaultDatasetView
extends AbstractDataView
implements DatasetView
```
A view into a Dataset, for use with a ImageDisplay.

Author:

Grant Harris, Curtis Rueden, Barry DeZonia

Constructor Summary

Constructors
Constructor and Description

DefaultDatasetView()

Constructors
Constructor and Description
`DefaultDatasetView()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`autoscale(int c)` Autoscales the display range to match the data range, for the given channel.
`int`	`getChannelCount()` Gets the number of channels in the displayed data.
`double`	`getChannelMax(int c)` Gets the maximum value in the display range, for the given channel.
`double`	`getChannelMin(int c)` Gets the minimum value in the display range, for the given channel.
`ColorRGB`	`getColor(ChannelCollection channels)` Reason from a channel collection and internal state what the closest color is.
`ColorMode`	`getColorMode()`
`List<ColorTable>`	`getColorTables()`
`int`	`getCompositeDimIndex()`
`Dataset`	`getData()` Gets the `Data` represented by this view.
`long`	`getLongPosition(AxisType axis)` Returns the current position in a given dimension.
`int`	`getPreferredHeight()` Gets the view's natural height in pixels.
`int`	`getPreferredWidth()` Gets the view's natural width in pixels.
`CompositeXYProjector<? extends RealType<?>>`	`getProjector()`
`ARGBScreenImage`	`getScreenImage()`
`boolean`	`isCompatible(Data data)` Gets whether this view is compatible with the given `Data`.
`protected void`	`onEvent(DatasetRGBChangedEvent event)`
`protected void`	`onEvent(DatasetTypeChangedEvent event)`
`protected void`	`onEvent(DatasetUpdatedEvent event)`
`void`	`rebuild()` Recreates the view.
`void`	`resetColorTables(boolean grayscale)`
`void`	`setChannelRange(int c, double min, double max)` Sets the minimum and maximum values of the display range, for the given channel.
`void`	`setChannelRanges(double min, double max)` Sets the minimum and maximum values of the display range, globally for all channels.
`void`	`setColorMode(ColorMode colorMode)`
`void`	`setColorTable(ColorTable colorTable, int channel)`
`void`	`setComposite(boolean composite)`
`void`	`setPosition(long position, AxisType axis)` Sets the position of the element for one dimension.
`void`	`update()` Updates and redraws the view onscreen.
`RandomAccessibleInterval<? extends RealType<?>>`	`xyPlane()`
`RandomAccessibleInterval<? extends RealType<?>>`	`xyPlane(RandomAccessibleInterval<? extends RealType<?>> inputInterval)`

Methods inherited from class net.imagej.display.AbstractDataView
bck, dispose, fwd, getDoublePosition, getFloatPosition, getIntPosition, getIntPosition, getLongPosition, getPlanePosition, initialize, isSelected, localize, localize, localize, localize, move, move, move, move, move, numDimensions, publish, setPosition, setPosition, setPosition, setPosition, setPosition, setSelected

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

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

Methods inherited from interface net.imagej.display.DataView
dispose, getPlanePosition, initialize, isSelected, setSelected

Methods inherited from interface net.imagej.PositionableByAxis
getIntPosition

Methods inherited from interface net.imglib2.Localizable
getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, positionAsLongArray, positionAsPoint

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

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

Methods inherited from interface net.imglib2.Positionable
bck, fwd, move, move, move, move, move, setPosition, setPosition, setPosition, setPosition, setPosition

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

- Constructor Detail
  - DefaultDatasetView
```
public DefaultDatasetView()
```
- Method Detail
  - getChannelCount
```
public int getChannelCount()
```
    Description copied from interface: DatasetView
    
    Gets the number of channels in the displayed data.
    
    Specified by:
    
    getChannelCount in interface DatasetView
  - getScreenImage
```
public ARGBScreenImage getScreenImage()
```
    Specified by:
    
    getScreenImage in interface DatasetView
  - getCompositeDimIndex
```
public int getCompositeDimIndex()
```
    Specified by:
    
    getCompositeDimIndex in interface DatasetView
  - getProjector
```
public CompositeXYProjector<? extends RealType<?>> getProjector()
```
    Specified by:
    
    getProjector in interface DatasetView
  - getChannelMin
```
public double getChannelMin(int c)
```
    Description copied from interface: DatasetView
    
    Gets the minimum value in the display range, for the given channel.
    NB: This is a different value than that given by ImageMetadata.getChannelMinimum(int); the latter is the minimum data value for that channel, independent of any visualization.
    
    Specified by:
    
    getChannelMin in interface DatasetView
  - getChannelMax
```
public double getChannelMax(int c)
```
    Description copied from interface: DatasetView
    
    Gets the maximum value in the display range, for the given channel.
    NB: This is a different value than that given by ImageMetadata.getChannelMaximum(int); the latter is the maximum data value for that channel, independent of any visualization.
    
    Specified by:
    
    getChannelMax in interface DatasetView
  - setChannelRange
```
public void setChannelRange(int c,
                            double min,
                            double max)
```
    Description copied from interface: DatasetView
    
    Sets the minimum and maximum values of the display range, for the given channel.
    NB: This is a different range than that set by ImageMetadata.setChannelMinimum(int, double) and ImageMetadata.setChannelMaximum(int, double); the latter methods set the minimum and maximum data values for that channel, independent of any visualization. They are typically kept synced with the actual data via code such as net.imglib2.algorithm.stats.ComputeMinMax.
    
    Specified by:
    
    setChannelRange in interface DatasetView
  - setChannelRanges
```
public void setChannelRanges(double min,
                             double max)
```
    Description copied from interface: DatasetView
    
    Sets the minimum and maximum values of the display range, globally for all channels.
    NB: This is a different range than that set by ImageMetadata.setChannelMinimum(int, double) and ImageMetadata.setChannelMaximum(int, double); the latter methods set the minimum and maximum data values for that channel, independent of any visualization. They are typically kept synced with the actual data via code such as net.imglib2.algorithm.stats.ComputeMinMax.
    
    Specified by:
    
    setChannelRanges in interface DatasetView
  - autoscale
```
public void autoscale(int c)
```
    Description copied from interface: DatasetView
    
    Autoscales the display range to match the data range, for the given channel.
    NB: The data range is obtained first from ImageMetadata.getChannelMinimum(int) and ImageMetadata.getChannelMaximum(int); if they are not set there, they are computed and cached for later use.
    
    Specified by:
    
    autoscale in interface DatasetView
  - setComposite
```
public void setComposite(boolean composite)
```
    Specified by:
    
    setComposite in interface DatasetView
  - getColorTables
```
public List<ColorTable> getColorTables()
```
    Specified by:
    
    getColorTables in interface DatasetView
  - setColorTable
```
public void setColorTable(ColorTable colorTable,
                          int channel)
```
    Specified by:
    
    setColorTable in interface DatasetView
  - resetColorTables
```
public void resetColorTables(boolean grayscale)
```
    Specified by:
    
    resetColorTables in interface DatasetView
  - getColorMode
```
public ColorMode getColorMode()
```
    Specified by:
    
    getColorMode in interface DatasetView
  - setColorMode
```
public void setColorMode(ColorMode colorMode)
```
    Specified by:
    
    setColorMode in interface DatasetView
  - getColor
```
public ColorRGB getColor(ChannelCollection channels)
```
    Reason from a channel collection and internal state what the closest color is. This is needed for color synchronization with the original ImageJ.
    
    Specified by:
    
    getColor in interface DatasetView
  - xyPlane
```
public RandomAccessibleInterval<? extends RealType<?>> xyPlane()
```
    Specified by:
    
    xyPlane in interface DatasetView
    
    Returns:
    
    The current XY slice of the underlying data.
  - xyPlane
```
public RandomAccessibleInterval<? extends RealType<?>> xyPlane(RandomAccessibleInterval<? extends RealType<?>> inputInterval)
```
    Specified by:
    
    xyPlane in interface DatasetView
    
    Parameters:
    
    inputInterval - - An interval to extract the current XY slice from.
    
    Returns:
    
    The provided interval as a fixed XY slice using the current view position.
  - isCompatible
```
public boolean isCompatible(Data data)
```
    Description copied from interface: DataView
    
    Gets whether this view is compatible with the given Data.
    
    Specified by:
    
    isCompatible in interface DataView
  - getData
```
public Dataset getData()
```
    Description copied from interface: DataView
    
    Gets the Data represented by this view.
    
    Specified by:
    
    getData in interface DatasetView
    
    Specified by:
    
    getData in interface DataView
    
    Overrides:
    
    getData in class AbstractDataView
  - getPreferredWidth
```
public int getPreferredWidth()
```
    Description copied from interface: DataView
    
    Gets the view's natural width in pixels.
    
    Specified by:
    
    getPreferredWidth in interface DataView
  - getPreferredHeight
```
public int getPreferredHeight()
```
    Description copied from interface: DataView
    
    Gets the view's natural height in pixels.
    
    Specified by:
    
    getPreferredHeight in interface DataView
  - update
```
public void update()
```
    Description copied from interface: DataView
    
    Updates and redraws the view onscreen.
    
    Specified by:
    
    update in interface DataView
  - rebuild
```
public void rebuild()
```
    Description copied from interface: DataView
    
    Recreates the view. This operation is useful in case the linked Data has changed structurally somehow.
    
    Specified by:
    
    rebuild in interface DataView
  - 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
    
    Overrides:
    
    getLongPosition in class AbstractDataView
  - 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
    
    Overrides:
    
    setPosition in class AbstractDataView
  - onEvent
```
protected void onEvent(DatasetTypeChangedEvent event)
```
  - onEvent
```
protected void onEvent(DatasetRGBChangedEvent event)
```
  - onEvent
```
protected void onEvent(DatasetUpdatedEvent event)
```

Class DefaultDatasetView

Constructor Summary

Method Summary

Methods inherited from class net.imagej.display.AbstractDataView

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface net.imagej.display.DataView

Methods inherited from interface net.imagej.PositionableByAxis

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Methods inherited from interface net.imglib2.EuclideanSpace

Methods inherited from interface net.imglib2.Positionable

Methods inherited from interface org.scijava.Contextual

Constructor Detail

DefaultDatasetView

Method Detail

getChannelCount

getScreenImage

getCompositeDimIndex

getProjector

getChannelMin

getChannelMax

setChannelRange

setChannelRanges

autoscale

setComposite

getColorTables

setColorTable

resetColorTables

getColorMode

setColorMode

getColor

xyPlane

xyPlane

isCompatible

getData

getPreferredWidth

getPreferredHeight

update

rebuild

getLongPosition

setPosition

onEvent

onEvent

onEvent