Package net.imglib2.converter.read

Class BiConvertedIterableInterval<A,B,C>

java.lang.Object

net.imglib2.AbstractWrappedRealInterval<I>

net.imglib2.AbstractWrappedInterval<IterableInterval<A>>

net.imglib2.converter.AbstractConvertedIterableInterval<A,C>

net.imglib2.converter.read.BiConvertedIterableInterval<A,B,C>

All Implemented Interfaces:

java.lang.Iterable<C>, Dimensions, EuclideanSpace, Interval, IterableInterval<C>, IterableRealInterval<C>, RealInterval, View

public class BiConvertedIterableInterval<A,B,C>
extends AbstractConvertedIterableInterval<A,C>

TODO

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.function.Supplier<? extends C>	convertedSupplier
protected java.util.function.Supplier<BiConverter<? super A,? super B,? super C>>	converterSupplier
protected IterableInterval<B>	sourceIntervalB

Fields inherited from class net.imglib2.AbstractWrappedRealInterval

sourceInterval

Constructor Summary

Constructors

Constructor	Description
BiConvertedIterableInterval(IterableInterval<A> sourceA, IterableInterval<B> sourceB, java.util.function.Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier, java.util.function.Supplier<? extends C> convertedSupplier)	Creates a copy of c for conversion.
BiConvertedIterableInterval(IterableInterval<A> sourceA, IterableInterval<B> sourceB, BiConverter<? super A,? super B,? super C> converter, java.util.function.Supplier<? extends C> convertedSupplier)	Creates a copy of c for conversion.

Method Summary

Modifier and Type	Method	Description
BiConvertedCursor<A,B,C>	cursor()	Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step.
BiConverter<? super A,? super B,? super C>	getConverter()	Deprecated. Use getConverterSupplier() instead
java.util.function.Supplier<BiConverter<? super A,? super B,? super C>>	getConverterSupplier()
java.util.function.Supplier<? extends C>	getDestinationSupplier()
C	getDestinationType()	Deprecated. Use getDestinationSupplier() instead.
BiConvertedCursor<A,B,C>	localizingCursor()	Creates a localizing Cursor for sourceA only because this will be used for localization.

Methods inherited from class net.imglib2.converter.AbstractConvertedIterableInterval

iterationOrder, size

Methods inherited from class net.imglib2.AbstractWrappedInterval

dimension, dimensions, max, max, max, min, min, min

Methods inherited from class net.imglib2.AbstractWrappedRealInterval

getSource, numDimensions, realMax, realMax, realMax, realMin, realMin, realMin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.imglib2.Dimensions

dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Methods inherited from interface net.imglib2.Interval

dimension, max, max, max, maxAsLongArray, maxAsPoint, min, min, min, minAsLongArray, minAsPoint, realMax, realMin

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.imglib2.IterableRealInterval

firstElement, iterator

Methods inherited from interface net.imglib2.RealInterval

maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMin

Field Detail

sourceIntervalB

protected final IterableInterval<B> sourceIntervalB

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

BiConvertedIterableInterval

public BiConvertedIterableInterval(IterableInterval<A> sourceA,
                                   IterableInterval<B> sourceB,
                                   java.util.function.Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier,
                                   java.util.function.Supplier<? extends C> convertedSupplier)

Creates a copy of c for conversion.

Parameters:

sourceA - this IterableInterval is used for all Interval related requests. When using Intervals with different sizes, make sure that this is the smaller Interval.

sourceB -

converterSupplier -

convertedSupplier -

BiConvertedIterableInterval

public BiConvertedIterableInterval(IterableInterval<A> sourceA,
                                   IterableInterval<B> sourceB,
                                   BiConverter<? super A,? super B,? super C> converter,
                                   java.util.function.Supplier<? extends C> convertedSupplier)

Creates a copy of c for conversion.

Parameters:

sourceA - this IterableInterval is used for all Interval related requests. When using Intervals with different sizes, make sure that this is the smaller Interval.

sourceB -

converter -

convertedSupplier -

Method Detail

cursor

public BiConvertedCursor<A,B,C> 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<A>

Specified by:

cursor in interface IterableRealInterval<A>

Specified by:

cursor in class AbstractConvertedIterableInterval<A,C>

Returns:

fast iterating iterator

localizingCursor

public BiConvertedCursor<A,B,C> localizingCursor()

Creates a localizing Cursor for sourceA only because this will be used for localization. Make sure that sourceA is the IterableInterval that creates the Cursor that localizes more efficiently.

Specified by:

localizingCursor in interface IterableInterval<A>

Specified by:

localizingCursor in interface IterableRealInterval<A>

Specified by:

localizingCursor in class AbstractConvertedIterableInterval<A,C>

Returns:

fast localizing iterator

getDestinationType

@Deprecated
public C getDestinationType()

Deprecated.

Use getDestinationSupplier() 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.

Use getConverterSupplier() instead

Returns an instance of the BiConverter. If the BiConvertedIterableInterval was created with a BiConverter instead of a Supplier, 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