Package net.imglib2.outofbounds

Class OutOfBoundsPeriodic<T>

java.lang.Object
net.imglib2.AbstractEuclideanSpace
net.imglib2.AbstractLocalizable
net.imglib2.outofbounds.OutOfBoundsPeriodic<T>
Type Parameters:
T -
All Implemented Interfaces:
EuclideanSpace, Localizable, Bounded, OutOfBounds<T>, Positionable, RandomAccess<T>, RealLocalizable, Sampler<T>
public class OutOfBoundsPeriodic<T> extends AbstractLocalizable implements OutOfBounds<T>
Coordinates out of image bounds are periodically repeated. 
 
 Example:

 width=4

                                  |<-inside->|
 x:    -9 -8 -7 -6 -5 -4 -3 -2 -1  0  1  2  3  4  5  6  7  8  9
 f(x):  3  0  1  2  3  0  1  2  3  0  1  2  3  0  1  2  3  0  1
Author:
Stephan Saalfeld

  • Field Details

    • outOfBoundsRandomAccess

      protected final RandomAccess<T> outOfBoundsRandomAccess

    • dimension

      protected final long[] dimension
      Dimensions of the wrapped RandomAccessible.

    • min

      protected final long[] min
      Minimum of the wrapped RandomAccessible.

    • beforeMin

      protected final long[] beforeMin

    • max

      protected final long[] max
      Maximum of the wrapped RandomAccessible.

    • pastMax

      protected final long[] pastMax

    • dimIsOutOfBounds

      protected final boolean[] dimIsOutOfBounds

    • isOutOfBounds

      protected boolean isOutOfBounds

  • Constructor Details

    • OutOfBoundsPeriodic

      public OutOfBoundsPeriodic(OutOfBoundsPeriodic<T> outOfBounds)

    • OutOfBoundsPeriodic

      public OutOfBoundsPeriodic(F f)

  • Method Details

    • checkOutOfBounds

      protected final void checkOutOfBounds()

    • isOutOfBounds

      public boolean isOutOfBounds()
      Description copied from interface: Bounded
      True if located out of image bounds.
      Specified by:
      isOutOfBounds in interface Bounded

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

    • copy

      public final OutOfBoundsPeriodic<T> copy()
      Specified by:
      copy in interface OutOfBounds<T>
      Specified by:
      copy in interface Sampler<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 final OutOfBoundsPeriodic<T> copyRandomAccess()
      Specified by:
      copyRandomAccess in interface RandomAccess<T>

    • fwd

      public final 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 final void bck(int d)
      Description copied from interface: Positionable
      Move by -1 in one dimension.
      Specified by:
      bck in interface Positionable
      Parameters:
      d - dimension

    • setPosition

      public final void setPosition(long position, int d)
      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
      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(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(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 position, int d)
      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
      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[] position)
      Description copied from interface: Positionable
      Set the position of the element.
      Specified by:
      setPosition in interface Positionable
      Parameters:
      position - absolute position, length must be ≥ EuclideanSpace.numDimensions()

    • setPosition

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

    • toString

      public String toString()
      Overrides:
      toString in class Object