net.imglib2.converter.read

Class BiConvertedRealRandomAccess<A,B,C>

java.lang.Object

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

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

All Implemented Interfaces:

EuclideanSpace, Positionable, RealLocalizable, RealPositionable, RealRandomAccess<C>, Sampler<C>, Typed<C>

public final class BiConvertedRealRandomAccess<A,B,C>
extends AbstractConvertedRealRandomAccess<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 RealRandomAccess<B>	sourceB

Fields inherited from class net.imglib2.converter.AbstractConvertedRealRandomAccess

source

Constructor Summary

Constructors

Constructor and Description
BiConvertedRealRandomAccess(RealRandomAccess<A> sourceA, RealRandomAccess<B> sourceB, BiConverter<? super A,? super B,? super C> converter, Supplier<? extends C> convertedSupplier)
BiConvertedRealRandomAccess(RealRandomAccess<A> sourceA, RealRandomAccess<B> sourceB, Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier, Supplier<? extends C> convertedSupplier)

Method Summary

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

Methods inherited from class net.imglib2.converter.AbstractConvertedRealRandomAccess

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

copyRealRandomAccess, setPositionAndGet, setPositionAndGet, setPositionAndGet

Methods inherited from interface net.imglib2.RealLocalizable

localize, positionAsDoubleArray, positionAsRealPoint

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 RealRandomAccess<B> sourceB

convertedSupplier

protected final Supplier<? extends C> convertedSupplier

converted

protected final C converted

Constructor Detail

BiConvertedRealRandomAccess

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

BiConvertedRealRandomAccess

public BiConvertedRealRandomAccess(RealRandomAccess<A> sourceA,
                                   RealRandomAccess<B> sourceB,
                                   BiConverter<? super A,? super B,? super C> converter,
                                   Supplier<? extends C> 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

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 AbstractConvertedRealRandomAccess<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 AbstractConvertedRealRandomAccess<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 AbstractConvertedRealRandomAccess<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 AbstractConvertedRealRandomAccess<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 AbstractConvertedRealRandomAccess<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 AbstractConvertedRealRandomAccess<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 AbstractConvertedRealRandomAccess<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 AbstractConvertedRealRandomAccess<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 AbstractConvertedRealRandomAccess<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 AbstractConvertedRealRandomAccess<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 AbstractConvertedRealRandomAccess<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 AbstractConvertedRealRandomAccess<A,C>

Parameters:

position - absolute position in dimension d

d - dimension

move

public void move(float distance,
                 int d)

Description copied from interface: RealPositionable

Move the element in one dimension for some distance.

Specified by:

move in interface RealPositionable

Overrides:

move in class AbstractConvertedRealRandomAccess<A,C>

move

public void move(double distance,
                 int d)

Description copied from interface: RealPositionable

Move the element in one dimension for some distance.

Specified by:

move in interface RealPositionable

Overrides:

move in class AbstractConvertedRealRandomAccess<A,C>

move

public void move(RealLocalizable localizable)

Description copied from interface: RealPositionable

Move the element relative to its current location using a RealLocalizable as distance vector.

Specified by:

move in interface RealPositionable

Overrides:

move in class AbstractConvertedRealRandomAccess<A,C>

Parameters:

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

move

public void move(float[] distance)

Description copied from interface: RealPositionable

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

Specified by:

move in interface RealPositionable

Overrides:

move in class AbstractConvertedRealRandomAccess<A,C>

move

public void move(double[] distance)

Description copied from interface: RealPositionable

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

Specified by:

move in interface RealPositionable

Overrides:

move in class AbstractConvertedRealRandomAccess<A,C>

setPosition

public void setPosition(RealLocalizable localizable)

Description copied from interface: RealPositionable

Place the element at the same location as a given RealLocalizable

Specified by:

setPosition in interface RealPositionable

Overrides:

setPosition in class AbstractConvertedRealRandomAccess<A,C>

Parameters:

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

setPosition

public void setPosition(float[] position)

Description copied from interface: RealPositionable

Set the position of the element.

Specified by:

setPosition in interface RealPositionable

Overrides:

setPosition in class AbstractConvertedRealRandomAccess<A,C>

Parameters:

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

setPosition

public void setPosition(double[] position)

Description copied from interface: RealPositionable

Set the position of the element.

Specified by:

setPosition in interface RealPositionable

Overrides:

setPosition in class AbstractConvertedRealRandomAccess<A,C>

Parameters:

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

setPosition

public void setPosition(float position,
                        int d)

Description copied from interface: RealPositionable

Set the position of the element for one dimension.

Specified by:

setPosition in interface RealPositionable

Overrides:

setPosition in class AbstractConvertedRealRandomAccess<A,C>

setPosition

public void setPosition(double position,
                        int d)

Description copied from interface: RealPositionable

Set the position of the element for one dimension.

Specified by:

setPosition in interface RealPositionable

Overrides:

setPosition in class AbstractConvertedRealRandomAccess<A,C>

copy

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

Specified by:

copy in interface RealRandomAccess<C>

Specified by:

copy in interface Sampler<C>

Specified by:

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