public class IterableRandomAccessibleInterval<T> extends AbstractWrappedInterval<RandomAccessibleInterval<T>> implements IterableInterval<T>, RandomAccessibleInterval<T>, View
Cursors that iterate a
RandomAccessibleInterval in flat order, that is: row by row, plane by
plane, cube by cube, ...sourceInterval| Constructor and Description |
|---|
IterableRandomAccessibleInterval(RandomAccessibleInterval<T> interval) |
| Modifier and Type | Method and Description |
|---|---|
static <T> IterableRandomAccessibleInterval<T> |
create(RandomAccessibleInterval<T> interval) |
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. |
FlatIterationOrder |
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. |
RandomAccess<T> |
randomAccess()
Create a random access sampler for integer coordinates.
|
RandomAccess<T> |
randomAccess(Interval i)
Create a random access sampler for integer coordinates.
|
long |
size()
Returns the number of elements in this
Function. |
dimension, dimensions, max, max, max, min, min, mingetSource, numDimensions, realMax, realMax, realMax, realMin, realMin, realMinclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitforEach, spliteratorgetAt, getAt, getAtdimension, max, max, max, maxAsLongArray, maxAsPoint, min, min, min, minAsLongArray, minAsPoint, realMax, realMinmaxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMinallPositive, allPositive, dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositivenumDimensionspublic IterableRandomAccessibleInterval(RandomAccessibleInterval<T> interval)
public static <T> IterableRandomAccessibleInterval<T> create(RandomAccessibleInterval<T> interval)
public long size()
IterableRealInterval
Returns the number of elements in this Function.
size in interface IterableRealInterval<T>public T firstElement()
IterableRealIntervalIterableRealInterval. 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.firstElement in interface IterableRealInterval<T>public FlatIterationOrder iterationOrder()
IterableRealIntervalIterableRealInterval. 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.iterationOrder in interface IterableRealInterval<T>IterableRealInterval.FlatIterationOrderpublic Cursor<T> cursor()
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.
cursor in interface IterableInterval<T>cursor in interface IterableRealInterval<T>public Cursor<T> localizingCursor()
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.
localizingCursor in interface IterableInterval<T>localizingCursor in interface IterableRealInterval<T>public RandomAccess<T> randomAccess()
RandomAccessibleThe 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.
randomAccess in interface RandomAccessible<T>public RandomAccess<T> randomAccess(Interval i)
RandomAccessible
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.
randomAccess in interface RandomAccessible<T>i - in which interval you intend to use the random access.Copyright © 2015–2022 ImgLib2. All rights reserved.