ConstantLocalizableByDimCursor (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.cursor.CursorImpl<T>
- - mpicbg.imglib.cursor.constant.ConstantLocalizableByDimCursor<T>

Type Parameters:

T -

All Implemented Interfaces:

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

Direct Known Subclasses:

ConstantLocalizableByDimOutOfBoundsCursor, ConstantLocalizablePlaneCursor
```
public class ConstantLocalizableByDimCursor<T extends Type<T>>
extends CursorImpl<T>
implements LocalizableByDimCursor<T>
```
A simple LocalizableByDimCursor that always returns the same value at each position. Here I just used Saalfeld's implementation from the ShapeListLocalizableByDimCursor.

Author:

Tobias Pietzsch, 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.CursorImpl
  container, 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

ConstantLocalizableByDimCursor(ConstantContainer<T> container, Image<T> image, T type)

Constructors
Constructor and Description
`ConstantLocalizableByDimCursor(ConstantContainer<T> container, Image<T> image, T type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bck(int dim)`
`void`	`close()`
`LocalNeighborhoodCursor<T>`	`createLocalNeighborhoodCursor()`
`RegionOfInterestCursor<T>`	`createRegionOfInterestCursor(int[] offset, int[] size)`
`void`	`fwd()`
`void`	`fwd(int dim)`
`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()` Assumes that position is not out of bounds.
`void`	`move(int steps, int dim)`
`void`	`moveRel(int[] vector)`
`void`	`moveTo(int[] position)`
`void`	`moveTo(Localizable localizable)`
`void`	`reset()`
`void`	`setPosition(int[] position)`
`void`	`setPosition(int position, int dim)`
`void`	`setPosition(Localizable localizable)`

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

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
createPositionArray, getArrayIndex, getImage, getStorageContainer, 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.Iterable
fwd

- Field Detail
  - numDimensions
```
protected final int numDimensions
```
  - position
```
protected final int[] position
```
  - dimensions
```
protected final int[] dimensions
```
- Constructor Detail
  - ConstantLocalizableByDimCursor
```
public ConstantLocalizableByDimCursor(ConstantContainer<T> container,
                                      Image<T> image,
                                      T type)
```
- Method Detail
  - getType
```
public T getType()
```
    Specified by:
    
    getType in interface Cursor<T extends Type<T>>
  - fwd
```
public void fwd(int dim)
```
    Specified by:
    
    fwd in interface LocalizableByDim
  - move
```
public void move(int steps,
                 int dim)
```
    Specified by:
    
    move in interface LocalizableByDim
  - bck
```
public void bck(int dim)
```
    Specified by:
    
    bck in interface LocalizableByDim
  - moveRel
```
public void moveRel(int[] vector)
```
    Specified by:
    
    moveRel in interface LocalizableByDim
  - moveTo
```
public void moveTo(int[] position)
```
    Specified by:
    
    moveTo in interface LocalizableByDim
  - moveTo
```
public void moveTo(Localizable localizable)
```
    Specified by:
    
    moveTo in interface LocalizableByDim
  - setPosition
```
public void setPosition(Localizable localizable)
```
    Specified by:
    
    setPosition in interface LocalizableByDim
  - setPosition
```
public void setPosition(int[] position)
```
    Specified by:
    
    setPosition in interface LocalizableByDim
  - setPosition
```
public void setPosition(int position,
                        int dim)
```
    Specified by:
    
    setPosition in interface LocalizableByDim
  - close
```
public void close()
```
    Specified by:
    
    close in interface Cursor<T extends Type<T>>
  - getStorageIndex
```
public int getStorageIndex()
```
    Specified by:
    
    getStorageIndex in interface Cursor<T extends Type<T>>
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface Cursor<T extends Type<T>>
  - hasNext
```
public boolean hasNext()
```
    Assumes that position is not out of bounds. TODO Not the most efficient way to calculate this on demand. Better: count an index while moving...
    
    Specified by:
    
    hasNext in interface Iterator<T extends Type<T>>
  - fwd
```
public void fwd()
```
    Specified by:
    
    fwd in interface Iterable
  - 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:
  - createLocalNeighborhoodCursor
```
public LocalNeighborhoodCursor<T> createLocalNeighborhoodCursor()
```
    Specified by:
    
    createLocalNeighborhoodCursor in interface LocalizableByDimCursor<T extends Type<T>>
  - createRegionOfInterestCursor
```
public RegionOfInterestCursor<T> createRegionOfInterestCursor(int[] offset,
                                                              int[] size)
```
    Specified by:
    
    createRegionOfInterestCursor in interface LocalizableByDimCursor<T extends Type<T>>

Class ConstantLocalizableByDimCursor<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

Field Detail

numDimensions

position

dimensions

Constructor Detail

ConstantLocalizableByDimCursor

Method Detail

getType

fwd

move

bck

moveRel

moveTo

moveTo

setPosition

setPosition

setPosition

close

getStorageIndex

reset

hasNext

fwd

getPosition

getPosition

getPosition

getPositionAsString

createLocalNeighborhoodCursor

createRegionOfInterestCursor