SpotNeighborhoodCursor (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.plugin.trackmate.util.SpotNeighborhoodCursor<T>

All Implemented Interfaces:

Iterator<T>, Cursor<T>, EuclideanSpace, Localizable, RealCursor<T>, RealLocalizable, Sampler<T>
```
public class SpotNeighborhoodCursor<T extends RealType<T>>
extends Object
implements Cursor<T>
```

Field Summary

Fields
Modifier and Type Field and Description

protected double[] calibration

protected long[] center

protected Cursor<T> cursor

Fields
Modifier and Type	Field and Description
`protected double[]`	`calibration`
`protected long[]`	`center`
`protected Cursor<T>`	`cursor`

Constructor Summary

Constructors
Constructor and Description

SpotNeighborhoodCursor(SpotNeighborhood<T> sn)

Constructors
Constructor and Description
`SpotNeighborhoodCursor(SpotNeighborhood<T> sn)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Sampler<T>`	`copy()`
`Cursor<T>`	`copyCursor()`
`void`	`fwd()`
`T`	`get()`
`double`	`getDistanceSquared()` Return the square distance measured from the center of the domain to the current cursor position, in calibrated units.
`double`	`getDoublePosition(int d)`
`float`	`getFloatPosition(int d)`
`int`	`getIntPosition(int d)`
`long`	`getLongPosition(int d)`
`double`	`getPhi()` Return the azimuth of the spherical coordinates of this cursor, with respect to its center.
`void`	`getRelativePosition(double[] position)` Store the relative calibrated position with respect to the neighborhood center.
`double`	`getTheta()` Return the current inclination with respect to this spot center.
`boolean`	`hasNext()`
`void`	`jumpFwd(long steps)`
`void`	`localize(double[] position)`
`void`	`localize(float[] position)`
`void`	`localize(int[] position)`
`void`	`localize(long[] position)`
`T`	`next()`
`int`	`numDimensions()`
`void`	`remove()`
`void`	`reset()`

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
  - cursor
```
protected final Cursor<T extends RealType<T>> cursor
```
  - calibration
```
protected final double[] calibration
```
  - center
```
protected final long[] center
```
- Constructor Detail
  - SpotNeighborhoodCursor
```
public SpotNeighborhoodCursor(SpotNeighborhood<T> sn)
```
- Method Detail
  - getRelativePosition
```
public void getRelativePosition(double[] position)
```
    Store the relative calibrated position with respect to the neighborhood center.
  - getDistanceSquared
```
public double getDistanceSquared()
```
    Return the square distance measured from the center of the domain to the current cursor position, in calibrated units.
  - getTheta
```
public double getTheta()
```
    Return the current inclination with respect to this spot center. Will be in the range [0, π].
    In spherical coordinates, the inclination is the angle between the Z axis and the line OM where O is the sphere center and M is the point location.
  - getPhi
```
public double getPhi()
```
    Return the azimuth of the spherical coordinates of this cursor, with respect to its center. Will be in the range ]-π, π].
    In spherical coordinates, the azimuth is the angle measured in the plane XY between the X axis and the line OH where O is the sphere center and H is the orthogonal projection of the point M on the XY plane.
  - localize
```
public void localize(float[] position)
```
    Specified by:
    
    localize in interface RealLocalizable
  - localize
```
public void localize(double[] position)
```
    Specified by:
    
    localize in interface RealLocalizable
  - getFloatPosition
```
public float getFloatPosition(int d)
```
    Specified by:
    
    getFloatPosition in interface Localizable
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
  - getDoublePosition
```
public double getDoublePosition(int d)
```
    Specified by:
    
    getDoublePosition in interface Localizable
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
  - numDimensions
```
public int numDimensions()
```
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - get
```
public T get()
```
    Specified by:
    
    get in interface Sampler<T extends RealType<T>>
  - copy
```
public Sampler<T> copy()
```
    Specified by:
    
    copy in interface Sampler<T extends RealType<T>>
  - jumpFwd
```
public void jumpFwd(long steps)
```
  - fwd
```
public void fwd()
```
  - reset
```
public void reset()
```
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<T extends RealType<T>>
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T extends RealType<T>>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<T extends RealType<T>>
  - localize
```
public void localize(int[] position)
```
    Specified by:
    
    localize in interface Localizable
  - localize
```
public void localize(long[] position)
```
    Specified by:
    
    localize in interface Localizable
  - getIntPosition
```
public int getIntPosition(int d)
```
    Specified by:
    
    getIntPosition in interface Localizable
  - getLongPosition
```
public long getLongPosition(int d)
```
    Specified by:
    
    getLongPosition in interface Localizable
  - copyCursor
```
public Cursor<T> copyCursor()
```
    Specified by:
    
    copyCursor in interface Cursor<T extends RealType<T>>
    
    Specified by:
    
    copyCursor in interface RealCursor<T extends RealType<T>>

Class SpotNeighborhoodCursor<T extends RealType<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

cursor

calibration

center

Constructor Detail

SpotNeighborhoodCursor

Method Detail

getRelativePosition

getDistanceSquared

getTheta

getPhi

localize

localize

getFloatPosition

getDoublePosition

numDimensions

get

copy

jumpFwd

fwd

reset

hasNext

next

remove

localize

localize

getIntPosition

getLongPosition

copyCursor