Class IntervalView<T>

All Implemented Interfaces:
Iterable<T>, Dimensions, EuclideanSpace, Interval, IterableInterval<T>, IterableRealInterval<T>, RandomAccessible<T>, RandomAccessibleInterval<T>, RealInterval, View

public class IntervalView<T> extends AbstractInterval implements RandomAccessibleInterval<T>, IterableInterval<T>, View
IntervalView is a view that puts Interval boundaries on its source RandomAccessible. IntervalView uses TransformBuilder to create efficient accessors. Usually an IntervalView is created through the Views.interval(RandomAccessible, Interval) method instead.
  • Field Details

  • Constructor Details

    • IntervalView

      public IntervalView(RandomAccessible<T> source, Interval interval)
      Create a view that defines an interval on a source. It is the callers responsibility to ensure that the source is defined in the specified interval.
      See Also:
    • IntervalView

      public IntervalView(RandomAccessible<T> source, long[] min, long[] max)
      Create a view that defines an interval on a source. It is the callers responsibility to ensure that the source is defined in the specified interval.
      Parameters:
      min - minimum coordinate of the interval.
      max - maximum coordinate of the interval.
      See Also:
  • Method Details

    • getSource

      public RandomAccessible<T> getSource()
      Gets the underlying source RandomAccessible.
      Returns:
      the source RandomAccessible.
    • 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
    • randomAccess

      public RandomAccess<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: 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
    • getFullViewIterableInterval

      protected IterableInterval<T> getFullViewIterableInterval()
    • size

      public long size()
      Description copied from interface: IterableRealInterval

      Returns the number of elements in this Function.

      Specified by:
      size in interface IterableRealInterval<T>
      Returns:
      number of elements
    • firstElement

      public T firstElement()
      Description copied from interface: IterableRealInterval
      Get the first element of this IterableRealInterval. This is a shortcut for cursor().next(). This can be used to create a new variable of type T using firstElement().createVariable(), which is useful in generic methods to store temporary results, e.g., a running sum over pixels in the IterableRealInterval.
      Specified by:
      firstElement in interface IterableRealInterval<T>
      Returns:
      the first element in iteration order.
    • iterationOrder

      public Object iterationOrder()
      Description copied from interface: IterableRealInterval
      Returns the iteration order of this IterableRealInterval. If the returned object equals (Object.equals(Object)) the iteration order of another IterableRealInterval f then they can be copied by synchronous iteration. That is, having an Iterator on this and another Iterator on f, moving both in synchrony will point both of them to corresponding locations in their source domain. In other words, this and f have the same iteration order and means and the same number of elements.
      Specified by:
      iterationOrder in interface IterableRealInterval<T>
      Returns:
      the iteration order of this IterableRealInterval.
      See Also:
    • iterator

      public Iterator<T> iterator()
      Specified by:
      iterator in interface Iterable<T>
    • cursor

      public Cursor<T> cursor()
      Description copied from interface: IterableRealInterval

      Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step. Localization is performed on demand.

      Use this where localization is required rarely/ not for each iteration.

      Specified by:
      cursor in interface IterableInterval<T>
      Specified by:
      cursor in interface IterableRealInterval<T>
      Returns:
      fast iterating iterator
    • localizingCursor

      public Cursor<T> localizingCursor()
      Description copied from interface: IterableRealInterval

      Returns a RealLocalizable Iterator that calculates its location at each iteration step. That is, localization is performed with optimal speed.

      Use this where localization is required often/ for each iteration.

      Specified by:
      localizingCursor in interface IterableInterval<T>
      Specified by:
      localizingCursor in interface IterableRealInterval<T>
      Returns:
      fast localizing iterator