Package net.imglib2.view
Class ExtendedRandomAccessibleInterval<T,F extends RandomAccessibleInterval<T>>
- java.lang.Object
-
- net.imglib2.view.ExtendedRandomAccessibleInterval<T,F>
-
- All Implemented Interfaces:
EuclideanSpace
,RandomAccessible<T>
,View
public final class ExtendedRandomAccessibleInterval<T,F extends RandomAccessibleInterval<T>> extends java.lang.Object implements RandomAccessible<T>, View
ImplementsRandomAccessible
for aRandomAccessibleInterval
through anOutOfBoundsFactory
. Note that it is not an Interval itself.- Author:
- Stephan Saalfeld, Tobias Pietzsch
-
-
Constructor Summary
Constructors Constructor Description ExtendedRandomAccessibleInterval(F source, OutOfBoundsFactory<T,? super F> factory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OutOfBoundsFactory<T,? super F>
getOutOfBoundsFactory()
F
getSource()
int
numDimensions()
Gets the space's number of dimensions.OutOfBounds<T>
randomAccess()
Create a random access sampler for integer coordinates.RandomAccess<T>
randomAccess(Interval interval)
Create a random access sampler for integer coordinates.
-
-
-
Field Detail
-
source
protected final F extends RandomAccessibleInterval<T> source
-
factory
protected final OutOfBoundsFactory<T,? super F extends RandomAccessibleInterval<T>> factory
-
-
Constructor Detail
-
ExtendedRandomAccessibleInterval
public ExtendedRandomAccessibleInterval(F source, OutOfBoundsFactory<T,? super F> factory)
-
-
Method Detail
-
numDimensions
public final int numDimensions()
Description copied from interface:EuclideanSpace
Gets the space's number of dimensions.- Specified by:
numDimensions
in interfaceEuclideanSpace
-
randomAccess
public final OutOfBounds<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
-
randomAccess
public final 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
-
getSource
public F getSource()
-
getOutOfBoundsFactory
public OutOfBoundsFactory<T,? super F> getOutOfBoundsFactory()
-
-