Class Grid.CellIntervals

java.lang.Object
net.imglib2.util.Grid.CellIntervals
All Implemented Interfaces:
Iterable<Interval>, Dimensions, EuclideanSpace, Interval, IterableInterval<Interval>, IterableRealInterval<Interval>, RandomAccessible<Interval>, RandomAccessibleInterval<Interval>, RealInterval, Typed<Interval>
Enclosing class:
Grid
public class Grid.CellIntervals extends Object implements RandomAccessibleInterval<Interval>

  • Field Details

    • size

      private final long size

  • Constructor Details

    • CellIntervals

      public CellIntervals()

  • Method Details

    • numDimensions

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

    • min

      public long min(int d)
      Description copied from interface: Interval
      Get the minimum in dimension d.
      Specified by:
      min in interface Interval
      Parameters:
      d - dimension
      Returns:
      minimum in dimension d.

    • max

      public long max(int d)
      Description copied from interface: Interval
      Get the maximum in dimension d.
      Specified by:
      max in interface Interval
      Parameters:
      d - dimension
      Returns:
      maximum in dimension d.

    • randomAccess

      public RandomAccess<Interval> 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<Interval>
      Returns:
      random access sampler

    • randomAccess

      public RandomAccess<Interval> 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<Interval>
      Parameters:
      interval - in which interval you intend to use the random access.
      Returns:
      random access sampler

    • size

      public long size()
      Description copied from interface: IterableRealInterval

      Returns the number of elements in this Function.

      Specified by:
      size in interface IterableRealInterval<Interval>
      Specified by:
      size in interface RandomAccessibleInterval<Interval>
      Returns:
      number of elements

    • getType

      public Interval getType()
      Description copied from interface: Typed
      Get an instance of T.

      It should not be assumed that the returned T instance is an independent copy. In particular, repeated calls to getType() may return the same instance.

      Specified by:
      getType in interface IterableRealInterval<Interval>
      Specified by:
      getType in interface Typed<Interval>
      Returns:
      an instance of T