BiConvertedRealRandomAccess (ImgLib2 Javadocs 0-SNAPSHOT API)

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>
```
public final class BiConvertedRealRandomAccess<A,B,C extends Type<C>>
extends AbstractConvertedRealRandomAccess<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 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, C c)`
`BiConvertedRealRandomAccess(RealRandomAccess<A> sourceA, RealRandomAccess<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.
`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.
`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
copyRealRandomAccess, 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
setPositionAndGet, setPositionAndGet, setPositionAndGet

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

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

Field Summary

Fields inherited from class net.imglib2.converter.AbstractConvertedRealRandomAccess

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.converter.AbstractConvertedRealRandomAccess

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.RealRandomAccess

Methods inherited from interface net.imglib2.RealLocalizable

Field Detail

sourceB

converterSupplier

converter

converted

Constructor Detail

BiConvertedRealRandomAccess

BiConvertedRealRandomAccess

Method Detail

get

fwd

bck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

copy