Package net.imglib2.view
Class HyperSlice<T>
- java.lang.Object
-
- net.imglib2.view.HyperSlice<T>
-
- All Implemented Interfaces:
EuclideanSpace,RandomAccessible<T>,Typed<T>
public class HyperSlice<T> extends java.lang.Object implements RandomAccessible<T>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classHyperSlice.HyperSliceRandomAccess
-
Field Summary
Fields Modifier and Type Field Description protected int[]axesprotected intnumDimensionsprotected long[]positionprotected RandomAccessible<T>source
-
Constructor Summary
Constructors Constructor Description HyperSlice(RandomAccessible<T> source, int[] fixedAxes, long[] position)Create a new HyperSlice at a position.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TgetType()Get an instance ofT.intnumDimensions()Gets the space's number of dimensions.HyperSlice.HyperSliceRandomAccessrandomAccess()Create a random access sampler for integer coordinates.RandomAccess<T>randomAccess(Interval interval)Create a random access sampler for integer coordinates.private IntervalsourceInterval(Interval interval)Generates aFinalIntervalwhose boundaries are the current position of the hyperslice andintervalon the hyperslice.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.imglib2.RandomAccessible
getAt, getAt, getAt
-
-
-
-
Field Detail
-
source
protected final RandomAccessible<T> source
-
numDimensions
protected final int numDimensions
-
axes
protected final int[] axes
-
position
protected final long[] position
-
-
Constructor Detail
-
HyperSlice
public HyperSlice(RandomAccessible<T> source, int[] fixedAxes, long[] position)
Create a new HyperSlice at a position. The position is passed as position vector in source space, i.e. the positions along fixed axes are ignored.- Parameters:
source-fixedAxes-position-
-
-
Method Detail
-
sourceInterval
private Interval sourceInterval(Interval interval)
Generates aFinalIntervalwhose boundaries are the current position of the hyperslice andintervalon the hyperslice.- Parameters:
interval-- Returns:
-
numDimensions
public int numDimensions()
Description copied from interface:EuclideanSpaceGets the space's number of dimensions.- Specified by:
numDimensionsin interfaceEuclideanSpace
-
randomAccess
public HyperSlice.HyperSliceRandomAccess 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
-
-