Class NtreeRandomAccess<T extends NativeType<T>>

java.lang.Object
net.imglib2.img.sparse.NtreeRandomAccess<T>
All Implemented Interfaces:
EuclideanSpace, NtreeImg.PositionProvider, Localizable, Positionable, RandomAccess<T>, RealLocalizable, Sampler<T>

public final class NtreeRandomAccess<T extends NativeType<T>> extends Object implements NtreeImg.PositionProvider, RandomAccess<T>
Author:
Tobias Pietzsch
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    bck(int d)
    Move by -1 in one dimension.
     
     
    void
    fwd(int d)
    Move by 1 in one dimension.
    get()
    Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
    double
    Return the current position in a given dimension.
    float
    Return the current position in a given dimension.
    int
    getIntPosition(int dim)
    Return the current position in a given dimension.
    long
    getLongPosition(int dim)
    Return the current position in a given dimension.
    long[]
     
    void
    localize(double[] pos)
    Write the current position into the passed array.
    void
    localize(float[] pos)
    Write the current position into the passed array.
    void
    localize(int[] pos)
    Write the current position into the passed array.
    void
    localize(long[] pos)
    Write the current position into the passed array.
    void
    move(int[] distance)
    Move the element relative to its current location using an int[] as distance vector.
    void
    move(int distance, int dim)
    Move the element in one dimension for some distance.
    void
    move(long[] distance)
    Move the element relative to its current location using a long[] as distance vector.
    void
    move(long distance, int d)
    Move the element in one dimension for some distance.
    void
    move(Localizable localizable)
    Move the element relative to its current location using an Localizable as distance vector.
    int
    Gets the space's number of dimensions.
    void
    setPosition(int[] pos)
    Set the position of the element.
    void
    setPosition(int position, int dim)
    Set the position of the element for one dimension.
    void
    setPosition(long[] pos)
    Set the position of the element.
    void
    setPosition(long pos, int d)
    Set the position of the element for one dimension.
    void
    setPosition(Localizable localizable)
    Place the element at the same location as a given Localizable
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • NtreeRandomAccess

      public NtreeRandomAccess(NtreeImg<T,?> img)
  • Method Details

    • 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(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
    • 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()
    • 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
    • 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>>
    • copy

      public NtreeRandomAccess<T> copy()
      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)
    • copyRandomAccess

      public NtreeRandomAccess<T> copyRandomAccess()
      Specified by:
      copyRandomAccess in interface RandomAccess<T extends NativeType<T>>
    • getPosition

      public long[] getPosition()
      Specified by:
      getPosition in interface NtreeImg.PositionProvider
    • move

      public void move(int distance, int dim)
      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
      dim - dimension
    • setPosition

      public void setPosition(int position, int dim)
      Description copied from interface: Positionable
      Set the position of the element for one dimension.
      Specified by:
      setPosition in interface Positionable
      Parameters:
      position - absolute position in dimension d
      dim - dimension
    • 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()
    • 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()
    • 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()
    • localize

      public void localize(float[] pos)
      Description copied from interface: RealLocalizable
      Write the current position into the passed array.
      Specified by:
      localize in interface RealLocalizable
      Parameters:
      pos - receives current position
    • localize

      public void localize(double[] pos)
      Description copied from interface: RealLocalizable
      Write the current position into the passed array.
      Specified by:
      localize in interface RealLocalizable
      Parameters:
      pos - receives current position
    • localize

      public void localize(int[] pos)
      Description copied from interface: Localizable
      Write the current position into the passed array.
      Specified by:
      localize in interface Localizable
      Parameters:
      pos - receives current position
    • localize

      public void localize(long[] pos)
      Description copied from interface: Localizable
      Write the current position into the passed array.
      Specified by:
      localize in interface Localizable
      Parameters:
      pos - receives current position
    • getFloatPosition

      public float getFloatPosition(int dim)
      Description copied from interface: RealLocalizable
      Return the current position in a given dimension.
      Specified by:
      getFloatPosition in interface RealLocalizable
      Parameters:
      dim - dimension
      Returns:
      dimension of current position
    • getDoublePosition

      public double getDoublePosition(int dim)
      Description copied from interface: RealLocalizable
      Return the current position in a given dimension.
      Specified by:
      getDoublePosition in interface RealLocalizable
      Parameters:
      dim - dimension
      Returns:
      dimension of current position
    • 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
    • getLongPosition

      public long getLongPosition(int dim)
      Description copied from interface: Localizable
      Return the current position in a given dimension.
      Specified by:
      getLongPosition in interface Localizable
      Parameters:
      dim - dimension
      Returns:
      dimension of current position
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • numDimensions

      public int numDimensions()
      Description copied from interface: EuclideanSpace
      Gets the space's number of dimensions.
      Specified by:
      numDimensions in interface EuclideanSpace