BiConvertedRandomAccess (ImgLib2 Javadocs 0-SNAPSHOT API)

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>
```
public final class BiConvertedRandomAccess<A,B,C extends Type<C>>
extends AbstractConvertedRandomAccess<A,C>
```
TODO

Field Summary

Fields
Modifier and Type	Field and Description
`protected C`	`converted`
`protected BiConverter<? super A,? super B,? super C>`	`converter`
`protected 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 and Description
`BiConvertedRandomAccess(RandomAccess<A> sourceA, RandomAccess<B> sourceB, BiConverter<? super A,? super B,? super C> converter, C c)`
`BiConvertedRandomAccess(RandomAccess<A> sourceA, RandomAccess<B> sourceB, Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier, C c)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`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`	`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 net.imglib2.converter.AbstractConvertedRandomAccess
copyRandomAccess, 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.RandomAccess
setPositionAndGet, setPositionAndGet, setPositionAndGet

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

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

- Field Detail
  - converterSupplier
```
protected final Supplier<BiConverter<? super A,? super B,? super C extends Type<C>>> converterSupplier
```
  - converter
```
protected final BiConverter<? super A,? super B,? super C extends Type<C>> converter
```
  - sourceB
```
protected final RandomAccess<B> sourceB
```
  - converted
```
protected final C extends Type<C> converted
```
- Constructor Detail
  - BiConvertedRandomAccess
```
public BiConvertedRandomAccess(RandomAccess<A> sourceA,
                               RandomAccess<B> sourceB,
                               Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier,
                               C c)
```
  - BiConvertedRandomAccess
```
public BiConvertedRandomAccess(RandomAccess<A> sourceA,
                               RandomAccess<B> sourceB,
                               BiConverter<? super A,? super B,? super C> converter,
                               C c)
```
- 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 extends Type<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 extends Type<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 extends Type<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 extends Type<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 extends Type<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 extends Type<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 extends Type<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 extends Type<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 extends Type<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 extends Type<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 extends Type<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 extends Type<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.
  - copy
```
public BiConvertedRandomAccess<A,B,C> copy()
```
    Specified by:
    
    copy in interface Sampler<C extends Type<C>>
    
    Specified by:
    
    copy in class AbstractConvertedRandomAccess<A,C extends Type<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)

Class BiConvertedRandomAccess<A,B,C extends Type<C>>

Field Summary

Fields inherited from class net.imglib2.converter.AbstractConvertedRandomAccess

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.converter.AbstractConvertedRandomAccess

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

Field Detail

converterSupplier

converter

sourceB

converted

Constructor Detail

BiConvertedRandomAccess

BiConvertedRandomAccess

Method Detail

fwd

bck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

get

copy