java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractInterval
  - - net.imglib2.iterator.IntervalIterator
    - - net.imglib2.iterator.LocalizingIntervalIterator

All Implemented Interfaces:

Dimensions, EuclideanSpace, Interval, Iterator, Localizable, RealInterval, RealLocalizable

Direct Known Subclasses:

LocalizingZeroMinIntervalIterator, NtreeCursor, OffsetableLocalizingIntervalIterator
```
public class LocalizingIntervalIterator
extends IntervalIterator
```
Use this class to iterate a virtual Interval in flat order, that is: row by row, plane by plane, cube by cube, ... This is useful for iterating an arbitrary interval in a defined order. For that, connect a LocalizingIntervalIterator to a Positionable.
```
 
 ...
 LocalizingIntervalIterator i = new LocalizingIntervalIterator(image);
 RandomAccess<T> s = image.randomAccess();
 while (i.hasNext()) {
   i.fwd();
   s.setPosition(i);
   s.type().performOperation(...);
   ...
 }
 ...
 
```
Note that LocalizingIntervalIterator is the right choice in situations where, for each pixel, you want to localize and/or set the RandomAccess, that is, in a dense sampling situation. For localizing sparsely (e.g. under an external condition), use IntervalIterator instead.

Field Summary

Fields
Modifier and Type Field Description

protected long[] position
- Fields inherited from class net.imglib2.iterator.IntervalIterator
  dimensions, index, lastIndex, steps
- Fields inherited from class net.imglib2.AbstractInterval
  max, min
- Fields inherited from class net.imglib2.AbstractEuclideanSpace
  n

Constructor Summary

Constructors
Constructor	Description
`LocalizingIntervalIterator(int[] dimensions)`
`LocalizingIntervalIterator(int[] min, int[] max)`
`LocalizingIntervalIterator(long[] dimensions)`
`LocalizingIntervalIterator(long[] min, long[] max)`
`LocalizingIntervalIterator(Interval interval)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`fwd()`	Move forward.
`double`	`getDoublePosition(int d)`	Return the current position in a given dimension.
`float`	`getFloatPosition(int d)`	Return the current position in a given dimension.
`int`	`getIntPosition(int d)`	Return the current position in a given dimension.
`long`	`getLongPosition(int d)`	Return the current position in a given dimension.
`void`	`jumpFwd(long i)`	Move steps × forward.
`void`	`localize(double[] pos)`	Write the current position into the passed array.
`void`	`localize(float[] pos)`	Write the current position into the passed array.
`void`	`localize(int[] pos)`	Write the current position into the passed array.
`void`	`localize(long[] pos)`	Write the current position into the passed array.
`void`	`reset()`	Reset the `Iterator`, that is put it to where it would be if newly created.

Methods inherited from class net.imglib2.iterator.IntervalIterator
create, dimension, dimensions, getIndex, hasNext, toString

Methods inherited from class net.imglib2.AbstractInterval
max, max, max, min, min, min, realMax, realMax, realMax, realMin, realMin, realMin

Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions

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

Methods inherited from interface net.imglib2.Dimensions
dimensions, dimensionsAsLongArray, dimensionsAsPoint

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

Methods inherited from interface net.imglib2.Interval
maxAsLongArray, maxAsPoint, minAsLongArray, minAsPoint

Methods inherited from interface net.imglib2.Localizable
localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint

Methods inherited from interface net.imglib2.RealLocalizable
positionAsDoubleArray, positionAsRealPoint

- Field Detail
  - position
```
protected final long[] position
```
- Constructor Detail
  - LocalizingIntervalIterator
```
public LocalizingIntervalIterator(long[] dimensions)
```
  - LocalizingIntervalIterator
```
public LocalizingIntervalIterator(int[] dimensions)
```
  - LocalizingIntervalIterator
```
public LocalizingIntervalIterator(long[] min,
                                  long[] max)
```
  - LocalizingIntervalIterator
```
public LocalizingIntervalIterator(int[] min,
                                  int[] max)
```
  - LocalizingIntervalIterator
```
public LocalizingIntervalIterator(Interval interval)
```
- Method Detail
  - fwd
```
public void fwd()
```
    Description copied from interface: Iterator
    
    Move forward.
    
    Specified by:
    
    fwd in interface Iterator
    
    Overrides:
    
    fwd in class IntervalIterator
  - jumpFwd
```
public void jumpFwd(long i)
```
    Description copied from interface: Iterator
    
    Move steps × forward.
    Highly recommended to override this with a more efficient version.
    
    Specified by:
    
    jumpFwd in interface Iterator
    
    Overrides:
    
    jumpFwd in class IntervalIterator
    
    Parameters:
    
    i - number of steps to move forward
  - 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
    
    Overrides:
    
    reset in class IntervalIterator
  - localize
```
public void localize(float[] pos)
```
    Description copied from interface: RealLocalizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface RealLocalizable
    
    Overrides:
    
    localize in class IntervalIterator
    
    Parameters:
    
    pos - receives current position, length must be ≥ EuclideanSpace.numDimensions()
  - localize
```
public void localize(double[] pos)
```
    Description copied from interface: RealLocalizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface RealLocalizable
    
    Overrides:
    
    localize in class IntervalIterator
    
    Parameters:
    
    pos - receives current position, length must be ≥ EuclideanSpace.numDimensions()
  - localize
```
public void localize(int[] pos)
```
    Description copied from interface: Localizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface Localizable
    
    Overrides:
    
    localize in class IntervalIterator
    
    Parameters:
    
    pos - receives current position, length must be ≥ EuclideanSpace.numDimensions()
  - localize
```
public void localize(long[] pos)
```
    Description copied from interface: Localizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface Localizable
    
    Overrides:
    
    localize in class IntervalIterator
    
    Parameters:
    
    pos - receives current position, length must be ≥ EuclideanSpace.numDimensions()
  - getFloatPosition
```
public float getFloatPosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getFloatPosition in interface Localizable
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
    
    Overrides:
    
    getFloatPosition in class IntervalIterator
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getDoublePosition
```
public double getDoublePosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getDoublePosition in interface Localizable
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
    
    Overrides:
    
    getDoublePosition in class IntervalIterator
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getIntPosition
```
public int getIntPosition(int d)
```
    Description copied from interface: Localizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getIntPosition in interface Localizable
    
    Overrides:
    
    getIntPosition in class IntervalIterator
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getLongPosition
```
public long getLongPosition(int d)
```
    Description copied from interface: Localizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getLongPosition in interface Localizable
    
    Overrides:
    
    getLongPosition in class IntervalIterator
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position

Class LocalizingIntervalIterator

Field Summary

Fields inherited from class net.imglib2.iterator.IntervalIterator

Fields inherited from class net.imglib2.AbstractInterval

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.iterator.IntervalIterator

Methods inherited from class net.imglib2.AbstractInterval

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.Dimensions

Methods inherited from interface net.imglib2.EuclideanSpace

Methods inherited from interface net.imglib2.Interval

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealInterval

Methods inherited from interface net.imglib2.RealLocalizable

Field Detail

position

Constructor Detail

LocalizingIntervalIterator

LocalizingIntervalIterator

LocalizingIntervalIterator

LocalizingIntervalIterator

LocalizingIntervalIterator

Method Detail

fwd

jumpFwd

reset

localize

localize

localize

localize

getFloatPosition

getDoublePosition

getIntPosition

getLongPosition