Class AbstractArrayLocalizingCursor<T extends NativeType<T>>

Type Parameters:
T -
All Implemented Interfaces:
Iterator<T>, Cursor<T>, EuclideanSpace, Iterator, 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 Details

    • 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 Details

    • 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 Details

    • 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()
      Returns true if another step forward is possible.
      Returns:
      true, if there is another step forward is possible, otherwise false
    • fwd

      public void fwd()
      Move forward.
    • jumpFwd

      public void jumpFwd(long steps)
      Move steps × forward.
      Specified by:
      jumpFwd in interface Iterator
      Overrides:
      jumpFwd in class AbstractLocalizingCursorInt<T extends NativeType<T>>
      Parameters:
      steps - number of steps to move forward
    • reset

      public void reset()
      Reset the Iterator, that is put it to where it would be if newly created.