javax.media.jai.iterator
Interface WritableRectIter

All Superinterfaces:

RectIter

All Known Subinterfaces:

WritableRookIter

public interface WritableRectIter

extends RectIter

An iterator for traversing a read/write image in top-to-bottom, left-to-right order. This will generally be the fastest style of iterator, since it does not need to perform bounds checks against the top or left edges of tiles.

The iterator is initialized with a particular rectangle as its bounds, which it is illegal to exceed. This initialization takes place in a factory method and is not a part of the iterator interface itself. Once initialized, the iterator may be reset to its initial state by means of the startLine(), startPixels(), and startBands() methods. Its position may be advanced using the nextLine(), jumpLines(), nextPixel(), jumpPixels(), and nextBand() methods.

The iterator's position may be tested against the bounding rectangle by means of the finishedLines(), finishedPixels(), and finishedBands() methods, as well as the hybrid methods nextLineDone(), nextPixelDone(), and nextBandDone().

The getSample(), getSampleFloat(), and getSampleDouble() methods are provided to allow read-only access to the source data. The various source bands may also be accessed in random fashion using the variants that accept a band index. The getPixel() methods allow retrieval of all bands simultaneously.

WritableRookIter adds the ability to alter the source pixel values using the various setSample() and setPixel() methods.

An instance of WritableRectIter may be obtained by means of the RectIterFactory.createWritable() method, which returns an opaque object implementing this interface.

See Also:

RectIter, RectIterFactory

Method Summary

void	setPixel(double[] dArray) Sets all samples of the current pixel to a set of double values.
void	setPixel(float[] fArray) Sets all samples of the current pixel to a set of float values.
void	setPixel(int[] iArray) Sets all samples of the current pixel to a set of int values.
void	setSample(double x) Sets the current sample to a double value.
void	setSample(float s) Sets the current sample to a float value.
void	setSample(int s) Sets the current sample to an integral value.
void	setSample(int b, double s) Sets the specified sample of the current pixel to a double value.
void	setSample(int b, float s) Sets the specified sample of the current pixel to a float value.
void	setSample(int b, int s) Sets the specified sample of the current pixel to an integral value.

Methods inherited from interface javax.media.jai.iterator.RectIter

finishedBands, finishedLines, finishedPixels, getPixel, getPixel, getPixel, getSample, getSample, getSampleDouble, getSampleDouble, getSampleFloat, getSampleFloat, jumpLines, jumpPixels, nextBand, nextBandDone, nextLine, nextLineDone, nextPixel, nextPixelDone, startBands, startLines, startPixels

Method Detail

setSample

public void setSample(int s)

Sets the current sample to an integral value.

setSample

public void setSample(int b,
                      int s)

Sets the specified sample of the current pixel to an integral value.

setSample

public void setSample(float s)

Sets the current sample to a float value.

setSample

public void setSample(int b,
                      float s)

Sets the specified sample of the current pixel to a float value.

setSample

public void setSample(double x)

Sets the current sample to a double value.

setSample

public void setSample(int b,
                      double s)

Sets the specified sample of the current pixel to a double value.

setPixel

public void setPixel(int[] iArray)

Sets all samples of the current pixel to a set of int values.

Parameters:

iArray - an int array containing a value for each band.

setPixel

public void setPixel(float[] fArray)

Sets all samples of the current pixel to a set of float values.

Parameters:

fArray - a float array containing a value for each band.

setPixel

public void setPixel(double[] dArray)

Sets all samples of the current pixel to a set of double values.

Parameters:

dArray - a double array containing a value for each band.