Package net.imglib2.view.iteration

Class IterableTransformBuilder.Slice

java.lang.Object

net.imglib2.AbstractWrappedRealInterval<I>

net.imglib2.AbstractWrappedInterval<Interval>

net.imglib2.view.iteration.IterableTransformBuilder.Slice

All Implemented Interfaces:

java.lang.Iterable<T>, Dimensions, EuclideanSpace, Interval, IterableInterval<T>, IterableRealInterval<T>, RealInterval, Typed<T>

Enclosing class:

IterableTransformBuilder<T>

private class IterableTransformBuilder.Slice
extends AbstractWrappedInterval<Interval>
implements IterableInterval<T>

An IterableInterval on a slice of a SubIntervalIterable.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	hasFlatIterationOrder
(package private) SubIntervalIterable<T>	iterableSource
(package private) long	numElements
(package private) Interval	sourceInterval
(package private) SlicingTransform	transformToSource

Constructor Summary

Constructors

Constructor	Description
Slice(SubIntervalIterable<T> iterableSource, Interval sourceInterval, SlicingTransform transformToSource, boolean hasFlatIterationOrder)

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	getType()	Get an instance of T.
java.lang.Object	iterationOrder()	Returns the iteration order of this IterableRealInterval.
Cursor<T>	localizingCursor()	Returns a RealLocalizable Iterator that calculates its location at each iteration step.
long	size()	Returns the number of elements in this Function.

Methods inherited from class net.imglib2.AbstractWrappedInterval

dimension, dimensions, max, max, max, min, min, min

Methods inherited from class net.imglib2.AbstractWrappedRealInterval

getSource, numDimensions, realMax, realMax, realMax, realMin, realMin, realMin

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.imglib2.Dimensions

dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Methods inherited from interface net.imglib2.Interval

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

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface net.imglib2.IterableInterval

localizingSpliterator, spliterator

Methods inherited from interface net.imglib2.IterableRealInterval

firstElement, iterator, parallelStream, stream

Methods inherited from interface net.imglib2.RealInterval

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

Field Detail

numElements

final long numElements

iterableSource

final SubIntervalIterable<T> iterableSource

sourceInterval

final Interval sourceInterval

transformToSource

final SlicingTransform transformToSource

hasFlatIterationOrder

final boolean hasFlatIterationOrder

Constructor Detail

Slice

public Slice(SubIntervalIterable<T> iterableSource,
             Interval sourceInterval,
             SlicingTransform transformToSource,
             boolean hasFlatIterationOrder)

Method Detail

size

public long size()

Description copied from interface: IterableRealInterval

Returns the number of elements in this Function.

Specified by:

size in interface IterableRealInterval<T>

Returns:

number of elements

iterationOrder

public java.lang.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>

Returns:

the iteration order of this IterableRealInterval.

See Also:

FlatIterationOrder

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>

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>

Returns:

fast localizing iterator

getType

public T getType()

Description copied from interface: IterableRealInterval

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.

The default implementation returns IterableRealInterval.firstElement(). Derived classes may choose different implementations for improved performance.

Specified by:

getType in interface IterableRealInterval<T>

Specified by:

getType in interface Typed<T>

Returns:

an instance of T