Class PlanarCursor<T extends NativeType<T>>

java.lang.Object
net.imglib2.AbstractEuclideanSpace
net.imglib2.AbstractCursorInt<T>
net.imglib2.img.planar.PlanarCursor<T>
Type Parameters:
T -
All Implemented Interfaces:
Iterator<T>, Cursor<T>, EuclideanSpace, PlanarImg.PlanarContainerSampler, Iterator, Localizable, RealCursor<T>, RealLocalizable, Sampler<T>, Typed<T>
Direct Known Subclasses:
PlanarCursor1D, PlanarCursor2D
public class PlanarCursor<T extends NativeType<T>> extends AbstractCursorInt<T> implements PlanarImg.PlanarContainerSampler
Basic Iterator for PlanarContainers

  • Field Details

    • type

      protected final T extends NativeType<T> type

    • typeIndex

      protected final Index typeIndex

    • container

      protected final PlanarImg<T extends NativeType<T>, ?> container

    • lastIndex

      protected final int lastIndex

    • lastSliceIndex

      protected final int lastSliceIndex

    • sliceIndex

      protected int sliceIndex

    • index

      protected int index
      The current index of the type. It is faster to duplicate this here than to access it through type.getIndex().

  • Constructor Details

    • PlanarCursor

      protected PlanarCursor(PlanarCursor<T> cursor)

    • PlanarCursor

      public PlanarCursor(PlanarImg<T,?> container)

  • Method Details

    • getCurrentSliceIndex

      public int getCurrentSliceIndex()
      Specified by:
      getCurrentSliceIndex in interface PlanarImg.PlanarContainerSampler
      Returns:
      the index of the slice the sampler is currently accessing.

    • 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 extends NativeType<T>>

    • getType

      public T getType()
      Description copied from interface: Typed
      Get an instance of T.

      It should not be assumed that the returned T instance is an independent copy. In particular, repeated calls to getType() may return the same instance.

      Specified by:
      getType in interface Sampler<T extends NativeType<T>>
      Specified by:
      getType in interface Typed<T extends NativeType<T>>
      Returns:
      an instance of T

    • copy

      public PlanarCursor<T> copy()
      Specified by:
      copy in interface Cursor<T extends NativeType<T>>
      Specified by:
      copy in interface RealCursor<T extends NativeType<T>>
      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)

    • hasNext

      public boolean hasNext()
      Note: This test is fragile in a sense that it returns true for elements after the last element as well.
      Specified by:
      hasNext in interface Iterator<T extends NativeType<T>>
      Specified by:
      hasNext in interface Iterator
      Returns:
      false for the last element

    • fwd

      public void fwd()
      Description copied from interface: Iterator
      Move forward.
      Specified by:
      fwd in interface Iterator

    • jumpFwd

      public void jumpFwd(long steps)
      Description copied from interface: Iterator
      Move steps × forward.

      Highly recommended to override this with a more efficient version.

      Specified by:
      jumpFwd in interface Iterator
      Parameters:
      steps - number of steps to move forward

    • reset

      public void reset()
      Description copied from interface: Iterator
      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 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, length must be ≥ EuclideanSpace.numDimensions()

    • 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
      Parameters:
      dim - dimension
      Returns:
      dimension of current position