org.jaitools.imageutils.iterator

Class SimpleIterator

java.lang.Object

org.jaitools.imageutils.iterator.AbstractSimpleIterator

org.jaitools.imageutils.iterator.SimpleIterator

public class SimpleIterator
extends AbstractSimpleIterator

A read-only image iterator which moves by column then row (pixel then line).

Author:

michael

Nested Class Summary

Nested classes/interfaces inherited from class org.jaitools.imageutils.iterator.AbstractSimpleIterator

AbstractSimpleIterator.DelegateHelper, AbstractSimpleIterator.Order

Field Summary

Fields inherited from class org.jaitools.imageutils.iterator.AbstractSimpleIterator

delegateIter, imageDataType, imageRef, iterBounds

Constructor Summary

Constructors

Constructor and Description
SimpleIterator(RenderedImage image, Rectangle bounds, Number outsideValue) Creates a new iterator.
SimpleIterator(RenderedImage image, Rectangle bounds, Number outsideValue, AbstractSimpleIterator.Order order) Creates a new iterator.

Method Summary

Methods inherited from class org.jaitools.imageutils.iterator.AbstractSimpleIterator

checkBandArg, done, getBounds, getEndPos, getImage, getPos, getPos, getSample, getSample, getSample, getSample, getSample, getSample, getStartPos, getSubBounds, hasNext, isInsideDelegateBounds, isWithinImage, next, reset, setDelegatePosition, setPos, setPos

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleIterator

public SimpleIterator(RenderedImage image,
                      Rectangle bounds,
                      Number outsideValue)

Creates a new iterator. The bounds are allowed to extend beyond the bounds of the target image. When the iterator is positioned outside the image the specified outside value will be returned.

Parameters:

image - the target image

bounds - bounds for the iterator; if null the bounds of the target image will be used

outsideValue - value to return when the iterator is positioned beyond the bounds of the target image; may be null

SimpleIterator

public SimpleIterator(RenderedImage image,
                      Rectangle bounds,
                      Number outsideValue,
                      AbstractSimpleIterator.Order order)

Creates a new iterator. The bounds are allowed to extend beyond the bounds of the target image. When the iterator is positioned outside the image the specified outside value will be returned.

Parameters:

image - the target image

bounds - bounds for the iterator; if null the bounds of the target image will be used

outsideValue - value to return when the iterator is positioned beyond the bounds of the target image; may be null

order - processing order for this iterator when using the AbstractSimpleIterator.next() method