java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.outofbounds.RealOutOfBoundsRealRandomAccess<T>

Type Parameters:: T -

All Implemented Interfaces:: EuclideanSpace, Bounded, Positionable, RealLocalizable, RealPositionable, RealRandomAccess<T>, Sampler<T>

public final class RealOutOfBoundsRealRandomAccess<T> extends AbstractEuclideanSpace implements RealRandomAccess<T>, Bounded

Author:: Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch

Field Summary

Fields

Modifier and Type

Field

Description

protected final RealOutOfBounds<T>

outOfBounds

performs the actual moves and generates/queries a Type

Fields inherited from class net.imglib2.AbstractEuclideanSpace
n
Constructor Summary

Constructors

Constructor

Description

RealOutOfBoundsRealRandomAccess(int n, RealOutOfBounds<T> outOfBounds)

RealOutOfBoundsRealRandomAccess(RealOutOfBoundsRealRandomAccess<T> realOutOfBoundsRealRandomAccess)
Method Summary

Modifier and Type

Method

Description

void

bck(int d)

Move by -1 in one dimension.

RealOutOfBoundsRealRandomAccess<T>

copy()

RealOutOfBoundsRealRandomAccess<T>

copyRealRandomAccess()

void

fwd(int d)

Move by 1 in one dimension.

T

get()

Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.

final double

getDoublePosition(int dim)

Return the current position in a given dimension.

final float

getFloatPosition(int dim)

Return the current position in a given dimension.

boolean

isOutOfBounds()

True if located out of image bounds.

final void

localize(double[] position)

Write the current position into the passed array.

final void

localize(float[] position)

Write the current position into the passed array.

void

move(double[] distance)

Move the element relative to its current location using a float[] as distance vector.

void

move(double distance, int d)

Move the element in one dimension for some distance.

void

move(float[] distance)

Move the element relative to its current location using a float[] as distance vector.

void

move(float distance, int d)

Move the element in one dimension for some distance.

void

move(int[] distance)

Move the element relative to its current location using an int[] as distance vector.

void

move(int distance, int d)

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.

void

move(RealLocalizable localizable)

Move the element relative to its current location using a RealLocalizable as distance vector.

void

setPosition(double[] position)

Set the position of the element.

void

setPosition(double position, int d)

Set the position of the element for one dimension.

void

setPosition(float[] position)

Set the position of the element.

void

setPosition(float position, int d)

Set the position of the element for one dimension.

void

setPosition(int[] position)

Set the position of the element.

void

setPosition(int position, int d)

Set the position of the element for one dimension.

void

setPosition(long[] position)

Set the position of the element.

void

setPosition(long position, 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

void

setPosition(RealLocalizable localizable)

Place the element at the same location as a given RealLocalizable

Methods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

Field Details
- outOfBounds
  
  protected final RealOutOfBounds<T> outOfBounds
  
  performs the actual moves and generates/queries a Type
Constructor Details
- RealOutOfBoundsRealRandomAccess
  
  public RealOutOfBoundsRealRandomAccess(RealOutOfBoundsRealRandomAccess<T> realOutOfBoundsRealRandomAccess)
  
  Parameters:
  
  realOutOfBoundsRealRandomAccess -
- RealOutOfBoundsRealRandomAccess
  
  public RealOutOfBoundsRealRandomAccess(int n, RealOutOfBounds<T> outOfBounds)
  
  Parameters:
  
  n - number of dimensions in the RealRandomAccessible.
  
  outOfBounds -
Method Details
- 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 RealOutOfBoundsRealRandomAccess<T> copy()
  
  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)
- copyRealRandomAccess
  
  public RealOutOfBoundsRealRandomAccess<T> copyRealRandomAccess()
  
  Specified by:
  
  copyRealRandomAccess in interface RealRandomAccess<T>
- localize
  
  public final void localize(float[] position)
  
  Description copied from interface: RealLocalizable
  
  Write the current position into the passed array.
  
  Specified by:
  
  localize in interface RealLocalizable
  
  Parameters:
  
  position - receives current position
- localize
  
  public final void localize(double[] position)
  
  Description copied from interface: RealLocalizable
  
  Write the current position into the passed array.
  
  Specified by:
  
  localize in interface RealLocalizable
  
  Parameters:
  
  position - receives current position
- getDoublePosition
  
  public final 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
- getFloatPosition
  
  public final 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
- move
  
  public void move(float distance, int d)
  
  Description copied from interface: RealPositionable
  
  Move the element in one dimension for some distance.
  
  Specified by:
  
  move in interface RealPositionable
  
  Parameters:
  
  distance -
  
  d -
- move
  
  public void move(double distance, int d)
  
  Description copied from interface: RealPositionable
  
  Move the element in one dimension for some distance.
  
  Specified by:
  
  move in interface RealPositionable
  
  Parameters:
  
  distance -
  
  d -
- move
  
  public void move(RealLocalizable localizable)
  
  Description copied from interface: RealPositionable
  
  Move the element relative to its current location using a RealLocalizable as distance vector.
  
  Specified by:
  
  move in interface RealPositionable
  
  Parameters:
  
  localizable - relative offset, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
- move
  
  public void move(float[] distance)
  
  Description copied from interface: RealPositionable
  
  Move the element relative to its current location using a float[] as distance vector.
  
  Specified by:
  
  move in interface RealPositionable
  
  Parameters:
  
  distance - , length must be ≥ EuclideanSpace.numDimensions()
- move
  
  public void move(double[] distance)
  
  Description copied from interface: RealPositionable
  
  Move the element relative to its current location using a float[] as distance vector.
  
  Specified by:
  
  move in interface RealPositionable
  
  Parameters:
  
  distance - , length must be ≥ EuclideanSpace.numDimensions()
- setPosition
  
  public void setPosition(RealLocalizable localizable)
  
  Description copied from interface: RealPositionable
  
  Place the element at the same location as a given RealLocalizable
  
  Specified by:
  
  setPosition in interface RealPositionable
  
  Parameters:
  
  localizable - absolute position, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
- setPosition
  
  public void setPosition(float[] position)
  
  Description copied from interface: RealPositionable
  
  Set the position of the element.
  
  Specified by:
  
  setPosition in interface RealPositionable
  
  Parameters:
  
  position - absolute position, length must be ≥ EuclideanSpace.numDimensions()
- setPosition
  
  public void setPosition(double[] position)
  
  Description copied from interface: RealPositionable
  
  Set the position of the element.
  
  Specified by:
  
  setPosition in interface RealPositionable
  
  Parameters:
  
  position - absolute position, length must be ≥ EuclideanSpace.numDimensions()
- setPosition
  
  public void setPosition(float position, int d)
  
  Description copied from interface: RealPositionable
  
  Set the position of the element for one dimension.
  
  Specified by:
  
  setPosition in interface RealPositionable
  
  Parameters:
  
  position -
  
  d -
- setPosition
  
  public void setPosition(double position, int d)
  
  Description copied from interface: RealPositionable
  
  Set the position of the element for one dimension.
  
  Specified by:
  
  setPosition in interface RealPositionable
  
  Parameters:
  
  position -
  
  d -
- 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(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()
- 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(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

Class RealOutOfBoundsRealRandomAccess<T>

Field Summary

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.EuclideanSpace

Field Details

outOfBounds

Constructor Details

RealOutOfBoundsRealRandomAccess

RealOutOfBoundsRealRandomAccess

Method Details

isOutOfBounds

get

copy

copyRealRandomAccess

localize

localize

getDoublePosition

getFloatPosition

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

fwd

bck

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition