Package net.imglib2.converter
Class AbstractConvertedIterableInterval<A,B>
- java.lang.Object
-
- net.imglib2.AbstractWrappedRealInterval<I>
-
- net.imglib2.AbstractWrappedInterval<IterableInterval<A>>
-
- net.imglib2.converter.AbstractConvertedIterableInterval<A,B>
-
- All Implemented Interfaces:
java.lang.Iterable<B>
,Dimensions
,EuclideanSpace
,Interval
,IterableInterval<B>
,IterableRealInterval<B>
,RealInterval
,View
- Direct Known Subclasses:
ConvertedIterableInterval
,WriteConvertedIterableInterval
public abstract class AbstractConvertedIterableInterval<A,B> extends AbstractWrappedInterval<IterableInterval<A>> implements IterableInterval<B>, View
TODO
-
-
Field Summary
-
Fields inherited from class net.imglib2.AbstractWrappedRealInterval
sourceInterval
-
-
Constructor Summary
Constructors Constructor Description AbstractConvertedIterableInterval(IterableInterval<A> source)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract AbstractConvertedCursor<A,B>
cursor()
Returns aRealCursor
that iterates with optimal speed without calculating the location at each iteration step.B
firstElement()
Get the first element of thisIterableRealInterval
.java.lang.Object
iterationOrder()
Returns the iteration order of thisIterableRealInterval
.java.util.Iterator<B>
iterator()
abstract AbstractConvertedCursor<A,B>
localizingCursor()
Returns aRealLocalizable
Iterator
that calculates its location at each iteration step.long
size()
Returns the number of elements in thisFunction
.-
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
dimension, dimensions
-
Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions
-
-
-
-
Constructor Detail
-
AbstractConvertedIterableInterval
public AbstractConvertedIterableInterval(IterableInterval<A> source)
-
-
Method Detail
-
size
public long size()
Description copied from interface:IterableRealInterval
Returns the number of elements in this
Function
.- Specified by:
size
in interfaceIterableRealInterval<A>
- Returns:
- number of elements
-
iterationOrder
public java.lang.Object iterationOrder()
Description copied from interface:IterableRealInterval
Returns the iteration order of thisIterableRealInterval
. If the returned object equals (Object.equals(Object)
) the iteration order of anotherIterableRealInterval
f then they can be copied by synchronous iteration. That is, having anIterator
on this and anotherIterator
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 interfaceIterableRealInterval<A>
- Returns:
- the iteration order of this
IterableRealInterval
. - See Also:
FlatIterationOrder
-
iterator
public java.util.Iterator<B> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<A>
-
firstElement
public B firstElement()
Description copied from interface:IterableRealInterval
Get the first element of thisIterableRealInterval
. This is a shortcut forcursor().next()
. This can be used to create a new variable of type T usingfirstElement().createVariable()
, which is useful in generic methods to store temporary results, e.g., a running sum over pixels in theIterableRealInterval
.- Specified by:
firstElement
in interfaceIterableRealInterval<A>
- Returns:
- the first element in iteration order.
-
cursor
public abstract AbstractConvertedCursor<A,B> 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 interfaceIterableInterval<A>
- Specified by:
cursor
in interfaceIterableRealInterval<A>
- Returns:
- fast iterating iterator
-
localizingCursor
public abstract AbstractConvertedCursor<A,B> 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 interfaceIterableInterval<A>
- Specified by:
localizingCursor
in interfaceIterableRealInterval<A>
- Returns:
- fast localizing iterator
-
-