ArrayLocalizablePlaneCursor (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>
    - - mpicbg.imglib.cursor.array.ArrayLocalizablePlaneCursor<T>

All Implemented Interfaces:

Iterator<T>, Cursor<T>, Iterable, Localizable, LocalizableCursor<T>, LocalizablePlane, LocalizablePlaneCursor<T>, Dimensionality
```
public class ArrayLocalizablePlaneCursor<T extends Type<T>>
extends ArrayLocalizableCursor<T>
implements LocalizablePlaneCursor<T>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`incPlaneA`
`protected int`	`incPlaneB`
`protected int`	`maxI`
`protected int`	`planeDimA`
`protected int`	`planeDimB`
`protected int`	`planeSizeA`
`protected int`	`planeSizeB`

Fields inherited from class mpicbg.imglib.cursor.array.ArrayLocalizableCursor
dimensions, numDimensions, position

Fields inherited from class mpicbg.imglib.cursor.array.ArrayCursor
container, maxIndex, type

Fields inherited from class mpicbg.imglib.cursor.CursorImpl
debug, image, isClosed

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`fwd()`
`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.
`boolean`	`hasNext()`
`void`	`reset()`
`void`	`reset(int planeDimA, int planeDimB)`
`void`	`reset(int planeDimA, int planeDimB, int[] dimensionPositions)`
`protected void`	`setPosition(int[] position)`

Methods inherited from class mpicbg.imglib.cursor.array.ArrayLocalizableCursor
createLinearCursor, fwd, getPositionAsString, toString

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

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, 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.Localizable
getPositionAsString

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

- Field Detail
  - planeDimA
```
protected int planeDimA
```
  - planeDimB
```
protected int planeDimB
```
  - planeSizeA
```
protected int planeSizeA
```
  - planeSizeB
```
protected int planeSizeB
```
  - incPlaneA
```
protected int incPlaneA
```
  - incPlaneB
```
protected int incPlaneB
```
  - maxI
```
protected int maxI
```
- Constructor Detail
  - ArrayLocalizablePlaneCursor
```
public ArrayLocalizablePlaneCursor(Array<T,?> container,
                                   Image<T> image,
                                   T type)
```
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<T extends Type<T>>
    
    Overrides:
    
    hasNext in class ArrayCursor<T extends Type<T>>
  - fwd
```
public void fwd()
```
    Specified by:
    
    fwd in interface Iterable
    
    Overrides:
    
    fwd in class ArrayLocalizableCursor<T extends Type<T>>
  - reset
```
public void reset(int planeDimA,
                  int planeDimB,
                  int[] dimensionPositions)
```
    Specified by:
    
    reset in interface LocalizablePlane
  - reset
```
public void reset(int planeDimA,
                  int planeDimB)
```
    Specified by:
    
    reset in interface LocalizablePlane
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface Cursor<T extends Type<T>>
    
    Overrides:
    
    reset in class ArrayLocalizableCursor<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
    
    Overrides:
    
    getPosition in class ArrayLocalizableCursor<T extends Type<T>>
  - getPosition
```
public int[] getPosition()
```
    Description copied from interface: Localizable
    
    Return a copy of the current position.
    
    Specified by:
    
    getPosition in interface Localizable
    
    Overrides:
    
    getPosition in class ArrayLocalizableCursor<T extends Type<T>>
    
    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
    
    Overrides:
    
    getPosition in class ArrayLocalizableCursor<T extends Type<T>>
    
    Returns:
  - setPosition
```
protected void setPosition(int[] position)
```

Class ArrayLocalizablePlaneCursor<T extends Type<T>>

Field Summary

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

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

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

Methods inherited from interface mpicbg.imglib.cursor.Localizable

Methods inherited from interface mpicbg.imglib.cursor.Iterable

Field Detail

planeDimA

planeDimB

planeSizeA

planeSizeB

incPlaneA

incPlaneB

maxI

Constructor Detail

ArrayLocalizablePlaneCursor

Method Detail

hasNext

fwd

reset

reset

reset

getPosition

getPosition

getPosition

setPosition