Package net.imglib2.converter.read

Class ConvertedRandomAccessibleInterval<A,​B>

    • Field Detail

      • converterSupplier

        protected final java.util.function.Supplier<Converter<? super A,​? super B>> converterSupplier

      • convertedSupplier

        protected final java.util.function.Supplier<? extends B> convertedSupplier

    • Constructor Detail

      • ConvertedRandomAccessibleInterval

        public ConvertedRandomAccessibleInterval​(RandomAccessibleInterval<A> source,
                                         java.util.function.Supplier<Converter<? super A,​? super B>> converterSupplier,
                                         java.util.function.Supplier<? extends B> convertedSupplier)

      • ConvertedRandomAccessibleInterval

        public ConvertedRandomAccessibleInterval​(RandomAccessibleInterval<A> source,
                                         Converter<? super A,​? super B> converter,
                                         java.util.function.Supplier<? extends B> convertedSupplier)

    • Method Detail

      • randomAccess

        public ConvertedRandomAccess<A,​B> 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.
        Returns:
        random access sampler

      • randomAccess

        public ConvertedRandomAccess<A,​B> 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.

        Parameters:
        interval - in which interval you intend to use the random access.
        Returns:
        random access sampler

      • getDestinationType

        @Deprecated
public B getDestinationType()
        Deprecated.
        Use getDestinationSupplier() instead.
        Returns:
        an instance of the destination Type.

      • getDestinationSupplier

        public java.util.function.Supplier<? extends B> getDestinationSupplier()
        Returns:
        the supplier of conversion destination instances

      • getConverterSupplier

        public java.util.function.Supplier<Converter<? super A,​? super B>> getConverterSupplier()
        Returns:
        the supplier of converter instances

      • getType

        public B 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.

        Returns:
        an instance of T

      • cursor

        public Cursor<B> 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.

        Returns:
        fast iterating iterator

      • localizingCursor

        public Cursor<B> 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.

        Returns:
        fast localizing iterator