Class IntervalView<T>

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractInterval

net.imglib2.view.IntervalView<T>

All Implemented Interfaces:

Iterable<T>, Dimensions, EuclideanSpace, Interval, IterableInterval<T>, IterableRealInterval<T>, RandomAccessible<T>, RandomAccessibleInterval<T>, RealInterval, Typed<T>, View

public class IntervalView<T>
extends AbstractInterval
implements RandomAccessibleInterval<T>, View

IntervalView is a view that puts Interval boundaries on its source RandomAccessible. IntervalView uses TransformBuilder to create efficient accessors. Usually an IntervalView is created through the Views.interval(RandomAccessible, Interval) method instead.

Field Summary

Fields

Modifier and Type	Field	Description
protected IterableInterval<T>	fullViewIterableInterval	TODO Javadoc
protected RandomAccessible<T>	fullViewRandomAccessible	TODO Javadoc
protected final RandomAccessible<T>	source	The source RandomAccessible.

Fields inherited from class AbstractInterval

max, min

Fields inherited from class AbstractEuclideanSpace

n

Constructor Summary

Constructors

Constructor	Description
IntervalView(RandomAccessible<T> source, long[] min, long[] max)	Create a view that defines an interval on a source.
IntervalView(RandomAccessible<T> source, Interval interval)	Create a view that defines an interval on a source.

Method Summary

Modifier and Type	Method	Description
Cursor<T>	cursor()	Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step.
T	firstElement()	Get the first element of this IterableRealInterval.
protected IterableInterval<T>	getFullViewIterableInterval()
RandomAccessible<T>	getSource()	Gets the underlying source RandomAccessible.
T	getType()	Get an instance of T.
Object	iterationOrder()	Returns the iteration order of this IterableRealInterval.
Iterator<T>	iterator()
Cursor<T>	localizingCursor()	Returns a RealLocalizable Iterator that calculates its location at each iteration step.
LocalizableSpliterator<T>	localizingSpliterator()	Creates a LocalizableSpliterator over the elements of this IterableInterval.
RandomAccess<T>	randomAccess()	Create a random access sampler for integer coordinates.
RandomAccess<T>	randomAccess(Interval interval)	Create a random access sampler for integer coordinates.
long	size()	Returns the number of elements in this Function.
LocalizableSpliterator<T>	spliterator()	Creates a LocalizableSpliterator over the elements of this IterableInterval.

Methods inherited from class AbstractInterval

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

Methods inherited from class AbstractEuclideanSpace

numDimensions

Methods inherited from class Object

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

Methods inherited from interface Dimensions

dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint

Methods inherited from interface EuclideanSpace

numDimensions

Methods inherited from interface Interval

dimension, max, max, max, maxAsLongArray, maxAsPoint, min, min, min, minAsLongArray, minAsPoint, realMax, realMin

Methods inherited from interface Iterable

forEach

Methods inherited from interface IterableRealInterval

parallelStream, stream

Methods inherited from interface RandomAccessible

getAt, getAt, getAt

Methods inherited from interface RealInterval

maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMin

Field Details

source

protected final RandomAccessible<T> source

The source RandomAccessible.

fullViewRandomAccessible

protected RandomAccessible<T> fullViewRandomAccessible

TODO Javadoc

fullViewIterableInterval

protected IterableInterval<T> fullViewIterableInterval

TODO Javadoc

Constructor Details

IntervalView

public IntervalView(RandomAccessible<T> source,
 Interval interval)

Create a view that defines an interval on a source. It is the callers responsibility to ensure that the source is defined in the specified interval.

See Also:

• Views.interval(RandomAccessible, Interval)

IntervalView

public IntervalView(RandomAccessible<T> source,
 long[] min,
 long[] max)

Create a view that defines an interval on a source. It is the callers responsibility to ensure that the source is defined in the specified interval.

Parameters:

min - minimum coordinate of the interval.

max - maximum coordinate of the interval.

See Also:

• Views.interval(RandomAccessible, Interval)

Method Details

getSource

public RandomAccessible<T> getSource()

Gets the underlying source RandomAccessible.

Returns:

the source RandomAccessible.

randomAccess

public RandomAccess<T> randomAccess(Interval interval)

Description copied from interface: RandomAccessible

Create a random access sampler for integer coordinates.

The returned random access is intended to be used in the specified interval only. Thus, the RandomAccessible may provide optimized versions. If the interval is completely contained in the domain, the random access is guaranteed to provide the same values as that obtained by RandomAccessible.randomAccess() within the interval.

Specified by:

randomAccess in interface RandomAccessible<T>

Parameters:

interval - in which interval you intend to use the random access.

Returns:

random access sampler

randomAccess

public RandomAccess<T> randomAccess()

Description copied from interface: RandomAccessible

Create a random access sampler for integer coordinates.

