AbstractUnsafeLocalizingCursor (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractLocalizable
  - - net.imglib2.AbstractLocalizingCursor<T>
    - - net.imglib2.img.unsafe.AbstractUnsafeLocalizingCursor<T>

Type Parameters:

T -

All Implemented Interfaces:

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

Direct Known Subclasses:

UnsafeLocalizingCursor, UnsafeLocalizingSubIntervalCursor
```
public abstract class AbstractUnsafeLocalizingCursor<T extends NativeLongAccessType<T>>
extends AbstractLocalizingCursor<T>
```
Localizing 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` The underlying source `UnsafeImg`.
`protected Long`	`lastIndex` Last index.
`protected int[]`	`max` Maximum of the `UnsafeImg` in every dimension.
`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.AbstractLocalizable
position

Fields inherited from class net.imglib2.AbstractEuclideanSpace
n

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractUnsafeLocalizingCursor(AbstractUnsafeLocalizingCursor<T> cursor)` TODO Javadoc
	`AbstractUnsafeLocalizingCursor(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.
`boolean`	`hasNext()`
`void`	`jumpFwd(long steps)` Move steps × forward.
`void`	`reset()`

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

Methods inherited from class net.imglib2.AbstractLocalizable
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 long size
```
    Size of this cursor.
  - offset
```
protected final long offset
```
    Offset of this cursor.
  - type
```
protected final T extends NativeLongAccessType<T> type
```
    An instance of T.
  - img
```
protected final UnsafeImg<T extends NativeLongAccessType<T>,?> img
```
    The underlying source UnsafeImg.
  - lastIndex
```
protected final Long lastIndex
```
    Last index.
  - max
```
protected final int[] max
```
    Maximum of the UnsafeImg in every dimension. This is used to check isOutOfBounds().
- Constructor Detail
  - AbstractUnsafeLocalizingCursor
```
protected AbstractUnsafeLocalizingCursor(AbstractUnsafeLocalizingCursor<T> cursor)
```
    TODO Javadoc
    
    Parameters:
    
    cursor -
  - AbstractUnsafeLocalizingCursor
```
public AbstractUnsafeLocalizingCursor(UnsafeImg<T,?> img,
                                      long offset,
                                      long 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 AbstractLocalizingCursor<T extends NativeLongAccessType<T>>
    
    Parameters:
    
    steps - number of steps to move forward
  - reset
```
public void reset()
```

Class AbstractUnsafeLocalizingCursor<T extends NativeLongAccessType<T>>

Field Summary

Fields inherited from class net.imglib2.AbstractLocalizable

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractLocalizingCursor

Methods inherited from class net.imglib2.AbstractLocalizable

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

AbstractUnsafeLocalizingCursor

AbstractUnsafeLocalizingCursor

Method Detail

get

hasNext

fwd

jumpFwd

reset