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:

Iterable<C>, Dimensions, EuclideanSpace, Interval, IterableInterval<C>, IterableRealInterval<C>, RealInterval, Typed<C>, View

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

TODO

Field Summary

Fields

Modifier and Type	Field and Description
protected Supplier<? extends C>	convertedSupplier
protected 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 and Description
BiConvertedIterableInterval(IterableInterval<A> sourceA, IterableInterval<B> sourceB, BiConverter<? super A,? super B,? super C> converter, Supplier<? extends C> convertedSupplier) Creates a copy of c for conversion.
BiConvertedIterableInterval(IterableInterval<A> sourceA, IterableInterval<B> sourceB, Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier, Supplier<? extends C> convertedSupplier) Creates a copy of c for conversion.

Method Summary

Modifier and Type	Method and 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
Supplier<BiConverter<? super A,? super B,? super C>>	getConverterSupplier()
Supplier<? extends C>	getDestinationSupplier()
C	getDestinationType() Deprecated. Use getDestinationSupplier() instead.
C	getType() Get an instance of T.
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.IterableInterval

localizingSpliterator, spliterator

Methods inherited from interface net.imglib2.IterableRealInterval

firstElement, iterator, parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface net.imglib2.Interval

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

Methods inherited from interface net.imglib2.RealInterval

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

Methods inherited from interface net.imglib2.Dimensions

allPositive, allPositive, dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositive

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Field Detail

sourceIntervalB

protected final IterableInterval<B> sourceIntervalB

converterSupplier

protected final Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier

convertedSupplier

protected final Supplier<? extends C> convertedSupplier

Constructor Detail

BiConvertedIterableInterval

public BiConvertedIterableInterval(IterableInterval<A> sourceA,
                                   IterableInterval<B> sourceB,
                                   Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier,
                                   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,
                                   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.

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.

Returns:

fast localizing iterator

getDestinationType

@Deprecated
public C getDestinationType()

Deprecated. Use getDestinationSupplier() instead.

Returns:

an instance of the destination Type.

getDestinationSupplier

public Supplier<? extends C> getDestinationSupplier()

Returns:

the supplier of conversion destination instances

getType

public C getType()

Description copied from interface: IterableRealInterval

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.

The default implementation returns IterableRealInterval.firstElement(). Derived classes may choose different implementations for improved performance.

Returns:

an instance of T

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 Supplier<BiConverter<? super A,? super B,? super C>> getConverterSupplier()

Returns:

the supplier of converter instances