io.scif

Interface DataPlane<T>

Type Parameters:

T - the native data type used to store this plane's pixel information.

All Superinterfaces:

Plane

All Known Implementing Classes:

AbstractPlane, BufferedImagePlane, ByteArrayPlane

public interface DataPlane<T>
extends Plane

Extension of the base Plane interface. Adds the concept of a native underlying data representation.

Author:

Mark Hiner

See Also:

Plane

Method Summary

Modifier and Type	Method and Description
T	getData() Gets this plane's type-specific pixel data.
DataPlane<T>	populate(DataPlane<T> plane) Populate this plane by copying the provided plane.
DataPlane<T>	populate(ImageMetadata meta, T data, net.imglib2.Interval bounds) As populate(Object, Interval), but also sets the ImageMetadata of the source from which this Plane was read.
DataPlane<T>	populate(T data, net.imglib2.Interval bounds) Populate this plane using the specified lengths and offsets, with the provided data representation of the pixels in that region.
void	setData(T data) Sets the native pixel data for this plane.

Methods inherited from interface io.scif.Plane

getBounds, getBytes, getColorTable, getImageMetadata, getLengths, getMax, getMin, populate, populate, setBounds, setColorTable, setImageMetadata

Method Detail

setData

void setData(T data)

Sets the native pixel data for this plane. If Plane.getColorTable() returns null, then this is the pixel data. Otherwise, this data should be used as an index into the associated ColorTable.

Parameters:

data - - an object matching the native data type of this plane.

getData

T getData()

Gets this plane's type-specific pixel data.

Returns:

The native representation for this plane's data.

populate

DataPlane<T> populate(DataPlane<T> plane)

Populate this plane by copying the provided plane.

Parameters:

plane - the plane to copy

Returns:

A reference to this plane

populate

DataPlane<T> populate(T data,
                      net.imglib2.Interval bounds)

Populate this plane using the specified lengths and offsets, with the provided data representation of the pixels in that region.

Parameters:

data - Pixel information for the region of this plane.

bounds - bounds of the planar axes.

Returns:

A reference to this plane

populate

DataPlane<T> populate(ImageMetadata meta,
                      T data,
                      net.imglib2.Interval bounds)

As populate(Object, Interval), but also sets the ImageMetadata of the source from which this Plane was read.

Parameters:

meta - ImageMetadata of the source associated with this Plane

data - Pixel information for the region of this plane.

bounds - bounds of the planar axes.

Returns:

A reference to this plane