The returned random access covers as much of the domain as possible.

Please note: RandomAccessibleIntervals have a finite domain (their Interval), so RandomAccessible.randomAccess() is only guaranteed to cover this finite domain. This may lead to unexpected results when using Views. In the following code

RandomAccessible<T> extended = Views.extendBorder( img )
RandomAccessibleInterval<T> cropped = Views.interval( extended, img );
RandomAccess<T> a1 = extended.randomAccess();
RandomAccess<T> a2 = cropped.randomAccess();

The access a1 on the extended image is valid everywhere. However, somewhat counter-intuitively, the access a2 on the extended and cropped image is only valid on the interval img to which the extended image was cropped. The access is only required to cover this interval, because it is the domain of the cropped image. Views attempts to provide the fastest possible access that meets this requirement, and will therefore strip the extension. To deal with this, if you know that you need to access pixels outside the domain of the RandomAccessibleInterval, and you know that the RandomAccessibleInterval is actually defined beyond its interval boundaries, then use the RandomAccessible.randomAccess(Interval) variant and specify which interval you actually want to access. In the above example,

RandomAccess<T> a2 = cropped.randomAccess( Intervals.expand( img, 10 ) );

will provide the extended access as expected.

Specified by:

randomAccess in interface RandomAccessible<T>

Returns:

random access sampler

getFullViewIterableInterval

protected IterableInterval<T> getFullViewIterableInterval()

size

public long size()

Description copied from interface: IterableRealInterval

Returns the number of elements in this Function.

Specified by:

size in interface IterableRealInterval<T>

Specified by:

size in interface RandomAccessibleInterval<T>

Returns:

number of elements

firstElement

public T firstElement()

Description copied from interface: IterableRealInterval

Get the first element of this IterableRealInterval. This is a shortcut for cursor().next().

This can be used to create a new variable of type T using firstElement().createVariable(), which is useful in generic methods to store temporary results, e.g., a running sum over pixels in the IterableRealInterval.

Specified by:

firstElement in interface IterableRealInterval<T>

Returns:

the first element in iteration order.

iterationOrder

public Object iterationOrder()

Description copied from interface: IterableRealInterval

Returns the iteration order of this IterableRealInterval. If the returned object equals (Object.equals(Object)) the iteration order of another IterableRealInterval f then they can be copied by synchronous iteration. That is, having an Iterator on this and another Iterator on f, moving both in synchrony will point both of them to corresponding locations in their source domain. In other words, this and f have the same iteration order and means and the same number of elements.

Specified by:

iterationOrder in interface IterableRealInterval<T>

Specified by:

iterationOrder in interface RandomAccessibleInterval<T>

Returns:

the iteration order of this IterableRealInterval.

See Also:

• FlatIterationOrder

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface IterableRealInterval<T>

cursor

public Cursor<T> cursor()

Description copied from interface: IterableRealInterval

Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step. Localization is performed on demand.

Use this where localization is required rarely/ not for each iteration.

Specified by:

cursor in interface IterableInterval<T>

Specified by:

cursor in interface IterableRealInterval<T>

Specified by:

cursor in interface RandomAccessibleInterval<T>

Returns:

fast iterating iterator

localizingCursor

public Cursor<T> localizingCursor()

Description copied from interface: IterableRealInterval

Returns a RealLocalizable Iterator that calculates its location at each iteration step. That is, localization is performed with optimal speed.

Use this where localization is required often/ for each iteration.

Specified by:

localizingCursor in interface IterableInterval<T>

Specified by:

localizingCursor in interface IterableRealInterval<T>

Specified by:

localizingCursor in interface RandomAccessibleInterval<T>

Returns:

fast localizing iterator

spliterator

public LocalizableSpliterator<T> spliterator()

Description copied from interface: IterableInterval

Creates a LocalizableSpliterator over the elements of this IterableInterval. The returned Spliterator iterates with optimal speed without calculating the location at each iteration step. Localization is performed on demand.

The default implementation wraps a Cursor on the interval. The created Spliterator reports Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED and Spliterator.NONNULL.

Specified by:

spliterator in interface Iterable<T>

Specified by:

spliterator in interface IterableInterval<T>

Specified by:

spliterator in interface IterableRealInterval<T>

localizingSpliterator

public LocalizableSpliterator<T> localizingSpliterator()

Description copied from interface: IterableInterval

Creates a LocalizableSpliterator over the elements of this IterableInterval. The returned Spliterator calculates its location at each iteration step. That is, localization is performed with optimal speed.

The default implementation wraps a localizing Cursor on the interval. The created Spliterator reports Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED and Spliterator.NONNULL.

Specified by:

localizingSpliterator in interface IterableInterval<T>

Specified by:

localizingSpliterator in interface IterableRealInterval<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 IterableRealInterval<T>

Specified by:

getType in interface Typed<T>

Returns:

an instance of T