Class HyperSlice<T>

java.lang.Object
net.imglib2.view.HyperSlice<T>
All Implemented Interfaces:
EuclideanSpace, RandomAccessible<T>

public class HyperSlice<T> extends Object implements RandomAccessible<T>
Author:
Stephan Saalfeld <saalfelds@janelia.hhmi.org>
  • Field Details

    • source

      protected final RandomAccessible<T> source
    • numDimensions

      protected final int numDimensions
    • axes

      protected final int[] axes
    • position

      protected final long[] position
  • Constructor Details

    • 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 Details

    • numDimensions

      public int numDimensions()
      Description copied from interface: EuclideanSpace
      Gets the space's number of dimensions.
      Specified by:
      numDimensions in interface EuclideanSpace
    • randomAccess

      public HyperSlice<T>.HyperSliceRandomAccess 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: RandomAccessibleIntervals have a finite domain (their Interval), so RandomAccessible.randomAccess() is only guaranteed to cover this finite domain. This may lead to unexpected results when using Views. In the following code
       RandomAccessible<T> extended = Views.extendBorder( img )
       RandomAccessibleInterval<T> cropped = Views.interval( extended, img );
       RandomAccess<T> a1 = extended.randomAccess();
       RandomAccess<T> a2 = cropped.randomAccess();
       
      The access a1 on the extended image is valid everywhere. However, somewhat counter-intuitively, the access a2 on the extended and cropped image is only valid on the interval img 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 the RandomAccessibleInterval, and you know that the RandomAccessibleInterval is actually defined beyond its interval boundaries, then use the RandomAccessible.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 interface RandomAccessible<T>
      Returns:
      random access sampler
    • 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 interface RandomAccessible<T>
      Parameters:
      interval - in which interval you intend to use the random access.
      Returns:
      random access sampler