Class RandomAccessiblePair.RandomAccess

java.lang.Object

net.imglib2.view.RandomAccessiblePair.RandomAccess

All Implemented Interfaces:

EuclideanSpace, Localizable, Positionable, RandomAccess<Pair<A,B>>, RealLocalizable, Sampler<Pair<A,B>>, Typed<Pair<A,B>>, Pair<A,B>

Enclosing class:

RandomAccessiblePair<A,B>

public class RandomAccessiblePair.RandomAccess
extends Object
implements Pair<A,B>, RandomAccess<Pair<A,B>>

Field Summary

Fields

Modifier and Type	Field	Description
protected final RandomAccess<A>	a
protected final RandomAccess<B>	b

Constructor Summary

Constructors

Constructor	Description
RandomAccess()

Method Summary

Modifier and Type	Method	Description
void	bck(int d)	Move by -1 in one dimension.
RandomAccessiblePair<A,B>.RandomAccess	copy()
void	fwd(int d)	Move by 1 in one dimension.
RandomAccessiblePair<A,B>.RandomAccess	get()	Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
A	getA()
B	getB()
double	getDoublePosition(int d)	Return the current position in a given dimension.
float	getFloatPosition(int d)	Return the current position in a given dimension.
int	getIntPosition(int d)	Return the current position in a given dimension.
long	getLongPosition(int d)	Return the current position in a given dimension.
RandomAccessiblePair<A,B>.RandomAccess	getType()	Get an instance of T.
void	localize(double[] position)	Write the current position into the passed array.
void	localize(float[] position)	Write the current position into the passed array.
void	localize(int[] position)	Write the current position into the passed array.
void	localize(long[] position)	Write the current position into the passed array.
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.
int	numDimensions()	Gets the space's number of dimensions.
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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Localizable

localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface RandomAccess

copyRandomAccess, setPositionAndGet, setPositionAndGet, setPositionAndGet

Methods inherited from interface RealLocalizable

positionAsDoubleArray, positionAsRealPoint

Field Details

a

protected final RandomAccess<A> a

b

protected final RandomAccess<B> b

Constructor Details

RandomAccess

public RandomAccess()

Method Details

getA

public A getA()

Specified by:

getA in interface Pair<A,B>

getB

public B getB()

Specified by:

getB in interface Pair<A,B>

localize

public void localize(int[] position)

Description copied from interface: Localizable

Write the current position into the passed array.

Specified by:

localize in interface Localizable

Parameters:

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

localize

public void localize(long[] position)

Description copied from interface: Localizable

Write the current position into the passed array.

Specified by:

localize in interface Localizable

Parameters:

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

getIntPosition

public int getIntPosition(int d)

Description copied from interface: Localizable

Return the current position in a given dimension.

Specified by:

getIntPosition in interface Localizable

Parameters:

d - dimension

Returns:

dimension of current position

getLongPosition

public long getLongPosition(int d)

Description copied from interface: Localizable

Return the current position in a given dimension.

Specified by:

getLongPosition in interface Localizable

Parameters:

d - dimension

Returns:

dimension of current position

localize

public void localize(float[] position)

Description copied from interface: RealLocalizable

Write the current position into the passed array.

Specified by:

localize in interface RealLocalizable

Parameters:

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

localize

public void localize(double[] position)

Description copied from interface: RealLocalizable

Write the current position into the passed array.

Specified by:

localize in interface RealLocalizable

Parameters:

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

getFloatPosition

public float getFloatPosition(int d)

Description copied from interface: RealLocalizable

Return the current position in a given dimension.

Specified by:

getFloatPosition in interface Localizable

Specified by:

getFloatPosition in interface RealLocalizable

Parameters:

d - dimension

Returns:

dimension of current position

getDoublePosition

public double getDoublePosition(int d)

Description copied from interface: RealLocalizable

Return the current position in a given dimension.

Specified by:

getDoublePosition in interface Localizable

Specified by:

getDoublePosition in interface RealLocalizable

Parameters:

d - dimension

Returns:

dimension of current position

numDimensions

public int numDimensions()

Description copied from interface: EuclideanSpace

Gets the space's number of dimensions.

Specified by:

numDimensions in interface EuclideanSpace

fwd

public void fwd(int d)

Description copied from interface: Positionable

Move by 1 in one dimension.

Specified by:

fwd in interface Positionable

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

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

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

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

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

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

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

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

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

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

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

Parameters:

position - absolute position in dimension d

d - dimension

get

public RandomAccessiblePair<A,B>.RandomAccess 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.

Specified by:

get in interface Sampler<Pair<A,B>>

getType

public RandomAccessiblePair<A,B>.RandomAccess 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.

Specified by:

getType in interface Sampler<Pair<A,B>>

Specified by:

getType in interface Typed<Pair<A,B>>

Returns:

an instance of T

copy

public RandomAccessiblePair<A,B>.RandomAccess copy()

Specified by:

copy in interface RandomAccess<Pair<A,B>>

Specified by:

copy in interface Sampler<Pair<A,B>>

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)