Package net.imglib2.view

Class IntervalView<T>

    • Constructor Detail

      • 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:
        Views.interval(RandomAccessible, Interval)

    • Method Detail

      • 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()

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

      • iterator

        public java.util.Iterator<T> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<T>
        Specified by:
        iterator in interface IterableRealInterval<T>

      • spliterator

        public LocalizableSpliterator<T> spliterator()
        Description copied from interface: IterableInterval
        Creates a LocalizableSpliterator over the elements of this IterableInterval. The returned Spliterator iterates with optimal speed without calculating the location at each iteration step. Localization is performed on demand.

        The default implementation wraps a Cursor on the interval. The created Spliterator reports Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED and Spliterator.NONNULL.

        Specified by:
        spliterator in interface java.lang.Iterable<T>
        Specified by:
        spliterator in interface IterableInterval<T>
        Specified by:
        spliterator in interface IterableRealInterval<T>

      • getType

        public T 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<T>
        Specified by:
        getType in interface Typed<T>
        Returns:
        an instance of T