javax.media.jai
Class ImageStack

java.lang.Object
  |
  +--javax.media.jai.CollectionImage
        |
        +--javax.media.jai.ImageStack

public abstract class ImageStack

extends CollectionImage

A class representing a stack of images, each associated with a spatial orientation defined in a common coordinate system. The images are of the type javax.media.jai.PlanarImage; the coordinates are of the type java.lang.Object. The tuple (image, coordinate) is represented by class javax.media.jai.CoordinateImage.

This class can be used to represent medical or geophysical images.

See Also:

PlanarImage

Fields inherited from class javax.media.jai.CollectionImage

imageCollection

Constructor Summary

protected	ImageStack() The default constructor.
	ImageStack(java.util.Collection images) Constructor.

Method Summary

boolean	add(java.lang.Object o) Adds a CoordinateImage to this collection.
java.lang.Object	getCoordinate(PlanarImage pi) Returns the coordinate associated with the specified image, or null if pi is null or if no match is found.
PlanarImage	getImage(java.lang.Object c) Returns the image associated with the specified coordinate, or null if c is null or if no match is found.
boolean	remove(java.lang.Object c) Removes the CoordinateImage that contains the specified coordinate from this collection.
boolean	remove(PlanarImage pi) Removes the CoordinateImage that contains the specified image from this collection.

Methods inherited from class javax.media.jai.CollectionImage

addAll, clear, contains, containsAll, getProperty, getProperty, getPropertyNames, getPropertyNames, isEmpty, iterator, removeAll, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageStack

protected ImageStack()

The default constructor.

ImageStack

public ImageStack(java.util.Collection images)

Constructor.

Parameters:

images - A collection of CoordinateImage.

Throws:

NullPointerException - if images is null.

Method Detail

getImage

public PlanarImage getImage(java.lang.Object c)

Returns the image associated with the specified coordinate, or null if c is null or if no match is found.

getCoordinate

public java.lang.Object getCoordinate(PlanarImage pi)

Returns the coordinate associated with the specified image, or null if pi is null or if no match is found.

add

public boolean add(java.lang.Object o)

Adds a CoordinateImage to this collection. If the specified image is null, it is not added to the collection.

Returns:

true if and only if the CoordinateImage is added to the collection.

Overrides:

add in class CollectionImage

remove

public boolean remove(PlanarImage pi)

Removes the CoordinateImage that contains the specified image from this collection.

Returns:

true if and only if a CoordinateImage containing the specified image is removed from the collection.

remove

public boolean remove(java.lang.Object c)

Removes the CoordinateImage that contains the specified coordinate from this collection.

Returns:

true if and only if a CoordinateImage containing the specified coordinate is removed from the collection.

Overrides:

remove in class CollectionImage