|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An iterator for traversing a read-only image using arbitrary up-down and left-right moves. This will generally be somewhat slower than a corresponding instance of RectIter, since it must perform bounds checks against the top and left edges of tiles in addition to their bottom and right edges.
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. As with RectIter, its position may be advanced using the nextLine(), jumpLines(), nextPixel(), jumpPixels(), and nextBand() methods.
In addition, prevLine(), prevPixel(), and prevBand() methods exist to move in the upwards and leftwards directions and to access smaller band indices. The iterator may be set to the far edges of the bounding rectangle by means of the endLines(), endPixels(), and endBands() 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(), prevLineDone(), nextPixelDone(), prevPixelDone(), nextBandDone(), and prevBandDone().
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.
An instance of RookIter may be obtained by means of the RookIterFactory.create() method, which returns an opaque object implementing this interface.
RectIter
,
RookIterFactory
Method Summary | |
void |
endBands()
Sets the iterator to the last band of the image. |
void |
endLines()
Sets the iterator to the last line of its bounding rectangle. |
void |
endPixels()
Sets the iterator to the rightmost pixel of its bounding rectangle. |
void |
prevBand()
Sets the iterator to the previous band in the image. |
boolean |
prevBandDone()
Sets the iterator to the previous band in the image, and returns true if the min band has been exceeded. |
void |
prevLine()
Sets the iterator to the previous line of the image. |
boolean |
prevLineDone()
Sets the iterator to the previous line in the image, and returns true if the top row of the bounding rectangle has been passed. |
void |
prevPixel()
Sets the iterator to the previous pixel in the image (that is, move leftward). |
boolean |
prevPixelDone()
Sets the iterator to the previous pixel in the image (that is, move leftward). |
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 |
public void prevLine()
public boolean prevLineDone()
public void endLines()
public void prevPixel()
public boolean prevPixelDone()
public void endPixels()
public void prevBand()
public boolean prevBandDone()
public void endBands()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |