Package net.imglib2.converter.read

Class BiConvertedRandomAccess<A,B,C>

java.lang.Object

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

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

All Implemented Interfaces:

EuclideanSpace, Localizable, Positionable, RandomAccess<C>, RealLocalizable, Sampler<C>, Typed<C>

public final class BiConvertedRandomAccess<A,B,C>
extends AbstractConvertedRandomAccess<A,C>

TODO

Field Summary

Fields

Modifier and Type	Field	Description
protected C	converted
protected java.util.function.Supplier<? extends C>	convertedSupplier
protected BiConverter<? super A,? super B,? super C>	converter
protected java.util.function.Supplier<BiConverter<? super A,? super B,? super C>>	converterSupplier
protected RandomAccess<B>	sourceB

Fields inherited from class net.imglib2.converter.AbstractConvertedRandomAccess

source

Constructor Summary

Constructors

Constructor	Description
BiConvertedRandomAccess(RandomAccess<A> sourceA, RandomAccess<B> sourceB, java.util.function.Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier, java.util.function.Supplier<? extends C> convertedSupplier)
BiConvertedRandomAccess(RandomAccess<A> sourceA, RandomAccess<B> sourceB, BiConverter<? super A,? super B,? super C> converter, java.util.function.Supplier<? extends C> convertedSupplier)

Method Summary

Modifier and Type	Method	Description
void	bck(int d)	Move by -1 in one dimension.
BiConvertedRandomAccess<A,B,C>	copy()
void	fwd(int d)	Move by 1 in one dimension.
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.
void	move(int[] distance)	Move the element relative to its current location using an int[] as distance vector.
void	move(int distance, int d)	Move the element in one dimension for some distance.
void	move(long[] distance)	Move the element relative to its current location using a long[] as distance vector.
void	move(long distance, int d)	Move the element in one dimension for some distance.
void	move(Localizable localizable)	Move the element relative to its current location using an Localizable as distance vector.
void	setPosition(int[] position)	Set the position of the element.
void	setPosition(int position, int d)	Set the position of the element for one dimension.
void	setPosition(long[] position)	Set the position of the element.
void	setPosition(long position, int d)	Set the position of the element for one dimension.
void	setPosition(Localizable localizable)	Place the element at the same location as a given Localizable

Methods inherited from class net.imglib2.converter.AbstractConvertedRandomAccess

getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, 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.Localizable

localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RandomAccess

copyRandomAccess, setPositionAndGet, setPositionAndGet, setPositionAndGet

Methods inherited from interface net.imglib2.RealLocalizable

positionAsDoubleArray, positionAsRealPoint

Field Detail

converterSupplier

protected final java.util.function.Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier

converter

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

sourceB

protected final RandomAccess<B> sourceB

convertedSupplier

protected final java.util.function.Supplier<? extends C> convertedSupplier

converted

protected final C converted

Constructor Detail

BiConvertedRandomAccess

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

BiConvertedRandomAccess

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

Method Detail

fwd

public void fwd(int d)

Description copied from interface: Positionable

Move by 1 in one dimension.

Specified by:

fwd in interface Positionable

Overrides:

fwd in class AbstractConvertedRandomAccess<A,C>

Parameters:

d - dimension

bck

public void bck(int d)

Description copied from interface: Positionable

Move by -1 in one dimension.

Specified by:

bck in interface Positionable

Overrides:

bck in class AbstractConvertedRandomAccess<A,C>

Parameters:

d - dimension

move

public void move(int distance,
                 int d)

Description copied from interface: Positionable

Move the element in one dimension for some distance.

Specified by:

move in interface Positionable

Overrides:

move in class AbstractConvertedRandomAccess<A,C>

Parameters:

distance - relative offset in dimension d

d - dimension

move

public void move(long distance,
                 int d)

Description copied from interface: Positionable

Move the element in one dimension for some distance.

Specified by:

move in interface Positionable

Overrides:

move in class AbstractConvertedRandomAccess<A,C>

Parameters:

distance - relative offset in dimension d

d - dimension

move

public void move(Localizable localizable)

Description copied from interface: Positionable

Move the element relative to its current location using an Localizable as distance vector.

Specified by:

move in interface Positionable

Overrides:

move in class AbstractConvertedRandomAccess<A,C>

Parameters:

localizable - relative offset, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()

move

public void move(int[] distance)

Description copied from interface: Positionable

Move the element relative to its current location using an int[] as distance vector.

Specified by:

move in interface Positionable

Overrides:

move in class AbstractConvertedRandomAccess<A,C>

Parameters:

distance - relative offset, length must be ≥ EuclideanSpace.numDimensions()

move

public void move(long[] distance)

Description copied from interface: Positionable

Move the element relative to its current location using a long[] as distance vector.

Specified by:

move in interface Positionable

Overrides:

move in class AbstractConvertedRandomAccess<A,C>

Parameters:

distance - relative offset, length must be ≥ EuclideanSpace.numDimensions()

setPosition

public void setPosition(Localizable localizable)

Description copied from interface: Positionable

Place the element at the same location as a given Localizable

Specified by:

setPosition in interface Positionable

Overrides:

setPosition in class AbstractConvertedRandomAccess<A,C>

Parameters:

localizable - absolute position, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()

setPosition

public void setPosition(int[] position)

Description copied from interface: Positionable

Set the position of the element.

Specified by:

setPosition in interface Positionable

Overrides:

setPosition in class AbstractConvertedRandomAccess<A,C>

Parameters:

position - absolute position, length must be ≥ EuclideanSpace.numDimensions()

setPosition

public void setPosition(long[] position)

Description copied from interface: Positionable

Set the position of the element.

Specified by:

setPosition in interface Positionable

Overrides:

setPosition in class AbstractConvertedRandomAccess<A,C>

Parameters:

position - absolute position, length must be ≥ EuclideanSpace.numDimensions()

setPosition

public void setPosition(int position,
                        int d)

Description copied from interface: Positionable

Set the position of the element for one dimension.

Specified by:

setPosition in interface Positionable

Overrides:

setPosition in class AbstractConvertedRandomAccess<A,C>

Parameters:

position - absolute position in dimension d

d - dimension

setPosition

public void setPosition(long position,
                        int d)

Description copied from interface: Positionable

Set the position of the element for one dimension.

Specified by:

setPosition in interface Positionable

Overrides:

setPosition in class AbstractConvertedRandomAccess<A,C>

Parameters:

position - absolute position in dimension d

d - dimension

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

copy

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

Specified by:

copy in interface RandomAccess<A>

Specified by:

copy in interface Sampler<A>

Specified by:

copy in class AbstractConvertedRandomAccess<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)