BiConvertedRealCursor (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.converter.AbstractConvertedRealCursor<A,C>
- - net.imglib2.converter.read.BiConvertedRealCursor<A,B,C>

All Implemented Interfaces:: Iterator<C>, EuclideanSpace, RealCursor<C>, RealLocalizable, Sampler<C>

public class BiConvertedRealCursor<A,B,C extends Type<C>>
extends AbstractConvertedRealCursor<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 RealCursor<B>`	`sourceB`

Fields inherited from class net.imglib2.converter.AbstractConvertedRealCursor
source

Constructor Summary

Constructors
Constructor and Description
`BiConvertedRealCursor(RealCursor<A> sourceA, RealCursor<B> sourceB, BiConverter<? super A,? super B,? super C> converter, C c)` Creates a copy of c for conversion that can be accessed through `get()`.
`BiConvertedRealCursor(RealCursor<A> sourceA, RealCursor<B> sourceB, Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier, C c)` Creates a copy of c for conversion that can be accessed through `get()`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BiConvertedRealCursor<A,B,C>`	`copy()`
`void`	`fwd()` Move forward.
`C`	`get()` Access the actual T instance providing access to a pixel, sub-pixel or integral region value the `Sampler` points at.
`boolean`	`hasNext()` The correct logic would be to return `sourceA.hasNext() && sourceB.hasNext()` but we test only sourceA for efficiency.
`void`	`jumpFwd(long steps)` Move steps × forward.
`void`	`remove()`
`void`	`reset()` Reset the `Iterator`, that is put it to where it would be if newly created.

Methods inherited from class net.imglib2.converter.AbstractConvertedRealCursor
copyCursor, getDoublePosition, getFloatPosition, localize, localize, next, 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.RealLocalizable
localize, positionAsDoubleArray, positionAsRealPoint

Methods inherited from interface java.util.Iterator
forEachRemaining

- Field Detail
  - converter
```
protected final BiConverter<? super A,? super B,? super C extends Type<C>> converter
```
  - converterSupplier
```
protected final Supplier<BiConverter<? super A,? super B,? super C extends Type<C>>> converterSupplier
```
  - sourceB
```
protected final RealCursor<B> sourceB
```
  - converted
```
protected final C extends Type<C> converted
```
- Constructor Detail
  - BiConvertedRealCursor
```
public BiConvertedRealCursor(RealCursor<A> sourceA,
                             RealCursor<B> sourceB,
                             Supplier<BiConverter<? super A,? super B,? super C>> converterSupplier,
                             C c)
```
    Creates a copy of c for conversion that can be accessed through get().
    
    Parameters:
    
    sourceA -
    
    sourceB -
    
    converterSupplier -
    
    c -
  - BiConvertedRealCursor
```
public BiConvertedRealCursor(RealCursor<A> sourceA,
                             RealCursor<B> sourceB,
                             BiConverter<? super A,? super B,? super C> converter,
                             C c)
```
    Creates a copy of c for conversion that can be accessed through get().
    
    Parameters:
    
    sourceA -
    
    sourceB -
    
    converter -
    
    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.
  - jumpFwd
```
public void jumpFwd(long steps)
```
    Description copied from interface: Iterator
    
    Move steps × forward.
    
    Overrides:
    
    jumpFwd in class AbstractConvertedRealCursor<A,C extends Type<C>>
    
    Parameters:
    
    steps - number of steps to move forward
  - fwd
```
public void fwd()
```
    Description copied from interface: Iterator
    
    Move forward.
    
    Overrides:
    
    fwd in class AbstractConvertedRealCursor<A,C extends Type<C>>
  - reset
```
public void reset()
```
    Description copied from interface: Iterator
    
    Reset the Iterator, that is put it to where it would be if newly created.
    
    Overrides:
    
    reset in class AbstractConvertedRealCursor<A,C extends Type<C>>
  - hasNext
```
public boolean hasNext()
```
    The correct logic would be to return sourceA.hasNext() && sourceB.hasNext() but we test only sourceA for efficiency. Make sure that sourceA is the smaller IterableInterval.
    
    Specified by:
    
    hasNext in interface Iterator<C extends Type<C>>
    
    Overrides:
    
    hasNext in class AbstractConvertedRealCursor<A,C extends Type<C>>
    
    Returns:
    
    true, if there is another step forward is possible, otherwise false
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<C extends Type<C>>
    
    Overrides:
    
    remove in class AbstractConvertedRealCursor<A,C extends Type<C>>
  - copy
```
public BiConvertedRealCursor<A,B,C> copy()
```
    Specified by:
    
    copy in interface Sampler<C extends Type<C>>
    
    Specified by:
    
    copy in class AbstractConvertedRealCursor<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 BiConvertedRealCursor<A,B,C extends Type<C>>

Field Summary

Fields inherited from class net.imglib2.converter.AbstractConvertedRealCursor

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.converter.AbstractConvertedRealCursor

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.RealLocalizable

Methods inherited from interface java.util.Iterator

Field Detail

converter

converterSupplier

sourceB

converted

Constructor Detail

BiConvertedRealCursor

BiConvertedRealCursor

Method Detail

get

jumpFwd

fwd

reset

hasNext

remove

copy