AbstractUnsafeCursor (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractCursor<T>
  - - net.imglib2.img.unsafe.AbstractUnsafeCursor<T>

Type Parameters:

T -

All Implemented Interfaces:

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

Direct Known Subclasses:

UnsafeCursor, UnsafeSubIntervalCursor
```
public abstract class AbstractUnsafeCursor<T extends NativeLongAccessType<T>>
extends AbstractCursor<T>
```
Cursor on an UnsafeImg.

Author:

Stephan Preibisch, Stephan Saalfeld, Christian Dietz, Tobias Pietzsch

Field Summary

Fields
Modifier and Type	Field and Description
`protected UnsafeImg<T,?>`	`img` Source image
`protected long`	`lastIndex` Last index
`protected long`	`offset` Offset of this cursor
`protected long`	`size` Size of this cursor
`protected T`	`type` An instance of T

Fields inherited from class net.imglib2.AbstractEuclideanSpace
n

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractUnsafeCursor(AbstractUnsafeCursor<T> cursor)` TODO Javadoc
	`AbstractUnsafeCursor(UnsafeImg<T,?> img, long offset, long 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.
`int`	`getIntPosition(int dim)` Return the current position in a given dimension.
`long`	`getLongPosition(int dim)` Return the current position in a given dimension.
`boolean`	`hasNext()`
`void`	`jumpFwd(long steps)` Highly recommended to override this with a more efficient version.
`void`	`localize(int[] position)` Write the current position into the passed array.
`void`	`localize(long[] position)` Write the current position into the passed array.
`void`	`reset()`
`String`	`toString()`

Methods inherited from class net.imglib2.AbstractCursor
copy, copyCursor, getDoublePosition, getFloatPosition, localize, localize, next, remove

Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Field Detail
  - offset
```
protected final long offset
```
    Offset of this cursor
  - size
```
protected final long size
```
    Size of this cursor
  - type
```
protected final T extends NativeLongAccessType<T> type
```
    An instance of T
  - img
```
protected final UnsafeImg<T extends NativeLongAccessType<T>,?> img
```
    Source image
  - lastIndex
```
protected final long lastIndex
```
    Last index
- Constructor Detail
  - AbstractUnsafeCursor
```
protected AbstractUnsafeCursor(AbstractUnsafeCursor<T> cursor)
```
    TODO Javadoc
    
    Parameters:
    
    cursor -
  - AbstractUnsafeCursor
```
public AbstractUnsafeCursor(UnsafeImg<T,?> img,
                            long offset,
                            long size)
```
    TODO Javadoc
    
    Parameters:
    
    img -
    
    offset -
    
    size -
- Method Detail
  - 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.
  - hasNext
```
public boolean hasNext()
```
  - jumpFwd
```
public void jumpFwd(long steps)
```
    Description copied from class: AbstractCursor
    
    Highly recommended to override this with a more efficient version.
    
    Overrides:
    
    jumpFwd in class AbstractCursor<T extends NativeLongAccessType<T>>
    
    Parameters:
    
    steps - number of steps to move forward
  - fwd
```
public void fwd()
```
  - reset
```
public void reset()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractCursor<T extends NativeLongAccessType<T>>
  - getIntPosition
```
public int getIntPosition(int dim)
```
    Description copied from interface: Localizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getIntPosition in interface Localizable
    
    Overrides:
    
    getIntPosition in class AbstractCursor<T extends NativeLongAccessType<T>>
    
    Parameters:
    
    dim - dimension
    
    Returns:
    
    dimension of current position
  - 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
    
    Overrides:
    
    localize in class AbstractCursor<T extends NativeLongAccessType<T>>
    
    Parameters:
    
    position - receives current position
  - getLongPosition
```
public long getLongPosition(int dim)
```
    Description copied from interface: Localizable
    
    Return the current position in a given dimension.
    
    Parameters:
    
    dim - dimension
    
    Returns:
    
    dimension of current position
  - localize
```
public void localize(long[] position)
```
    Description copied from interface: Localizable
    
    Write the current position into the passed array.
    
    Parameters:
    
    position - receives current position

Class AbstractUnsafeCursor<T extends NativeLongAccessType<T>>

Field Summary

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractCursor

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

offset

size

type

img

lastIndex

Constructor Detail

AbstractUnsafeCursor

AbstractUnsafeCursor

Method Detail

get

hasNext

jumpFwd

fwd

reset

toString

getIntPosition

localize

getLongPosition

localize