net.imglib2.iterator

Class LocalizingRealIntervalIterator

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractRealInterval

net.imglib2.iterator.LocalizingRealIntervalIterator

All Implemented Interfaces:

EuclideanSpace, Iterator, RealInterval, RealLocalizable

public class LocalizingRealIntervalIterator
extends AbstractRealInterval
implements Iterator, RealLocalizable

Use this class to iterate a virtual RealInterval in flat order, that is: with the first dimension varying most quickly and the last dimension varying most slowly. This is useful for iterating an arbitrary real interval in a defined order.

Author:

John Bogovic, Stephan Preibisch, Stephan Saalfeld

Field Summary

Fields

Modifier and Type	Field and Description
protected double[]	location
protected double[]	step

Fields inherited from class net.imglib2.AbstractRealInterval

max, min

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Constructor and Description
LocalizingRealIntervalIterator(double[] min, double[] max, double[] step) Iterates an RealInterval with given min and max the the provided step along each dimension.
LocalizingRealIntervalIterator(RealInterval interval, double[] step) Iterates an RealInterval with given min and max with the provided step along each dimension.

Method Summary

Modifier and Type	Method and 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.
boolean	hasNext() Returns true if another step forward is possible.
void	jumpFwd(long steps) Move steps × forward.
void	localize(double[] position) Write the current position into the passed array.
void	localize(float[] position) 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.
String	toString()

Methods inherited from class net.imglib2.AbstractRealInterval

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.RealLocalizable

localize, positionAsDoubleArray, positionAsRealPoint

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Methods inherited from interface net.imglib2.RealInterval

maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint

Field Detail

step

protected final double[] step

location

protected final double[] location

Constructor Detail

LocalizingRealIntervalIterator

public LocalizingRealIntervalIterator(RealInterval interval,
                                      double[] step)

Iterates an RealInterval with given min and max with the provided step along each dimension.

Parameters:

interval - the real interval

step - iteration step

LocalizingRealIntervalIterator

public LocalizingRealIntervalIterator(double[] min,
                                      double[] max,
                                      double[] step)

Iterates an RealInterval with given min and max the the provided step along each dimension.

Parameters:

min - real interval min

max - real interval min

step - iteration steps

Method Detail

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

toString

public String toString()

Overrides:

toString in class AbstractRealInterval

localize

public void localize(float[] position)

Description copied from interface: RealLocalizable

Write the current position into the passed array.

Specified by:

localize in interface RealLocalizable

Parameters:

position - receives current position, length must be ≥ EuclideanSpace.numDimensions()

localize

public void localize(double[] position)

Description copied from interface: RealLocalizable

Write the current position into the passed array.

Specified by:

localize in interface RealLocalizable

Parameters:

position - 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 RealLocalizable

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 RealLocalizable

Parameters:

d - dimension

Returns:

dimension of current position

jumpFwd

public void jumpFwd(long steps)

Description copied from interface: Iterator

Move steps × forward.

Highly recommended to override this with a more efficient version.

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