AbstractSpecialCursor (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.cursor.special.AbstractSpecialCursor<T>

Type Parameters:

T -

All Implemented Interfaces:

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

Direct Known Subclasses:

CoordsCursor
```
public abstract class AbstractSpecialCursor<T extends Type<T>>
extends Object
implements LocalizableCursor<T>
```
This abstract cursor offer facilities for specialized cursor that are based on a LocalizableByDimCursor whose iteration domain is imposed. This abstract class itself is not really interesting, see sub-classes.

Author:

Jean-Yves Tinevez Sep 9, 2010

Field Summary

Fields
Modifier and Type	Field and Description
`protected LocalizableByDimCursor<T>`	`cursor` The cursor that will be used internally to iterate in the domain.
`protected boolean`	`hasNext` True if the iteration is not done yet.
`protected Image<T>`	`img` The Image this cursors operates on.

Constructor Summary

Constructors
Constructor and Description

AbstractSpecialCursor()

Constructors
Constructor and Description
`AbstractSpecialCursor()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`int[]`	`createPositionArray()`
`void`	`fwd(long steps)`
`int`	`getArrayIndex()`
`int[]`	`getDimensions()`
`void`	`getDimensions(int[] position)`
`Image<T>`	`getImage()`
`abstract int`	`getNPixels()` Return the number of pixels this cursor will iterate on (or, the number of iterations it will do before exhausting).
`int`	`getNumDimensions()`
`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.
`Container<T>`	`getStorageContainer()`
`int`	`getStorageIndex()`
`T`	`getType()`
`boolean`	`hasNext()`
`boolean`	`isActive()`
`Iterator<T>`	`iterator()`
`T`	`next()`
`void`	`remove()`
`void`	`setDebug(boolean debug)`

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

Methods inherited from interface mpicbg.imglib.cursor.Cursor
reset

Methods inherited from interface java.util.Iterator
forEachRemaining

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

Methods inherited from interface mpicbg.imglib.cursor.Iterable
fwd

- Field Detail
  - cursor
```
protected LocalizableByDimCursor<T extends Type<T>> cursor
```
    The cursor that will be used internally to iterate in the domain.
  - img
```
protected Image<T extends Type<T>> img
```
    The Image this cursors operates on.
  - hasNext
```
protected boolean hasNext
```
    True if the iteration is not done yet.
- Constructor Detail
  - AbstractSpecialCursor
```
public AbstractSpecialCursor()
```
- Method Detail
  - getNPixels
```
public abstract int getNPixels()
```
    Return the number of pixels this cursor will iterate on (or, the number of iterations it will do before exhausting). This is useful when one needs to know the number of pixel iterated on in advance. For instance:
```
 DiscCursor dc = new DiscCursor(img, center, 5);
 int arrraySize = sc.getNPixels();
 float[] pixelVal = new float[arraySize];
 int index = 0;
 while (sc.hasNext()) {
        sc.fwd();
        pixelVal[index] = sc.getType().getRealFloat();
        index++;
 }
 
```
  - close
```
public void close()
```
    Specified by:
    
    close in interface Cursor<T extends Type<T>>
  - createPositionArray
```
public int[] createPositionArray()
```
    Specified by:
    
    createPositionArray in interface Cursor<T extends Type<T>>
  - getArrayIndex
```
public int getArrayIndex()
```
    Specified by:
    
    getArrayIndex in interface Cursor<T extends Type<T>>
  - getImage
```
public Image<T> getImage()
```
    Specified by:
    
    getImage in interface Cursor<T extends Type<T>>
  - getStorageContainer
```
public Container<T> getStorageContainer()
```
    Specified by:
    
    getStorageContainer in interface Cursor<T extends Type<T>>
  - getStorageIndex
```
public int getStorageIndex()
```
    Specified by:
    
    getStorageIndex in interface Cursor<T extends Type<T>>
  - getType
```
public T getType()
```
    Specified by:
    
    getType in interface Cursor<T extends Type<T>>
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface Cursor<T extends Type<T>>
  - setDebug
```
public void setDebug(boolean debug)
```
    Specified by:
    
    setDebug in interface Cursor<T extends Type<T>>
  - hasNext
```
public final boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<T extends Type<T>>
  - next
```
public final 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>>
  - iterator
```
public Iterator<T> iterator()
```
  - fwd
```
public void fwd(long steps)
```
    Specified by:
    
    fwd in interface Iterable
  - getDimensions
```
public int[] getDimensions()
```
    Specified by:
    
    getDimensions in interface Dimensionality
  - getDimensions
```
public void getDimensions(int[] position)
```
    Specified by:
    
    getDimensions in interface Dimensionality
  - getNumDimensions
```
public int getNumDimensions()
```
    Specified by:
    
    getNumDimensions in interface Dimensionality
  - 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 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(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:

Class AbstractSpecialCursor<T extends Type<T>>

Field Summary

Constructor Summary

Method Summary

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.Iterable

Field Detail

cursor

img

hasNext

Constructor Detail

AbstractSpecialCursor

Method Detail

getNPixels

close

createPositionArray

getArrayIndex

getImage

getStorageContainer

getStorageIndex

getType

isActive

setDebug

hasNext

next

remove

iterator

fwd

getDimensions

getDimensions

getNumDimensions

getPosition

getPosition

getPosition

getPositionAsString