RegionOfInterestCursor (Fiji Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

Iterator<T>, Cursor<T>, Iterable, Localizable, LocalizableCursor<T>, Dimensionality
```
public class RegionOfInterestCursor<T extends Type<T>>
extends CursorImpl<T>
implements LocalizableCursor<T>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary
- Fields inherited from class mpicbg.imglib.cursor.CursorImpl
  container, image, isClosed

Constructor Summary

Constructors
Constructor and Description

RegionOfInterestCursor(LocalizableByDimCursor<T> cursor, int[] offset, int[] size)

Constructors
Constructor and Description
`RegionOfInterestCursor(LocalizableByDimCursor<T> cursor, int[] offset, int[] size)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`fwd()`
`int`	`getArrayIndex()`
`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.
`int`	`getStorageIndex()`
`T`	`getType()`
`boolean`	`hasNext()`
`boolean`	`isActive()`
`void`	`reset()`
`void`	`reset(int[] o)`
`void`	`reset(int[] o, int[] s)`
`void`	`setDebug(boolean debug)`
`String`	`toString()`

Methods inherited from class mpicbg.imglib.cursor.CursorImpl
createPositionArray, fwd, getDimensions, getDimensions, getImage, getNumDimensions, getStorageContainer, iterator, next, remove

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
createPositionArray, getImage, getStorageContainer

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

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

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

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

- Constructor Detail
  - RegionOfInterestCursor
```
public RegionOfInterestCursor(LocalizableByDimCursor<T> cursor,
                              int[] offset,
                              int[] size)
```
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<T extends Type<T>>
  - close
```
public void close()
```
    Specified by:
    
    close in interface Cursor<T extends Type<T>>
  - getType
```
public T getType()
```
    Specified by:
    
    getType in interface Cursor<T extends Type<T>>
  - reset
```
public void reset(int[] o)
```
  - reset
```
public void reset(int[] o,
                  int[] s)
```
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface Cursor<T extends Type<T>>
  - fwd
```
public void fwd()
```
    Specified by:
    
    fwd in interface Iterable
  - getArrayIndex
```
public int getArrayIndex()
```
    Specified by:
    
    getArrayIndex in interface Cursor<T extends Type<T>>
    
    Overrides:
    
    getArrayIndex in class CursorImpl<T extends Type<T>>
  - getStorageIndex
```
public int getStorageIndex()
```
    Specified by:
    
    getStorageIndex in interface Cursor<T extends Type<T>>
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface Cursor<T extends Type<T>>
    
    Overrides:
    
    isActive in class CursorImpl<T extends Type<T>>
  - setDebug
```
public void setDebug(boolean debug)
```
    Specified by:
    
    setDebug in interface Cursor<T extends Type<T>>
    
    Overrides:
    
    setDebug in class CursorImpl<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 Object

Class RegionOfInterestCursor<T extends Type<T>>

Field Summary

Fields inherited from class mpicbg.imglib.cursor.CursorImpl

Constructor Summary

Method Summary

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

Methods inherited from interface mpicbg.imglib.cursor.Iterable

Constructor Detail

RegionOfInterestCursor

Method Detail

hasNext

close

getType

reset

reset

reset

fwd

getArrayIndex

getStorageIndex

isActive

setDebug

getPosition

getPosition

getPosition

getPositionAsString

toString