net.imglib2.converter.read

Class BiConvertedRealCursor<A,B,C>

java.lang.Object

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

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

All Implemented Interfaces:

Iterator<C>, EuclideanSpace, RealCursor<C>, RealLocalizable, Sampler<C>, Typed<C>

public class BiConvertedRealCursor<A,B,C>
extends AbstractConvertedRealCursor<A,C>

TODO

Field Summary

Fields

Modifier and Type	Field and Description
protected C	converted
protected Supplier<? extends C>	convertedSupplier
protected BiConverter<? super A,? super B,? super C>	converter
protected Supplier<BiConverter<? super A,? super B,? super C>>	converterSupplier
protected RealCursor<B>	sourceB

Fields inherited from class net.imglib2.converter.AbstractConvertedRealCursor

source

Constructor Summary

Constructors

Constructor and Description
BiConvertedRealCursor(RealCursor<A> sourceA, RealCursor<B> sourceB, BiConverter<? super A,? super B,? super C> converter, Supplier<? extends C> convertedSupplier) Creates a copy of c for conversion that can be accessed through get().
BiConvertedRealCursor(RealCursor<A> sourceA, RealCursor<B> sourceB, Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier, Supplier<? extends C> convertedSupplier) Creates a copy of c for conversion that can be accessed through get().

Method Summary

Modifier and Type	Method and Description
BiConvertedRealCursor<A,B,C>	copy()
void	fwd() Move forward.
C	get() Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
C	getType() Get an instance of T.
boolean	hasNext() The correct logic would be to return sourceA.hasNext() && sourceB.hasNext() but we test only sourceA for efficiency.
void	jumpFwd(long steps) Move steps × forward.
void	remove()
void	reset() Reset the Iterator, that is put it to where it would be if newly created.

Methods inherited from class net.imglib2.converter.AbstractConvertedRealCursor

getDoublePosition, getFloatPosition, localize, localize, 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.RealCursor

copyCursor, next

Methods inherited from interface net.imglib2.RealLocalizable

localize, positionAsDoubleArray, positionAsRealPoint

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

converterSupplier

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

converter

protected final BiConverter<? super A,? super B,? super C> converter

sourceB

protected final RealCursor<B> sourceB

convertedSupplier

protected final Supplier<? extends C> convertedSupplier

converted

protected final C converted

Constructor Detail

BiConvertedRealCursor

public BiConvertedRealCursor(RealCursor<A> sourceA,
                             RealCursor<B> sourceB,
                             Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier,
                             Supplier<? extends C> convertedSupplier)

Creates a copy of c for conversion that can be accessed through get().

Parameters:

sourceA -

sourceB -

converterSupplier -

convertedSupplier -

BiConvertedRealCursor

public BiConvertedRealCursor(RealCursor<A> sourceA,
                             RealCursor<B> sourceB,
                             BiConverter<? super A,? super B,? super C> converter,
                             Supplier<? extends C> convertedSupplier)

Creates a copy of c for conversion that can be accessed through get().

Parameters:

sourceA -

sourceB -

converter -

convertedSupplier -

Method Detail

get

public C get()

Description copied from interface: Sampler

Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.

getType

public C 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

jumpFwd

public void jumpFwd(long steps)

Description copied from interface: Iterator

Move steps × forward.

Highly recommended to override this with a more efficient version.

Overrides:

jumpFwd in class AbstractConvertedRealCursor<A,C>

Parameters:

steps - number of steps to move forward

fwd

public void fwd()

Description copied from interface: Iterator

Move forward.

Overrides:

fwd in class AbstractConvertedRealCursor<A,C>

reset

public void reset()

Description copied from interface: Iterator

Reset the Iterator, that is put it to where it would be if newly created.

Overrides:

reset in class AbstractConvertedRealCursor<A,C>

hasNext

public boolean hasNext()

The correct logic would be to return sourceA.hasNext() && sourceB.hasNext() but we test only sourceA for efficiency. Make sure that sourceA is the smaller IterableInterval.

Specified by:

hasNext in interface Iterator<C>

Overrides:

hasNext in class AbstractConvertedRealCursor<A,C>

Returns:

true, if there is another step forward is possible, otherwise false

remove

public void remove()

Specified by:

remove in interface Iterator<C>

Overrides:

remove in class AbstractConvertedRealCursor<A,C>

copy

public BiConvertedRealCursor<A,B,C> copy()

Specified by:

copy in interface RealCursor<C>

Specified by:

copy in interface Sampler<C>

Specified by:

copy in class AbstractConvertedRealCursor<A,C>

Returns:

- A new Sampler in the same state accessing the same values. It does NOT copy T, just the state of the Sampler. Otherwise use T.copy() if available. Sampler.copy().get() == Sampler.get(), i.e. both hold the same value, not necessarily the same instance (this is the case for an ArrayCursor for example)