Class IntervalView<T>
- java.lang.Object
-
- net.imglib2.AbstractEuclideanSpace
-
- net.imglib2.AbstractInterval
-
- net.imglib2.view.IntervalView<T>
-
- All Implemented Interfaces:
java.lang.Iterable<T>
,Dimensions
,EuclideanSpace
,Interval
,IterableInterval<T>
,IterableRealInterval<T>
,RandomAccessible<T>
,RandomAccessibleInterval<T>
,RealInterval
,View
public class IntervalView<T> extends AbstractInterval implements RandomAccessibleInterval<T>, IterableInterval<T>, View
IntervalView is a view that putsInterval
boundaries on its sourceRandomAccessible
. IntervalView usesTransformBuilder
to create efficientaccessors
. Usually an IntervalView is created through theViews.interval(RandomAccessible, Interval)
method instead.
-
-
Field Summary
Fields Modifier and Type Field Description protected IterableInterval<T>
fullViewIterableInterval
TODO Javadocprotected RandomAccessible<T>
fullViewRandomAccessible
TODO Javadocprotected RandomAccessible<T>
source
The sourceRandomAccessible
.-
Fields inherited from class net.imglib2.AbstractInterval
max, min
-
Fields inherited from class net.imglib2.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Cursor<T>
cursor()
Returns aRealCursor
that iterates with optimal speed without calculating the location at each iteration step.T
firstElement()
Get the first element of thisIterableRealInterval
.protected IterableInterval<T>
getFullViewIterableInterval()
RandomAccessible<T>
getSource()
Gets the underlying sourceRandomAccessible
.java.lang.Object
iterationOrder()
Returns the iteration order of thisIterableRealInterval
.java.util.Iterator<T>
iterator()
Cursor<T>
localizingCursor()
Returns aRealLocalizable
Iterator
that calculates its location at each iteration step.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 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
-
-
-
-
Field Detail
-
source
protected final RandomAccessible<T> source
The sourceRandomAccessible
.
-
fullViewRandomAccessible
protected RandomAccessible<T> fullViewRandomAccessible
TODO Javadoc
-
fullViewIterableInterval
protected IterableInterval<T> fullViewIterableInterval
TODO Javadoc
-
-
Constructor Detail
-
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.
-
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 Detail
-
getSource
public RandomAccessible<T> getSource()
Gets the underlying sourceRandomAccessible
.- 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 interfaceRandomAccessible<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: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
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 interfaceIterableRealInterval<T>
- Returns:
- number of elements
-
firstElement
public T 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
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<T>
- Returns:
- the iteration order of this
IterableRealInterval
. - See Also:
FlatIterationOrder
-
iterator
public java.util.Iterator<T> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<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 interfaceIterableInterval<T>
- Specified by:
cursor
in interfaceIterableRealInterval<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 interfaceIterableInterval<T>
- Specified by:
localizingCursor
in interfaceIterableRealInterval<T>
- Returns:
- fast localizing iterator
-
-