Package net.imglib2.converter.read
Class BiConvertedRandomAccessible<A,B,C>
- java.lang.Object
-
- net.imglib2.converter.AbstractConvertedRandomAccessible<A,C>
-
- net.imglib2.converter.read.BiConvertedRandomAccessible<A,B,C>
-
- All Implemented Interfaces:
EuclideanSpace,RandomAccessible<C>,Typed<C>,View
public class BiConvertedRandomAccessible<A,B,C> extends AbstractConvertedRandomAccessible<A,C>
TODO
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.function.Supplier<? extends C>convertedSupplierprotected java.util.function.Supplier<BiConverter<? super A,? super B,? super C>>converterSupplierprotected RandomAccessible<B>sourceB-
Fields inherited from class net.imglib2.converter.AbstractConvertedRandomAccessible
source
-
-
Constructor Summary
Constructors Constructor Description BiConvertedRandomAccessible(RandomAccessible<A> sourceA, RandomAccessible<B> sourceB, java.util.function.Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier, java.util.function.Supplier<? extends C> convertedSupplier)BiConvertedRandomAccessible(RandomAccessible<A> sourceA, RandomAccessible<B> sourceB, BiConverter<? super A,? super B,? super C> converter, java.util.function.Supplier<? extends C> convertedSupplier)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BiConverter<? super A,? super B,? super C>getConverter()Deprecated.UsegetConverterSupplier()insteadjava.util.function.Supplier<BiConverter<? super A,? super B,? super C>>getConverterSupplier()java.util.function.Supplier<? extends C>getDestinationSupplier()CgetDestinationType()Deprecated.UsegetDestinationSupplier()instead.CgetType()Get an instance ofT.BiConvertedRandomAccess<A,B,C>randomAccess()Create a random access sampler for integer coordinates.BiConvertedRandomAccess<A,B,C>randomAccess(Interval interval)Create a random access sampler for integer coordinates.-
Methods inherited from class net.imglib2.converter.AbstractConvertedRandomAccessible
getSource, numDimensions
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.imglib2.RandomAccessible
getAt, getAt, getAt
-
-
-
-
Field Detail
-
sourceB
protected final RandomAccessible<B> sourceB
-
converterSupplier
protected final java.util.function.Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier
-
convertedSupplier
protected final java.util.function.Supplier<? extends C> convertedSupplier
-
-
Constructor Detail
-
BiConvertedRandomAccessible
public BiConvertedRandomAccessible(RandomAccessible<A> sourceA, RandomAccessible<B> sourceB, java.util.function.Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier, java.util.function.Supplier<? extends C> convertedSupplier)
-
BiConvertedRandomAccessible
public BiConvertedRandomAccessible(RandomAccessible<A> sourceA, RandomAccessible<B> sourceB, BiConverter<? super A,? super B,? super C> converter, java.util.function.Supplier<? extends C> convertedSupplier)
-
-
Method Detail
-
randomAccess
public BiConvertedRandomAccess<A,B,C> randomAccess()
Description copied from interface:RandomAccessibleCreate 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 (theirInterval), soRandomAccessible.randomAccess()is only guaranteed to cover this finite domain. This may lead to unexpected results when usingViews. In the following codeRandomAccessible<T> extended = Views.extendBorder( img ) RandomAccessibleInterval<T> cropped = Views.interval( extended, img ); RandomAccess<T> a1 = extended.randomAccess(); RandomAccess<T> a2 = cropped.randomAccess();
Theaccessa1on the extended image is valid everywhere. However, somewhat counter-intuitively, theaccessa2on the extended and cropped image is only valid on the intervalimgto which the extended image was cropped. The access is only required to cover this interval, because it is the domain of the cropped image.Viewsattempts 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 theRandomAccessibleInterval, and you know that theRandomAccessibleIntervalis actually defined beyond its interval boundaries, then use theRandomAccessible.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:
randomAccessin interfaceRandomAccessible<A>- Specified by:
randomAccessin classAbstractConvertedRandomAccessible<A,C>- Returns:
- random access sampler
-
randomAccess
public BiConvertedRandomAccess<A,B,C> randomAccess(Interval interval)
Description copied from interface:RandomAccessibleCreate 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:
randomAccessin interfaceRandomAccessible<A>- Specified by:
randomAccessin classAbstractConvertedRandomAccessible<A,C>- Parameters:
interval- in which interval you intend to use the random access.- Returns:
- random access sampler
-
getDestinationType
@Deprecated public C getDestinationType()
Deprecated.UsegetDestinationSupplier()instead.- Returns:
- an instance of the destination
Type.
-
getDestinationSupplier
public java.util.function.Supplier<? extends C> getDestinationSupplier()
- Returns:
- the supplier of conversion destination instances
-
getConverter
@Deprecated public BiConverter<? super A,? super B,? super C> getConverter()
Deprecated.UsegetConverterSupplier()insteadReturns an instance of theBiConverter. If theBiConvertedRandomAccessiblewas created with aBiConverterinstead of aSupplier, then the returned converter will be this instance.- Returns:
-
getConverterSupplier
public java.util.function.Supplier<BiConverter<? super A,? super B,? super C>> getConverterSupplier()
- Returns:
- the supplier of converter instances
-
-