AbstractConvertedCursor (ImgLib2 Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

Iterator, Cursor, EuclideanSpace, Localizable, RealCursor, RealLocalizable, Sampler

Direct Known Subclasses:

BiConvertedCursor, ConvertedCursor, LabelingConvertedCursor, SamplingCursor, WriteConvertedCursor
```
public abstract class AbstractConvertedCursor<A,B>
extends Object
implements Cursor
```
TODO

Field Summary

Fields
Modifier and Type Field and Description

protected Cursor<A> source

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

Constructor Summary

Constructors
Constructor and Description

AbstractConvertedCursor(Cursor<A> source)

Constructors
Constructor and Description
`AbstractConvertedCursor(Cursor<A> source)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract AbstractConvertedCursor<A,B>`	`copy()`
`AbstractConvertedCursor<A,B>`	`copyCursor()`
`void`	`fwd()` Move forward.
`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.
`boolean`	`hasNext()` Returns true if another step forward is possible.
`void`	`jumpFwd(long steps)` Move steps × forward.
`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.
`B`	`next()`
`int`	`numDimensions()` Gets the space's number of dimensions.
`void`	`remove()`
`void`	`reset()` Reset the `Iterator`, that is put it to where it would be if newly created.

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

Methods inherited from interface net.imglib2.Sampler
get

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
 - source
```
protected final Cursor<A> source
```
- Constructor Detail
 - AbstractConvertedCursor
```
public AbstractConvertedCursor(Cursor<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
 - jumpFwd
```
public void jumpFwd(long steps)
```
 Description copied from interface: Iterator
 
 Move steps × forward.
 
 Parameters:
 
 steps - number of steps to move forward
 - fwd
```
public void fwd()
```
 Description copied from interface: Iterator
 
 Move forward.
 - reset
```
public void reset()
```
 Description copied from interface: Iterator
 
 Reset the Iterator, that is put it to where it would be if newly created.
 - hasNext
```
public boolean hasNext()
```
 Description copied from interface: Iterator
 
 Returns true if another step forward is possible.
 
 Specified by:
 
 hasNext in interface Iterator
 
 Returns:
 
 true, if there is another step forward is possible, otherwise false
 - next
```
public B next()
```
 Specified by:
 
 next in interface Iterator
 - remove
```
public void remove()
```
 Specified by:
 
 remove in interface Iterator
 - copy
```
public abstract AbstractConvertedCursor<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)
 - copyCursor
```
public AbstractConvertedCursor<A,B> copyCursor()
```
 Specified by:
 
 copyCursor in interface Cursor
 
 Specified by:
 
 copyCursor in interface RealCursor

Class AbstractConvertedCursor<A,B>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.Sampler

Methods inherited from interface java.util.Iterator

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Field Detail

source

Constructor Detail

AbstractConvertedCursor

Method Detail

localize

localize

getIntPosition

getLongPosition

localize

localize

getFloatPosition

getDoublePosition

numDimensions

jumpFwd

fwd

reset

hasNext

next

remove

copy

copyCursor