io.scif

Interface Plane

All Known Subinterfaces:

DataPlane<T>

All Known Implementing Classes:

AbstractPlane, BufferedImagePlane, ByteArrayPlane

public interface Plane

Top-level interface for all Plane representations in SCIFIO.

Planes are X,Y slices of pixel data from a parent image, and potentially include a ColorTable if that parent uses indexed color.

This interface guarantees that a Plane will have a ColorTable, and the pixel data of a Plane can ultimately be converted to a byte[].

Author:

Mark Hiner

See Also:

ColorTable

Method Summary

Modifier and Type	Method and Description
net.imglib2.Interval	getBounds()
byte[]	getBytes() Gets this plane's standardized pixel data.
net.imglib2.display.ColorTable	getColorTable() Gets this plane's ColorTable.
ImageMetadata	getImageMetadata() Gets the ImageMetadata associated with this plane.
default long[]	getLengths()
default long[]	getMax()
default long[]	getMin()
Plane	populate(ImageMetadata meta, net.imglib2.Interval bounds) Populates this planes offsets, dimensions and Metadata.
Plane	populate(Plane p) Populates this plane by copying the fields of the provided plane
void	setBounds(net.imglib2.Interval bounds) Sets this plane's bounds relative to the underlying image.
void	setColorTable(net.imglib2.display.ColorTable lut) Sets the ColorTable for this plane.
void	setImageMetadata(ImageMetadata meta) Sets the ImageMetadata representation of the underlying image.

Method Detail

setColorTable

void setColorTable(net.imglib2.display.ColorTable lut)

Sets the ColorTable for this plane. ColorTables are used for indexed color planes, where the underlying pixel data is an index into the associated color (lookup) table.

Parameters:

lut - - a ColorTable implementation.

getColorTable

net.imglib2.display.ColorTable getColorTable()

Gets this plane's ColorTable.

Returns:

A reference to the ColorTable instance associated with this plane.

getBytes

byte[] getBytes()

Gets this plane's standardized pixel data. This byte[] is guaranteed to be consistent across multiple calls to this method, for a given native data object.

Returns:

The standardized representation of this plane's data.

getImageMetadata

ImageMetadata getImageMetadata()

Gets the ImageMetadata associated with this plane. The ImageMetadata returned by this method can then be used to answer questions about this plane.

Returns:

An ImageMetadata instance describing the image associated with this plane.

getMin

default long[] getMin()

Returns:

The minimums of this plane relative to the origin image

getMax

default long[] getMax()

Returns:

The maximums of this plane relative to the origin image

getLengths

default long[] getLengths()

Returns:

The lengths of each axis of this plane

getBounds

net.imglib2.Interval getBounds()

Returns:

The bounds of this plane relative to the origin image

populate

Plane populate(ImageMetadata meta,
               net.imglib2.Interval bounds)

Populates this planes offsets, dimensions and Metadata.

Parameters:

meta - - ImageMetadata to associate with this Plane

bounds - bounds of the planar axes.

Returns:

A reference to this Plane

populate

Plane populate(Plane p)

Populates this plane by copying the fields of the provided plane

Parameters:

p - - A Plane to copy

Returns:

A reference to this Plane

setImageMetadata

void setImageMetadata(ImageMetadata meta)

Sets the ImageMetadata representation of the underlying image.

Parameters:

meta - - an initialized ImageMetadata instance.

setBounds

void setBounds(net.imglib2.Interval bounds)

Sets this plane's bounds relative to the underlying image.