Package net.imglib2.converter.read

Class BiConvertedIterableRealInterval<A,B,C>

java.lang.Object

net.imglib2.AbstractWrappedRealInterval<IterableRealInterval<A>>

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

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

All Implemented Interfaces:

java.lang.Iterable<C>, EuclideanSpace, IterableRealInterval<C>, RealInterval, Typed<C>, View

public class BiConvertedIterableRealInterval<A,B,C>
extends AbstractConvertedIterableRealInterval<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 IterableRealInterval<B>	sourceIntervalB

Fields inherited from class net.imglib2.AbstractWrappedRealInterval

sourceInterval

Constructor Summary

Constructors

Constructor	Description
BiConvertedIterableRealInterval(IterableRealInterval<A> sourceA, IterableRealInterval<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.
BiConvertedIterableRealInterval(IterableRealInterval<A> sourceA, IterableRealInterval<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
BiConvertedRealCursor<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.
C	getType()	Get an instance of T.
BiConvertedRealCursor<A,B,C>	localizingCursor()	Returns a RealLocalizable Iterator that calculates its location at each iteration step.

Methods inherited from class net.imglib2.converter.AbstractConvertedIterableRealInterval

iterationOrder, size

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

numDimensions

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface net.imglib2.IterableRealInterval

firstElement, iterator, localizingSpliterator, parallelStream, spliterator, stream

Methods inherited from interface net.imglib2.RealInterval

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

Field Detail

sourceIntervalB

protected final IterableRealInterval<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

BiConvertedIterableRealInterval

public BiConvertedIterableRealInterval(IterableRealInterval<A> sourceA,
                                       IterableRealInterval<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 -

sourceB -

converterSupplier -

convertedSupplier -

BiConvertedIterableRealInterval

public BiConvertedIterableRealInterval(IterableRealInterval<A> sourceA,
                                       IterableRealInterval<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:

converter -

Method Detail

cursor

public BiConvertedRealCursor<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 IterableRealInterval<A>

Specified by:

cursor in class AbstractConvertedIterableRealInterval<A,C>

Returns:

fast iterating iterator

localizingCursor

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

Specified by:

localizingCursor in interface IterableRealInterval<A>

Specified by:

localizingCursor in class AbstractConvertedIterableRealInterval<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

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 BiConvertedIterableRealInterval 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