ArrayLocalizableCursor (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.cursor.CursorImpl<T>
- - mpicbg.imglib.cursor.array.ArrayCursor<T>
  - - mpicbg.imglib.cursor.array.ArrayLocalizableCursor<T>

All Implemented Interfaces:

Iterator<T>, Cursor<T>, Iterable, Localizable, LocalizableCursor<T>, Dimensionality

Direct Known Subclasses:

Array3DLocalizableCursor, ArrayLocalizableByDimCursor, ArrayLocalizablePlaneCursor
```
public class ArrayLocalizableCursor<T extends Type<T>>
extends ArrayCursor<T>
implements LocalizableCursor<T>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary

Fields
Modifier and Type Field and Description

protected int[] dimensions

protected int numDimensions

protected int[] position
- Fields inherited from class mpicbg.imglib.cursor.array.ArrayCursor
  container, maxIndex, type
- Fields inherited from class mpicbg.imglib.cursor.CursorImpl
  debug, image, isClosed

Fields
Modifier and Type	Field and Description
`protected int[]`	`dimensions`
`protected int`	`numDimensions`
`protected int[]`	`position`

Constructor Summary

Constructors
Constructor and Description

ArrayLocalizableCursor(Array<T,?> container, Image<T> image, T type)

Constructors
Constructor and Description
`ArrayLocalizableCursor(Array<T,?> container, Image<T> image, T type)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ArrayLocalizableCursor<FakeType>`	`createLinearCursor(int[] dim)`
`void`	`fwd()`
`void`	`fwd(long steps)`
`int[]`	`getPosition()` Return a copy of the current position.
`int`	`getPosition(int dim)` Return the current position in a given dimension.
`void`	`getPosition(int[] position)` Write the current position into the passed array.
`String`	`getPositionAsString()` Create a human-readable `String` representation of the current position.
`void`	`reset()`
`String`	`toString()`

Methods inherited from class mpicbg.imglib.cursor.array.ArrayCursor
close, getStorageContainer, getStorageIndex, getType, hasNext

Methods inherited from class mpicbg.imglib.cursor.CursorImpl
createPositionArray, getArrayIndex, getDimensions, getDimensions, getImage, getNumDimensions, isActive, iterator, next, remove, setDebug

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

Methods inherited from interface mpicbg.imglib.cursor.Cursor
close, createPositionArray, getArrayIndex, getImage, getStorageContainer, getStorageIndex, getType, isActive, setDebug

Methods inherited from interface java.util.Iterator
forEachRemaining, hasNext, next, remove

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

Methods inherited from interface mpicbg.imglib.cursor.vector.Dimensionality
getDimensions, getDimensions, getNumDimensions

- Field Detail
  - numDimensions
```
protected final int numDimensions
```
  - position
```
protected final int[] position
```
  - dimensions
```
protected final int[] dimensions
```
- Constructor Detail
  - ArrayLocalizableCursor
```
public ArrayLocalizableCursor(Array<T,?> container,
                              Image<T> image,
                              T type)
```
- Method Detail
  - createLinearCursor
```
public static ArrayLocalizableCursor<FakeType> createLinearCursor(int[] dim)
```
  - fwd
```
public void fwd()
```
    Specified by:
    
    fwd in interface Iterable
    
    Overrides:
    
    fwd in class ArrayCursor<T extends Type<T>>
  - fwd
```
public void fwd(long steps)
```
    Specified by:
    
    fwd in interface Iterable
    
    Overrides:
    
    fwd in class ArrayCursor<T extends Type<T>>
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface Cursor<T extends Type<T>>
    
    Overrides:
    
    reset in class ArrayCursor<T extends Type<T>>
  - getPosition
```
public void getPosition(int[] position)
```
    Description copied from interface: Localizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    getPosition in interface Localizable
  - getPosition
```
public int[] getPosition()
```
    Description copied from interface: Localizable
    
    Return a copy of the current position.
    
    Specified by:
    
    getPosition in interface Localizable
    
    Returns:
  - getPosition
```
public int getPosition(int dim)
```
    Description copied from interface: Localizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getPosition in interface Localizable
    
    Returns:
  - getPositionAsString
```
public String getPositionAsString()
```
    Description copied from interface: Localizable
    
    Create a human-readable String representation of the current position.
    
    Specified by:
    
    getPositionAsString in interface Localizable
    
    Returns:
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class ArrayCursor<T extends Type<T>>

Class ArrayLocalizableCursor<T extends Type<T>>

Field Summary

Fields inherited from class mpicbg.imglib.cursor.array.ArrayCursor

Fields inherited from class mpicbg.imglib.cursor.CursorImpl

Constructor Summary

Method Summary

Methods inherited from class mpicbg.imglib.cursor.array.ArrayCursor

Methods inherited from class mpicbg.imglib.cursor.CursorImpl

Methods inherited from class java.lang.Object

Methods inherited from interface mpicbg.imglib.cursor.Cursor

Methods inherited from interface java.util.Iterator

Methods inherited from interface java.lang.Iterable

Methods inherited from interface mpicbg.imglib.cursor.vector.Dimensionality

Field Detail

numDimensions

position

dimensions

Constructor Detail

ArrayLocalizableCursor

Method Detail

createLinearCursor

fwd

fwd

reset

getPosition

getPosition

getPosition

getPositionAsString

toString