HyperSphereIterator (Fiji Javadocs 0-SNAPSHOT API)

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

Type Parameters:

T -

All Implemented Interfaces:

Iterator<T>, Cursor<T>, Iterable, Localizable, LocalizableCursor<T>, Dimensionality
```
public class HyperSphereIterator<T extends Type<T>>
extends Object
implements Iterable, LocalizableCursor<T>, Localizable
```
Iterate over all pixels in an n-dimensional sphere. This implementation is Container agnostic and thus the general purpose version of the Iterator. For specific Containers, a different implementation might be more efficient.

Author:

Stephan Preibisch, Stephan Saalfeld, Stephan Preibisch , Stephan Saalfeld

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`activeCursorIndex`
`protected Localizable`	`center`
`protected LocalizableByDimCursor<T>`	`cursor`
`protected Image<T>`	`image`
`protected int`	`maxDim`
`protected int`	`numDimensions`
`protected int`	`radius`

Constructor Summary

Constructors
Constructor and Description
`HyperSphereIterator(Image<T> image, Localizable center, int radius)`
`HyperSphereIterator(Image<T> image, Localizable center, int radius, OutOfBoundsStrategyFactory<T> oobFactory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`int[]`	`createPositionArray()`
`void`	`fwd()`
`void`	`fwd(long steps)`
`int`	`getArrayIndex()`
`int[]`	`getDimensions()`
`void`	`getDimensions(int[] position)`
`Image<T>`	`getImage()`
`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`	`reset()`
`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 java.util.Iterator
forEachRemaining

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

- Field Detail
  - image
```
protected final Image<T extends Type<T>> image
```
  - center
```
protected final Localizable center
```
  - cursor
```
protected final LocalizableByDimCursor<T extends Type<T>> cursor
```
  - activeCursorIndex
```
protected int activeCursorIndex
```
  - radius
```
protected final int radius
```
  - numDimensions
```
protected final int numDimensions
```
  - maxDim
```
protected final int maxDim
```
- Constructor Detail
  - HyperSphereIterator
```
public HyperSphereIterator(Image<T> image,
                           Localizable center,
                           int radius)
```
  - HyperSphereIterator
```
public HyperSphereIterator(Image<T> image,
                           Localizable center,
                           int radius,
                           OutOfBoundsStrategyFactory<T> oobFactory)
```
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<T extends Type<T>>
  - fwd
```
public void fwd()
```
    Specified by:
    
    fwd in interface Iterable
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface Cursor<T extends Type<T>>
  - fwd
```
public void fwd(long steps)
```
    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:
  - 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>>
  - next
```
public 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()
```
  - 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

Class HyperSphereIterator<T extends Type<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Methods inherited from interface java.lang.Iterable

Field Detail

image

center

cursor

activeCursorIndex

radius

numDimensions

maxDim

Constructor Detail

HyperSphereIterator

HyperSphereIterator

Method Detail

hasNext

fwd

reset

fwd

getPosition

getPosition

getPosition

getPositionAsString

close

createPositionArray

getArrayIndex

getImage

getStorageContainer

getStorageIndex

getType

isActive

setDebug

next

remove

iterator

getDimensions

getDimensions

getNumDimensions