AbstractArrayLocalizingCursor (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractLocalizableInt
  - - net.imglib2.AbstractLocalizingCursorInt<T>
    - - net.imglib2.img.array.AbstractArrayLocalizingCursor<T>

Type Parameters:

T -

All Implemented Interfaces:

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

Direct Known Subclasses:

ArrayLocalizingCursor, ArrayLocalizingSubIntervalCursor
```
public abstract class AbstractArrayLocalizingCursor<T extends NativeType<T>>
extends AbstractLocalizingCursorInt<T>
```
Localizing Cursor on an ArrayImg.

Author:

Stephan Preibisch, Stephan Saalfeld, Christian Dietz, Tobias Pietzsch

Field Summary

Fields
Modifier and Type	Field and Description
`protected ArrayImg<T,?>`	`img` The underlying source `ArrayImg`.
`protected int`	`lastIndex` Last index.
`protected int[]`	`max` Maximum of the `ArrayImg` in every dimension.
`protected int`	`offset` Offset of this cursor.
`protected int`	`size` Size of this cursor.
`protected T`	`type` An instance of T.

Fields inherited from class net.imglib2.AbstractLocalizableInt
position

Fields inherited from class net.imglib2.AbstractEuclideanSpace
n

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractArrayLocalizingCursor(AbstractArrayLocalizingCursor<T> cursor)` TODO Javadoc
	`AbstractArrayLocalizingCursor(ArrayImg<T,?> img, int offset, int size)` TODO Javadoc

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`fwd()`
`T`	`get()` Access the actual T instance providing access to a pixel, sub-pixel or integral region value the `Sampler` points at.
`boolean`	`hasNext()`
`void`	`jumpFwd(long steps)` Move steps × forward.
`void`	`reset()`

Methods inherited from class net.imglib2.AbstractLocalizingCursorInt
copy, copyCursor, next, remove

Methods inherited from class net.imglib2.AbstractLocalizableInt
getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, localize

Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions

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
getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, positionAsLongArray, positionAsPoint

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

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Field Detail
  - size
```
protected final int size
```
    Size of this cursor.
  - offset
```
protected final int offset
```
    Offset of this cursor.
  - type
```
protected final T extends NativeType<T> type
```
    An instance of T.
  - img
```
protected final ArrayImg<T extends NativeType<T>,?> img
```
    The underlying source ArrayImg.
  - lastIndex
```
protected final int lastIndex
```
    Last index.
  - max
```
protected final int[] max
```
    Maximum of the ArrayImg in every dimension. This is used to check isOutOfBounds().
- Constructor Detail
  - AbstractArrayLocalizingCursor
```
protected AbstractArrayLocalizingCursor(AbstractArrayLocalizingCursor<T> cursor)
```
    TODO Javadoc
    
    Parameters:
    
    cursor -
  - AbstractArrayLocalizingCursor
```
public AbstractArrayLocalizingCursor(ArrayImg<T,?> img,
                                     int offset,
                                     int size)
```
    TODO Javadoc
    
    Parameters:
    
    img -
    
    offset -
    
    size -
- Method Detail
  - get
```
public T get()
```
    Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
  - hasNext
```
public boolean hasNext()
```
  - fwd
```
public void fwd()
```
  - jumpFwd
```
public void jumpFwd(long steps)
```
    Move steps × forward.
    
    Overrides:
    
    jumpFwd in class AbstractLocalizingCursorInt<T extends NativeType<T>>
    
    Parameters:
    
    steps - number of steps to move forward
  - reset
```
public void reset()
```

Class AbstractArrayLocalizingCursor<T extends NativeType<T>>

Field Summary

Fields inherited from class net.imglib2.AbstractLocalizableInt

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractLocalizingCursorInt

Methods inherited from class net.imglib2.AbstractLocalizableInt

Methods inherited from class net.imglib2.AbstractEuclideanSpace

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

Methods inherited from interface net.imglib2.EuclideanSpace

Field Detail

size

offset

type

img

lastIndex

max

Constructor Detail

AbstractArrayLocalizingCursor

AbstractArrayLocalizingCursor

Method Detail

get

hasNext

fwd

jumpFwd

reset