Class PlanarRandomAccess<T extends NativeType<T>>

java.lang.Object
net.imglib2.AbstractEuclideanSpace
net.imglib2.AbstractLocalizableInt
net.imglib2.img.planar.PlanarRandomAccess<T>
Type Parameters:
T -
All Implemented Interfaces:
EuclideanSpace, PlanarImg.PlanarContainerSampler, Localizable, Positionable, RandomAccess<T>, RealLocalizable, Sampler<T>, Typed<T>
Direct Known Subclasses:
PlanarRandomAccess1D
public class PlanarRandomAccess<T extends NativeType<T>> extends AbstractLocalizableInt implements RandomAccess<T>, PlanarImg.PlanarContainerSampler
RandomAccess on a PlanarImg.

  • Field Details

    • sliceSteps

      protected final int[] sliceSteps

    • width

      protected final int width

    • type

      protected final T extends NativeType<T> type

    • typeIndex

      protected final Index typeIndex

    • sliceIndex

      protected int sliceIndex

  • Constructor Details

    • PlanarRandomAccess

      protected PlanarRandomAccess(PlanarRandomAccess<T> randomAccess)

    • PlanarRandomAccess

      public PlanarRandomAccess(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 PlanarRandomAccess<T> copy()
      Specified by:
      copy in interface RandomAccess<T extends NativeType<T>>
      Specified by:
      copy in interface Sampler<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)

    • fwd

      public void fwd(int d)
      Description copied from interface: Positionable
      Move by 1 in one dimension.
      Specified by:
      fwd in interface Positionable
      Parameters:
      d - dimension

    • bck

      public void bck(int d)
      Description copied from interface: Positionable
      Move by -1 in one dimension.
      Specified by:
      bck in interface Positionable
      Parameters:
      d - dimension

    • move

      public void move(int distance, int d)
      Description copied from interface: Positionable
      Move the element in one dimension for some distance.
      Specified by:
      move in interface Positionable
      Parameters:
      distance - relative offset in dimension d
      d - dimension

    • move

      public void move(long distance, int d)
      Description copied from interface: Positionable
      Move the element in one dimension for some distance.
      Specified by:
      move in interface Positionable
      Parameters:
      distance - relative offset in dimension d
      d - dimension

    • move

      public void move(Localizable localizable)
      Description copied from interface: Positionable
      Move the element relative to its current location using an Localizable as distance vector.
      Specified by:
      move in interface Positionable
      Parameters:
      localizable - relative offset, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()

    • move

      public void move(int[] distance)
      Description copied from interface: Positionable
      Move the element relative to its current location using an int[] as distance vector.
      Specified by:
      move in interface Positionable
      Parameters:
      distance - relative offset, length must be ≥ EuclideanSpace.numDimensions()

    • move

      public void move(long[] distance)
      Description copied from interface: Positionable
      Move the element relative to its current location using a long[] as distance vector.
      Specified by:
      move in interface Positionable
      Parameters:
      distance - relative offset, length must be ≥ EuclideanSpace.numDimensions()

    • setPosition

      public void setPosition(int pos, int d)
      Description copied from interface: Positionable
      Set the position of the element for one dimension.
      Specified by:
      setPosition in interface Positionable
      Parameters:
      pos - absolute position in dimension d
      d - dimension

    • setPosition

      public void setPosition(long pos, int d)
      Description copied from interface: Positionable
      Set the position of the element for one dimension.
      Specified by:
      setPosition in interface Positionable
      Parameters:
      pos - absolute position in dimension d
      d - dimension

    • setPosition

      public void setPosition(Localizable localizable)
      Description copied from interface: Positionable
      Place the element at the same location as a given Localizable
      Specified by:
      setPosition in interface Positionable
      Parameters:
      localizable - absolute position, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()

    • setPosition

      public void setPosition(int[] pos)
      Description copied from interface: Positionable
      Set the position of the element.
      Specified by:
      setPosition in interface Positionable
      Parameters:
      pos - absolute position, length must be ≥ EuclideanSpace.numDimensions()

    • setPosition

      public void setPosition(long[] pos)
      Description copied from interface: Positionable
      Set the position of the element.
      Specified by:
      setPosition in interface Positionable
      Parameters:
      pos - absolute position, length must be ≥ EuclideanSpace.numDimensions()