IterationCodeIterator (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.roi.util.iterationcode.IterationCodeIterator<P>

Type Parameters:

P - type of the position field.

All Implemented Interfaces:

EuclideanSpace, Iterator
```
public class IterationCodeIterator<P extends Positionable & Localizable>
extends AbstractEuclideanSpace
implements Iterator
```
Iterates all positions in the bitmask encoded by a given IterationCode. It is constructed with a Positionable Localizable, that represents the position and is moved around while iterating.

Author:

Tobias Pietzsch

Field Summary
- Fields inherited from class net.imglib2.AbstractEuclideanSpace
  n

Constructor Summary

Constructors
Constructor and Description
`IterationCodeIterator(IterationCodeIterator<?> copyFrom, P position)`
`IterationCodeIterator(IterationCode iterationCode, long[] offset, P position)`
`IterationCodeIterator(gnu.trove.list.array.TIntArrayList itcode, long[] offset, P position)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`fwd()` Move forward.
`boolean`	`hasNext()` Returns true if another step forward is possible.
`void`	`jumpFwd(long steps)` Move steps × forward.
`void`	`reset()` Reset the `Iterator`, that is put it to where it would be if newly created.

Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IterationCodeIterator
```
public IterationCodeIterator(IterationCode iterationCode,
                             long[] offset,
                             P position)
```
  - IterationCodeIterator
```
public IterationCodeIterator(gnu.trove.list.array.TIntArrayList itcode,
                             long[] offset,
                             P position)
```
  - IterationCodeIterator
```
public IterationCodeIterator(IterationCodeIterator<?> copyFrom,
                             P position)
```
- Method Detail
  - jumpFwd
```
public void jumpFwd(long steps)
```
    Description copied from interface: Iterator
    
    Move steps × forward.
    
    Specified by:
    
    jumpFwd in interface Iterator
    
    Parameters:
    
    steps - number of steps to move forward
  - fwd
```
public void fwd()
```
    Description copied from interface: Iterator
    
    Move forward.
    
    Specified by:
    
    fwd in interface Iterator
  - reset
```
public void reset()
```
    Description copied from interface: Iterator
    
    Reset the Iterator, that is put it to where it would be if newly created.
    
    Specified by:
    
    reset in interface Iterator
  - hasNext
```
public boolean hasNext()
```
    Description copied from interface: Iterator
    
    Returns true if another step forward is possible.
    
    Specified by:
    
    hasNext in interface Iterator
    
    Returns:
    
    true, if there is another step forward is possible, otherwise false

Class IterationCodeIterator<P extends Positionable & Localizable>

Field Summary

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Constructor Detail

IterationCodeIterator

IterationCodeIterator

IterationCodeIterator

Method Detail

jumpFwd

fwd

reset

hasNext