net.imglib2.view

Class RandomAccessibleIntervalCursor<T>

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractInterval

net.imglib2.view.RandomAccessibleIntervalCursor<T>

All Implemented Interfaces:

Iterator<T>, Cursor<T>, Dimensions, EuclideanSpace, Interval, Localizable, RealCursor<T>, RealInterval, RealLocalizable, Sampler<T>, Typed<T>

public final class RandomAccessibleIntervalCursor<T>
extends AbstractInterval
implements Cursor<T>

A Cursor that iterates any RandomAccessibleInterval by moving a RandomAccess in flat iteration order. Localizable calls are forwarded to the RandomAccess.

Author:

Tobias Pietzsch, Stephan Saalfeld

Field Summary

Fields inherited from class net.imglib2.AbstractInterval

max, min

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Modifier	Constructor and Description
	RandomAccessibleIntervalCursor(I interval)
	RandomAccessibleIntervalCursor(RandomAccessible<T> randomAccessible, Interval interval)
protected	RandomAccessibleIntervalCursor(RandomAccessibleIntervalCursor<T> cursor)

Method Summary

Modifier and Type	Method and Description
RandomAccessibleIntervalCursor<T>	copy()
void	fwd() Move forward.
T	get() Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
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.
T	getType() Get an instance of T.
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	localize(int[] position) Write the current position into the passed array.
void	localize(long[] 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.

Methods inherited from class net.imglib2.AbstractInterval

dimension, dimensions, max, max, max, min, min, min, realMax, realMax, realMax, realMin, realMin, realMin, toString

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

copyCursor

Methods inherited from interface net.imglib2.RealCursor

next

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface net.imglib2.Localizable

localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealLocalizable

positionAsDoubleArray, positionAsRealPoint

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

maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint

Methods inherited from interface net.imglib2.Dimensions

allPositive, allPositive, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositive

Constructor Detail

RandomAccessibleIntervalCursor

public RandomAccessibleIntervalCursor(I interval)

RandomAccessibleIntervalCursor

public RandomAccessibleIntervalCursor(RandomAccessible<T> randomAccessible,
                                      Interval interval)

RandomAccessibleIntervalCursor

protected RandomAccessibleIntervalCursor(RandomAccessibleIntervalCursor<T> cursor)

Method Detail

get

public T get()

Description copied from interface: Sampler

Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.

Specified by:

get in interface Sampler<T>

getType

public T getType()

Description copied from interface: Typed

Get an instance of T.

It should not be assumed that the returned T instance is an independent copy. In particular, repeated calls to getType() may return the same instance.

Specified by:

getType in interface Sampler<T>

Specified by:

getType in interface Typed<T>

Returns:

an instance of T

jumpFwd

public void jumpFwd(long steps)

Description copied from interface: Iterator

Move steps × forward.

Highly recommended to override this with a more efficient version.

Parameters:

steps - number of steps to move forward

fwd

public void fwd()

Description copied from interface: Iterator

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.

hasNext

public boolean hasNext()

Description copied from interface: Iterator

Returns true if another step forward is possible.

Specified by:

hasNext in interface Iterator<T>

Returns:

true, if there is another step forward is possible, otherwise false

copy

public RandomAccessibleIntervalCursor<T> copy()

Specified by:

copy in interface Cursor<T>

Specified by:

copy in interface RealCursor<T>

Specified by:

copy in interface Sampler<T>

Returns:

- A new Sampler in the same state accessing the same values. It does NOT copy T, just the state of the Sampler. Otherwise use T.copy() if available. Sampler.copy().get() == Sampler.get(), i.e. both hold the same value, not necessarily the same instance (this is the case for an ArrayCursor for example)

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 Localizable

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 Localizable

Specified by:

getDoublePosition in interface RealLocalizable

Parameters:

d - dimension

Returns:

dimension of current position

localize

public void localize(int[] position)

Description copied from interface: Localizable

Write the current position into the passed array.

Specified by:

localize in interface Localizable

Parameters:

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

localize

public void localize(long[] position)

Description copied from interface: Localizable

Write the current position into the passed array.

Specified by:

localize in interface Localizable

Parameters:

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

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

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

Parameters:

d - dimension

Returns:

dimension of current position