AbstractConvertedRandomAccess (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.converter.AbstractConvertedRandomAccess<A,B>

All Implemented Interfaces:

EuclideanSpace, Localizable, Positionable, RandomAccess, RealLocalizable, Sampler

Direct Known Subclasses:

BiConvertedRandomAccess, BoundaryRandomAccess4, BoundaryRandomAccess8, ConvertedRandomAccess, LabelingConvertedRandomAccess, ScaleAsFunctionOfPosition.ScaledRandomAccess, WriteConvertedRandomAccess
```
public abstract class AbstractConvertedRandomAccess<A,B>
extends Object
implements RandomAccess
```
TODO

Field Summary

Fields
Modifier and Type Field and Description

protected RandomAccess<A> source

Fields
Modifier and Type	Field and Description
`protected RandomAccess<A>`	`source`

Constructor Summary

Constructors
Constructor and Description

AbstractConvertedRandomAccess(RandomAccess<A> source)

Constructors
Constructor and Description
`AbstractConvertedRandomAccess(RandomAccess<A> source)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bck(int d)` Move by -1 in one dimension.
`abstract AbstractConvertedRandomAccess<A,B>`	`copy()`
`AbstractConvertedRandomAccess<A,B>`	`copyRandomAccess()`
`void`	`fwd(int d)` Move by 1 in one dimension.
`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.
`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(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.
`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(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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.imglib2.RandomAccess
setPositionAndGet, setPositionAndGet, setPositionAndGet

Methods inherited from interface net.imglib2.Localizable
localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealLocalizable
localize, positionAsDoubleArray, positionAsRealPoint

Methods inherited from interface net.imglib2.Sampler
get

- Field Detail
 - source
```
protected final RandomAccess<A> source
```
- Constructor Detail
 - AbstractConvertedRandomAccess
```
public AbstractConvertedRandomAccess(RandomAccess<A> source)
```
- Method Detail
 - 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
 - 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
 - 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
 - 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
 - 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
 - copy
```
public abstract AbstractConvertedRandomAccess<A,B> copy()
```
 Specified by:
 
 copy in interface Sampler
 
 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)
 - copyRandomAccess
```
public AbstractConvertedRandomAccess<A,B> copyRandomAccess()
```
 Specified by:
 
 copyRandomAccess in interface RandomAccess

Class AbstractConvertedRandomAccess<A,B>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.RandomAccess

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Methods inherited from interface net.imglib2.Sampler

Field Detail

source

Constructor Detail

AbstractConvertedRandomAccess

Method Detail

localize

localize

getIntPosition

getLongPosition

localize

localize

getFloatPosition

getDoublePosition

numDimensions

fwd

bck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

copy

copyRandomAccess