Package net.imglib2.view
Class StackView<T>
- java.lang.Object
-
- net.imglib2.AbstractEuclideanSpace
-
- net.imglib2.AbstractInterval
-
- net.imglib2.view.StackView<T>
-
- Type Parameters:
T- the pixel type.
- All Implemented Interfaces:
java.lang.Iterable<T>,Dimensions,EuclideanSpace,Interval,IterableInterval<T>,IterableRealInterval<T>,RandomAccessible<T>,RandomAccessibleInterval<T>,RealInterval,Typed<T>,View
public class StackView<T> extends AbstractInterval implements RandomAccessibleInterval<T>, View
A stack of n-dimensionalRandomAccessibleIntervals, forming a (n+1)-dimensionalRandomAccessibleInterval.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classStackView.DefaultRA<T>ARandomAccesson aStackView.static classStackView.MoveAllSlicesRA<T>ARandomAccesson aStackView.static classStackView.StackAccessModeDescribes how aRandomAccesson the (n+1)-dimensionalStackViewmaps position changes into position changes of the underlying n-dimensionalRandomAccesses.
-
Field Summary
Fields Modifier and Type Field Description private RandomAccessibleInterval<T>[]slicesprivate StackView.StackAccessModestackAccessMode-
Fields inherited from class net.imglib2.AbstractInterval
max, min
-
Fields inherited from class net.imglib2.AbstractEuclideanSpace
n
-
-
Constructor Summary
Constructors Constructor Description StackView(java.util.List<? extends RandomAccessibleInterval<T>> hyperslices)StackView(java.util.List<? extends RandomAccessibleInterval<T>> hyperslices, StackView.StackAccessMode stackAccessMode)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<RandomAccessibleInterval<T>>getSourceSlices()Get the source slices that are stacked in thisStackView.StackView.StackAccessModegetStackAccessMode()TgetType()Get an instance ofT.RandomAccess<T>randomAccess()Create a random access sampler for integer coordinates.RandomAccess<T>randomAccess(Interval interval)Create a random access sampler for integer coordinates.-
Methods inherited from class net.imglib2.AbstractInterval
dimension, dimensions, max, max, max, min, min, min, realMax, realMax, realMax, realMin, realMin, realMin, toString
-
Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.imglib2.Dimensions
dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint
-
Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions
-
Methods inherited from interface net.imglib2.Interval
dimension, max, max, max, maxAsLongArray, maxAsPoint, min, min, min, minAsLongArray, minAsPoint, realMax, realMin
-
Methods inherited from interface net.imglib2.IterableInterval
localizingSpliterator, spliterator
-
Methods inherited from interface net.imglib2.IterableRealInterval
firstElement, iterator, parallelStream, stream
-
Methods inherited from interface net.imglib2.RandomAccessible
getAt, getAt, getAt
-
Methods inherited from interface net.imglib2.RandomAccessibleInterval
cursor, iterationOrder, localizingCursor, size
-
Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMin
-
-
-
-
Field Detail
-
slices
private final RandomAccessibleInterval<T>[] slices
-
stackAccessMode
private final StackView.StackAccessMode stackAccessMode
-
-
Constructor Detail
-
StackView
public StackView(java.util.List<? extends RandomAccessibleInterval<T>> hyperslices)
-
StackView
public StackView(java.util.List<? extends RandomAccessibleInterval<T>> hyperslices, StackView.StackAccessMode stackAccessMode)
-
-
Method Detail
-
randomAccess
public RandomAccess<T> randomAccess()
Description copied from interface:RandomAccessibleCreate a random access sampler for integer coordinates.The returned random access covers as much of the domain as possible.
Please note:RandomAccessibleIntervals 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();
Theaccessa1on the extended image is valid everywhere. However, somewhat counter-intuitively, theaccessa2on the extended and cropped image is only valid on the intervalimgto which the extended image was cropped. The access is only required to cover this interval, because it is the domain of the cropped image.Viewsattempts 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 theRandomAccessibleIntervalis 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:
randomAccessin interfaceRandomAccessible<T>- Returns:
- random access sampler
-
randomAccess
public RandomAccess<T> randomAccess(Interval interval)
Description copied from interface:RandomAccessibleCreate 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:
randomAccessin interfaceRandomAccessible<T>- Parameters:
interval- in which interval you intend to use the random access.- Returns:
- random access sampler
-
getType
public T getType()
Description copied from interface:TypedGet an instance ofT.It should not be assumed that the returned
Tinstance is an independent copy. In particular, repeated calls togetType()may return the same instance.
-
getSourceSlices
public java.util.List<RandomAccessibleInterval<T>> getSourceSlices()
Get the source slices that are stacked in thisStackView. These are(numDimensions() - 1)dimensionalRandomAccessibleIntervals.- Returns:
- list of source hyperslices.
-
getStackAccessMode
public StackView.StackAccessMode getStackAccessMode()
- Returns:
StackView.StackAccessModedefined in constructor
-
-