HyperSphereCursor (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.algorithm.region.hypersphere.HyperSphereCursor<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterator<T>, Cursor<T>, EuclideanSpace, Localizable, RealCursor<T>, RealLocalizable, Sampler<T>
```
public class HyperSphereCursor<T>
extends Object
implements Cursor<T>
```
Iterate over all pixels in an n-dimensional sphere.

Author:

Stephan Preibisch, Stephan Saalfeld, Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch

Field Summary

Fields
Modifier and Type Field and Description

protected long[] center

protected long radius

protected RandomAccess<T> randomAccess

Fields
Modifier and Type	Field and Description
`protected long[]`	`center`
`protected long`	`radius`
`protected RandomAccess<T>`	`randomAccess`

Constructor Summary

Constructors
Constructor and Description
`HyperSphereCursor(HyperSphereCursor<T> cursor)`
`HyperSphereCursor(RandomAccessible<T> source, long[] center, long radius)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HyperSphereCursor<T>`	`copy()`
`HyperSphereCursor<T>`	`copyCursor()`
`void`	`fwd()` Move forward.
`T`	`get()` Access the actual T instance providing access to a pixel, sub-pixel or integral region value the `Sampler` points at.
`double`	`getDoublePosition(int d)` Return the current position in a given dimension.
`float`	`getFloatPosition(int d)` Return the current position in a given dimension.
`int`	`getIntPosition(int d)` Return the current position in a given dimension.
`long`	`getLongPosition(int d)` Return the current position in a given dimension.
`boolean`	`hasNext()` Returns true if another step forward is possible.
`void`	`jumpFwd(long steps)` Move steps × forward.
`void`	`localize(double[] position)` Write the current position into the passed array.
`void`	`localize(float[] position)` Write the current position into the passed array.
`void`	`localize(int[] position)` Write the current position into the passed array.
`void`	`localize(long[] position)` Write the current position into the passed array.
`T`	`next()`
`int`	`numDimensions()` Gets the space's number of dimensions.
`void`	`remove()`
`void`	`reset()` Reset the `Iterator`, that is put it to where it would be if newly created.
`void`	`updateCenter(Localizable center)`
`void`	`updateCenter(long[] center)`

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 net.imglib2.Localizable
localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealLocalizable
localize, positionAsDoubleArray, positionAsRealPoint

- Field Detail
  - center
```
protected final long[] center
```
  - randomAccess
```
protected final RandomAccess<T> randomAccess
```
  - radius
```
protected final long radius
```
- Constructor Detail
  - HyperSphereCursor
```
public HyperSphereCursor(RandomAccessible<T> source,
                         long[] center,
                         long radius)
```
  - HyperSphereCursor
```
public HyperSphereCursor(HyperSphereCursor<T> cursor)
```
- Method Detail
  - updateCenter
```
public void updateCenter(long[] center)
```
  - updateCenter
```
public void updateCenter(Localizable center)
```
  - hasNext
```
public boolean hasNext()
```
    Description copied from interface: Iterator
    
    Returns true if another step forward is possible.
    
    Specified by:
    
    hasNext in interface Iterator<T>
    
    Returns:
    
    true, if there is another step forward is possible, otherwise false
  - fwd
```
public void fwd()
```
    Description copied from interface: Iterator
    
    Move forward.
  - reset
```
public void reset()
```
    Description copied from interface: Iterator
    
    Reset the Iterator, that is put it to where it would be if newly created.
  - jumpFwd
```
public void jumpFwd(long steps)
```
    Description copied from interface: Iterator
    
    Move steps × forward.
    
    Parameters:
    
    steps - number of steps to move forward
  - localize
```
public void localize(float[] position)
```
    Description copied from interface: RealLocalizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface RealLocalizable
    
    Parameters:
    
    position - receives current position
  - localize
```
public void localize(double[] position)
```
    Description copied from interface: RealLocalizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface RealLocalizable
    
    Parameters:
    
    position - receives current position
  - getFloatPosition
```
public float getFloatPosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getFloatPosition in interface Localizable
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getDoublePosition
```
public double getDoublePosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getDoublePosition in interface Localizable
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - numDimensions
```
public int numDimensions()
```
    Description copied from interface: EuclideanSpace
    
    Gets the space's number of dimensions.
    
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - get
```
public T get()
```
    Description copied from interface: Sampler
    
    Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
    
    Specified by:
    
    get in interface Sampler<T>
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<T>
  - localize
```
public void localize(int[] position)
```
    Description copied from interface: Localizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface Localizable
    
    Parameters:
    
    position - receives current position
  - localize
```
public void localize(long[] position)
```
    Description copied from interface: Localizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface Localizable
    
    Parameters:
    
    position - receives current position
  - getIntPosition
```
public int getIntPosition(int d)
```
    Description copied from interface: Localizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getIntPosition in interface Localizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getLongPosition
```
public long getLongPosition(int d)
```
    Description copied from interface: Localizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getLongPosition in interface Localizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - copyCursor
```
public HyperSphereCursor<T> copyCursor()
```
    Specified by:
    
    copyCursor in interface Cursor<T>
    
    Specified by:
    
    copyCursor in interface RealCursor<T>
  - copy
```
public HyperSphereCursor<T> copy()
```
    Specified by:
    
    copy in interface Sampler<T>
    
    Returns:
    
    - A new Sampler in the same state accessing the same values. It does NOT copy T, just the state of the Sampler. Otherwise use T.copy() if available. Sampler.copy().get() == Sampler.get(), i.e. both hold the same value, not necessarily the same instance (this is the case for an ArrayCursor for example)

Class HyperSphereCursor<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 net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Field Detail

center

randomAccess

radius

Constructor Detail

HyperSphereCursor

HyperSphereCursor

Method Detail

updateCenter

updateCenter

hasNext

fwd

reset

jumpFwd

localize

localize

getFloatPosition

getDoublePosition

numDimensions

get

next

remove

localize

localize

getIntPosition

getLongPosition

copyCursor

copy