AbstractNeighborhoodCursor (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.algorithm.region.localneighborhood.AbstractNeighborhoodCursor<T>

All Implemented Interfaces:

Iterator<T>, Cursor<T>, EuclideanSpace, Localizable, Bounded, RealCursor<T>, RealLocalizable, Sampler<T>

Direct Known Subclasses:

BufferedRectangularNeighborhoodCursor, EllipseCursor, EllipsoidCursor, RectangleCursor
```
public abstract class AbstractNeighborhoodCursor<T>
extends Object
implements Cursor<T>, Bounded
```

Field Summary

Fields
Modifier and Type Field and Description

protected AbstractNeighborhood<T> neighborhood

protected OutOfBounds<T> ra

Fields
Modifier and Type	Field and Description
`protected AbstractNeighborhood<T>`	`neighborhood`
`protected OutOfBounds<T>`	`ra`

Constructor Summary

Constructors
Constructor and Description

AbstractNeighborhoodCursor(AbstractNeighborhood<T> neighborhood)

Constructors
Constructor and Description
`AbstractNeighborhoodCursor(AbstractNeighborhood<T> neighborhood)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`isOutOfBounds()` True if located out of image bounds.
`void`	`jumpFwd(long steps)` This dummy method just calls `Iterator.fwd()` multiple times.
`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()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.imglib2.Cursor
copyCursor

Methods inherited from interface net.imglib2.Sampler
copy

Methods inherited from interface net.imglib2.Iterator
fwd, hasNext, reset

Methods inherited from interface java.util.Iterator
forEachRemaining, hasNext

Methods inherited from interface net.imglib2.Localizable
localize, positionAsLongArray, positionAsPoint

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

- Field Detail
  - neighborhood
```
protected AbstractNeighborhood<T> neighborhood
```
  - ra
```
protected final OutOfBounds<T> ra
```
- Constructor Detail
  - AbstractNeighborhoodCursor
```
public AbstractNeighborhoodCursor(AbstractNeighborhood<T> neighborhood)
```
- Method Detail
  - 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>
  - jumpFwd
```
public void jumpFwd(long steps)
```
    This dummy method just calls Iterator.fwd() multiple times.
    
    Parameters:
    
    steps - number of steps to move forward
  - 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
  - isOutOfBounds
```
public boolean isOutOfBounds()
```
    Description copied from interface: Bounded
    
    True if located out of image bounds.
    
    Specified by:
    
    isOutOfBounds in interface Bounded

Class AbstractNeighborhoodCursor<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.Cursor

Methods inherited from interface net.imglib2.Sampler

Methods inherited from interface net.imglib2.Iterator

Methods inherited from interface java.util.Iterator

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Field Detail

neighborhood

ra

Constructor Detail

AbstractNeighborhoodCursor

Method Detail

localize

localize

getFloatPosition

getDoublePosition

numDimensions

get

jumpFwd

next

remove

localize

localize

getIntPosition

getLongPosition

isOutOfBounds