org.jaitools.imageutils

Class ImageSet.Iterator<K>

java.lang.Object

org.jaitools.imageutils.ImageSet.Iterator<K>

Enclosing class:

ImageSet<K>

public static class ImageSet.Iterator<K>
extends Object

Method Summary

Modifier and Type	Method and Description
Map<K,Number>	getSample() Gets a value from the first band of each image in this set and returns them as a Map of key : value pairs.
Map<K,Number>	getSample(int band) Gets a value from the specified band of each image in this set and returns them as a Map of key : value pairs.
boolean	hasNext() Tests if the iterator has any more positions to sample.
boolean	next() Advances the iterator to the next position if possible.

Methods inherited from class java.lang.Object

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

Method Detail

getSample

public Map<K,Number> getSample()

Gets a value from the first band of each image in this set and returns them as a Map of key : value pairs.

Returns:

image (or outside) values

getSample

public Map<K,Number> getSample(int band)

Gets a value from the specified band of each image in this set and returns them as a Map of key : value pairs.

Parameters:

band - the image band to sample

Returns:

image (or outside) values

hasNext

public boolean hasNext()

Tests if the iterator has any more positions to sample.

Returns:

true if more samples are available; false otherwise

next

public boolean next()

Advances the iterator to the next position if possible.

Returns:

true if the iterator was moved; false if it is at the end of its bounds