net.imglib2.img.planar.PlanarPlaneSubsetCursor<T>

Type Parameters:: T -

All Implemented Interfaces:: Iterator<T>, Cursor<T>, EuclideanSpace, PlanarImg.PlanarContainerSampler, Iterator, Localizable, RealCursor<T>, RealLocalizable, Sampler<T>

public class PlanarPlaneSubsetCursor<T extends NativeType<T>> extends AbstractCursorInt<T> implements PlanarImg.PlanarContainerSampler

Basic Iterator for PlanarContainers

Author:: Christian Dietz, Jonathan Hale

Field Summary

Fields inherited from class net.imglib2.AbstractEuclideanSpace
n
Constructor Summary

Constructors

Modifier

Constructor

Description

PlanarPlaneSubsetCursor(PlanarImg<T,?> container, Interval interval)

Constructor

protected

PlanarPlaneSubsetCursor(PlanarPlaneSubsetCursor<T> cursor)

Copy Constructor
Method Summary

Modifier and Type

Method

Description

PlanarPlaneSubsetCursor<T>

copy()

PlanarPlaneSubsetCursor<T>

copyCursor()

final void

fwd()

Move forward.

final T

get()

Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.

final int

getCurrentSliceIndex()

final int

getIntPosition(int dim)

Return the current position in a given dimension.

final boolean

hasNext()

Returns true if another step forward is possible.

final void

jumpFwd(long steps)

Highly recommended to override this with a more efficient version.

final void

localize(int[] position)

Write the current position into the passed array.

final void

reset()

Reset the Iterator, that is put it to where it would be if newly created.

String

toString()

Methods inherited from class net.imglib2.AbstractCursorInt
getDoublePosition, getFloatPosition, getLongPosition, localize, 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 net.imglib2.EuclideanSpace
numDimensions

Methods inherited from interface java.util.Iterator
forEachRemaining

Constructor Details
- PlanarPlaneSubsetCursor
  
  protected PlanarPlaneSubsetCursor(PlanarPlaneSubsetCursor<T> cursor)
  
  Copy Constructor
  
  Parameters:
  
  cursor - - the cursor to copy from.
- PlanarPlaneSubsetCursor
  
  public PlanarPlaneSubsetCursor(PlanarImg<T,?> container, Interval interval)
  
  Constructor
  
  Parameters:
  
  container - - the container this cursor shall work on.
  
  interval - - the interval to iterate over.
Method Details
- getCurrentSliceIndex
  
  public final int getCurrentSliceIndex()
  
  Specified by:
  
  getCurrentSliceIndex in interface PlanarImg.PlanarContainerSampler
  
  Returns:
  
  the index of the slice the sampler is currently accessing.
- get
  
  public final T get()
  
  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 extends NativeType<T>>
- copy
  
  public PlanarPlaneSubsetCursor<T> copy()
  
  Specified by:
  
  copy in interface Sampler<T extends NativeType<T>>
  
  Specified by:
  
  copy in class AbstractCursorInt<T extends NativeType<T>>
  
  Returns:
  
  - A new Sampler in the same state accessing the same values. It does NOT copy T, just the state of the Sampler. Otherwise use T.copy() if available. Sampler.copy().get() == Sampler.get(), i.e. both hold the same value, not necessarily the same instance (this is the case for an ArrayCursor for example)
- copyCursor
  
  public PlanarPlaneSubsetCursor<T> copyCursor()
  
  Specified by:
  
  copyCursor in interface Cursor<T extends NativeType<T>>
  
  Specified by:
  
  copyCursor in interface RealCursor<T extends NativeType<T>>
  
  Specified by:
  
  copyCursor in class AbstractCursorInt<T extends NativeType<T>>
- hasNext
  
  public final boolean hasNext()
  
  Returns true if another step forward is possible.
  
  Specified by:
  
  hasNext in interface Iterator<T extends NativeType<T>>
  
  Specified by:
  
  hasNext in interface Iterator
  
  Returns:
  
  true, if there is another step forward is possible, otherwise false
- fwd
  
  public final void fwd()
  
  Move forward.
  
  Specified by:
  
  fwd in interface Iterator
- jumpFwd
  
  public final void jumpFwd(long steps)
  
  Highly recommended to override this with a more efficient version.
  
  Specified by:
  
  jumpFwd in interface Iterator
  
  Overrides:
  
  jumpFwd in class AbstractCursorInt<T extends NativeType<T>>
  
  Parameters:
  
  steps -
- reset
  
  public final void reset()
  
  Reset the Iterator, that is put it to where it would be if newly created.
  
  Specified by:
  
  reset in interface Iterator
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class AbstractCursorInt<T extends NativeType<T>>
- localize
  
  public final void localize(int[] position)
  
  Write the current position into the passed array.
  
  Specified by:
  
  localize in interface Localizable
  
  Parameters:
  
  position - receives current position
- getIntPosition
  
  public final int getIntPosition(int dim)
  
  Return the current position in a given dimension.
  
  Specified by:
  
  getIntPosition in interface Localizable
  
  Parameters:
  
  dim - dimension
  
  Returns:
  
  dimension of current position

Class PlanarPlaneSubsetCursor<T extends NativeType<T>>

Field Summary

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractCursorInt

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.EuclideanSpace

Methods inherited from interface java.util.Iterator

Constructor Details

PlanarPlaneSubsetCursor

PlanarPlaneSubsetCursor

Method Details

getCurrentSliceIndex

get

copy

copyCursor

hasNext

fwd

jumpFwd

reset

toString

localize

getIntPosition