TwinCursor (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.TwinCursor<T>

All Implemented Interfaces:

Iterator<T>, Cursor<T>, EuclideanSpace, Localizable, PairIterator<T>, RealCursor<T>, RealLocalizable, Sampler<T>
```
public class TwinCursor<T extends Type<T>>
extends Object
implements Cursor<T>, PairIterator<T>
```
The TwinCursor moves over two images with respect to a mask. The mask has to be of the same dimensionality as the images. Position information obtained from this class comes from the mask.

Author:

Johannes Schindelin and Tom Kazimiers

Field Summary

Fields
Modifier and Type	Field and Description
`protected RandomAccess<T>`	`channel1`
`protected RandomAccess<T>`	`channel2`
`protected boolean`	`gotNext`
`protected PredicateCursor<BitType>`	`mask`
`protected long[]`	`position`

Constructor Summary

Constructors
Constructor and Description

TwinCursor(RandomAccess<T> channel1, RandomAccess<T> channel2, Cursor<BitType> mask)

Constructors
Constructor and Description
`TwinCursor(RandomAccess<T> channel1, RandomAccess<T> channel2, Cursor<BitType> mask)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Sampler<T>`	`copy()`
`Cursor<T>`	`copyCursor()`
`void`	`fwd()` Go to the next pair.
`T`	`get()`
`double`	`getDoublePosition(int arg0)`
`T`	`getFirst()` Return the first value of the pair.
`float`	`getFloatPosition(int arg0)`
`int`	`getIntPosition(int arg0)`
`long`	`getLongPosition(int arg0)`
`void`	`getNext()`
`T`	`getSecond()` Return the second value of the pair.
`boolean`	`hasNext()` Returns whether there are pairs left.
`void`	`jumpFwd(long arg0)`
`void`	`localize(double[] arg0)`
`void`	`localize(float[] arg0)`
`void`	`localize(int[] arg0)`
`void`	`localize(long[] arg0)`
`T`	`next()`
`int`	`numDimensions()`
`void`	`remove()`
`void`	`reset()` Resets the iterator to just before the first element.

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

Methods inherited from interface java.util.Iterator
forEachRemaining

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

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

- Field Detail
  - mask
```
protected final PredicateCursor<BitType> mask
```
  - channel1
```
protected final RandomAccess<T extends Type<T>> channel1
```
  - channel2
```
protected final RandomAccess<T extends Type<T>> channel2
```
  - position
```
protected final long[] position
```
  - gotNext
```
protected boolean gotNext
```
- Constructor Detail
  - TwinCursor
```
public TwinCursor(RandomAccess<T> channel1,
                  RandomAccess<T> channel2,
                  Cursor<BitType> mask)
```
- Method Detail
  - hasNext
```
public final boolean hasNext()
```
    Description copied from interface: PairIterator
    
    Returns whether there are pairs left.
    
    Specified by:
    
    hasNext in interface Iterator<T extends Type<T>>
    
    Specified by:
    
    hasNext in interface PairIterator<T extends Type<T>>
    
    Returns:
    
    true if there are pairs left.
  - getNext
```
public final void getNext()
```
  - getFirst
```
public final T getFirst()
```
    Description copied from interface: PairIterator
    
    Return the first value of the pair.
    
    Specified by:
    
    getFirst in interface PairIterator<T extends Type<T>>
    
    Returns:
    
    the first value of the pair
  - getSecond
```
public final T getSecond()
```
    Description copied from interface: PairIterator
    
    Return the second value of the pair.
    
    Specified by:
    
    getSecond in interface PairIterator<T extends Type<T>>
    
    Returns:
    
    the second value of the pair
  - reset
```
public void reset()
```
    Description copied from interface: PairIterator
    
    Resets the iterator to just before the first element.
    
    Specified by:
    
    reset in interface PairIterator<T extends Type<T>>
  - fwd
```
public void fwd()
```
    Description copied from interface: PairIterator
    
    Go to the next pair.
    
    Specified by:
    
    fwd in interface PairIterator<T extends Type<T>>
  - jumpFwd
```
public void jumpFwd(long arg0)
```
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T extends Type<T>>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<T extends Type<T>>
  - getDoublePosition
```
public double getDoublePosition(int arg0)
```
    Specified by:
    
    getDoublePosition in interface Localizable
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
  - getFloatPosition
```
public float getFloatPosition(int arg0)
```
    Specified by:
    
    getFloatPosition in interface Localizable
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
  - localize
```
public void localize(float[] arg0)
```
    Specified by:
    
    localize in interface RealLocalizable
  - localize
```
public void localize(double[] arg0)
```
    Specified by:
    
    localize in interface RealLocalizable
  - numDimensions
```
public int numDimensions()
```
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - copy
```
public Sampler<T> copy()
```
    Specified by:
    
    copy in interface Sampler<T extends Type<T>>
  - get
```
public T get()
```
    Specified by:
    
    get in interface Sampler<T extends Type<T>>
  - getIntPosition
```
public int getIntPosition(int arg0)
```
    Specified by:
    
    getIntPosition in interface Localizable
  - getLongPosition
```
public long getLongPosition(int arg0)
```
    Specified by:
    
    getLongPosition in interface Localizable
  - localize
```
public void localize(int[] arg0)
```
    Specified by:
    
    localize in interface Localizable
  - localize
```
public void localize(long[] arg0)
```
    Specified by:
    
    localize in interface Localizable
  - copyCursor
```
public Cursor<T> copyCursor()
```
    Specified by:
    
    copyCursor in interface Cursor<T extends Type<T>>
    
    Specified by:
    
    copyCursor in interface RealCursor<T extends Type<T>>

Class TwinCursor<T extends Type<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Field Detail

mask

channel1

channel2

position

gotNext

Constructor Detail

TwinCursor

Method Detail

hasNext

getNext

getFirst

getSecond

reset

fwd

jumpFwd

next

remove

getDoublePosition

getFloatPosition

localize

localize

numDimensions

copy

get

getIntPosition

getLongPosition

localize

localize

copyCursor