Class IntervalView<T>
- All Implemented Interfaces:
Iterable<T>
,Dimensions
,EuclideanSpace
,Interval
,IterableInterval<T>
,IterableRealInterval<T>
,RandomAccessible<T>
,RandomAccessibleInterval<T>
,RealInterval
,View
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
FieldsModifier and TypeFieldDescriptionprotected IterableInterval
<T> TODO Javadocprotected RandomAccessible
<T> TODO Javadocprotected final RandomAccessible
<T> The sourceRandomAccessible
.Fields inherited from class net.imglib2.AbstractInterval
max, min
Fields inherited from class net.imglib2.AbstractEuclideanSpace
n
-
Constructor Summary
ConstructorsConstructorDescriptionIntervalView
(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 TypeMethodDescriptioncursor()
Returns aRealCursor
that iterates with optimal speed without calculating the location at each iteration step.Get the first element of thisIterableRealInterval
.protected IterableInterval
<T> Gets the underlying sourceRandomAccessible
.Returns the iteration order of thisIterableRealInterval
.iterator()
Returns aRealLocalizable
Iterator
that calculates its location at each iteration step.Create a random access sampler for integer coordinates.randomAccess
(Interval interval) Create a random access sampler for integer coordinates.long
size()
Returns the number of elements in thisFunction
.Methods inherited from class net.imglib2.AbstractInterval
dimension, dimensions, max, max, max, min, min, min, realMax, realMax, realMax, realMin, realMin, realMin
Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions
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
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Field Details
-
source
The sourceRandomAccessible
. -
fullViewRandomAccessible
TODO Javadoc -
fullViewIterableInterval
TODO Javadoc
-
-
Constructor Details
-
IntervalView
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:
-
IntervalView
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:
-
-
Method Details
-
getSource
Gets the underlying sourceRandomAccessible
.- Returns:
- the source
RandomAccessible
.
-
randomAccess
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 interfaceRandomAccessible<T>
- Parameters:
interval
- in which interval you intend to use the random access.- Returns:
- random access sampler
-
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:RandomAccessibleInterval
s have a finite domain (theirInterval
), soRandomAccessible.randomAccess()
is only guaranteed to cover this finite domain. This may lead to unexpected results when usingViews
. In the following codeRandomAccessible<T> extended = Views.extendBorder( img ) RandomAccessibleInterval<T> cropped = Views.interval( extended, img ); RandomAccess<T> a1 = extended.randomAccess(); RandomAccess<T> a2 = cropped.randomAccess();
Theaccess
a1
on the extended image is valid everywhere. However, somewhat counter-intuitively, theaccess
a2
on the extended and cropped image is only valid on the intervalimg
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 theRandomAccessibleInterval
, and you know that theRandomAccessibleInterval
is actually defined beyond its interval boundaries, then use theRandomAccessible.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 interfaceRandomAccessible<T>
- Returns:
- random access sampler
-
getFullViewIterableInterval
-
size
public long size()Description copied from interface:IterableRealInterval
Returns the number of elements in this
Function
.- Specified by:
size
in interfaceIterableRealInterval<T>
- Returns:
- number of elements
-
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<T>
- Returns:
- the first element in iteration order.
-
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<T>
- Returns:
- the iteration order of this
IterableRealInterval
. - See Also:
-
iterator
-
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<T>
- Specified by:
cursor
in interfaceIterableRealInterval<T>
- Returns:
- fast iterating iterator
-
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<T>
- Specified by:
localizingCursor
in interfaceIterableRealInterval<T>
- Returns:
- fast localizing iterator
-