NearestNeighborRealRandomAccessibleStackInterpolator (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.interpolation.stack.NearestNeighborRealRandomAccessibleStackInterpolator<T>

Type Parameters:

T - the pixel type

All Implemented Interfaces:

EuclideanSpace, Positionable, RealLocalizable, RealPositionable, RealRandomAccess<T>, Sampler<T>

Direct Known Subclasses:

LinearRealRandomAccessibleStackInterpolator
```
public class NearestNeighborRealRandomAccessibleStackInterpolator<T>
extends AbstractEuclideanSpace
implements RealRandomAccess<T>
```
A nearest neighbor interpolator for stacks of RealRandomAccessibles.
When changing any dimension of the position, except the (n+1)th, this position change is applied to the active slice RealRandomAccess. When changing the (n+1)th dimension of the position, a new slice RealRandomAccess becomes active, is set to the position of the previously active slice RealRandomAccess. Initially, only a RealRandomAccess for the first slice is created, other slice RealRandomAccesses are created on demand but stored for later re-use.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`lastSliceIndex`
`protected double[]`	`position`
`protected int`	`sd`
`protected RealRandomAccess<T>`	`sliceAccess`
`protected RealRandomAccess<T>[]`	`sliceAccesses`
`protected int`	`sliceIndex`
`protected RealRandomAccessible<T>[]`	`slices`

Fields inherited from class net.imglib2.AbstractEuclideanSpace
n

Constructor Summary

Constructors
Modifier	Constructor and Description
	`NearestNeighborRealRandomAccessibleStackInterpolator(List<RealRandomAccessible<T>> slices)`
`protected`	`NearestNeighborRealRandomAccessibleStackInterpolator(NearestNeighborRealRandomAccessibleStackInterpolator<T> a)`
	`NearestNeighborRealRandomAccessibleStackInterpolator(RealRandomAccessible<T>[] slices)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bck(int d)` Move by -1 in one dimension.
`NearestNeighborRealRandomAccessibleStackInterpolator<T>`	`copy()`
`NearestNeighborRealRandomAccessibleStackInterpolator<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.
`double`	`getDoublePosition(int d)` Return the current position in a given dimension.
`float`	`getFloatPosition(int d)` Return the current position in a given dimension.
`protected RealRandomAccess<T>`	`getOrCreateAccess(int i)`
`protected int`	`getSliceIndex(double position)`
`void`	`localize(double[] position)` Write the current position into the passed array.
`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(Localizable distance)` Move the element relative to its current location using an `Localizable` as distance vector.
`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(RealLocalizable distance)` 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 pos, int d)` Set the position of the element for one dimension.
`void`	`setPosition(float[] position)` Set the position of the element.
`void`	`setPosition(float pos, int d)` Set the position of the element for one dimension.
`void`	`setPosition(int[] position)` Set the position of the element.
`void`	`setPosition(int pos, int d)` Set the position of the element for one dimension.
`void`	`setPosition(Localizable position)` Place the element at the same location as a given `Localizable`
`void`	`setPosition(long[] position)` Set the position of the element.
`void`	`setPosition(long pos, int d)` Set the position of the element for one dimension.
`void`	`setPosition(RealLocalizable position)` Place the element at the same location as a given `RealLocalizable`
`protected void`	`setSlice(int i)`
`protected void`	`updateSlice(int i)`

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.RealRandomAccess
setPositionAndGet, setPositionAndGet, setPositionAndGet

Methods inherited from interface net.imglib2.RealLocalizable
localize, positionAsDoubleArray, positionAsRealPoint

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Field Detail
  - position
```
protected final double[] position
```
  - sd
```
protected final int sd
```
  - sliceAccess
```
protected RealRandomAccess<T> sliceAccess
```
  - slices
```
protected final RealRandomAccessible<T>[] slices
```
  - sliceAccesses
```
protected final RealRandomAccess<T>[] sliceAccesses
```
  - sliceIndex
```
protected int sliceIndex
```
  - lastSliceIndex
```
protected final int lastSliceIndex
```
- Constructor Detail
  - NearestNeighborRealRandomAccessibleStackInterpolator
```
public NearestNeighborRealRandomAccessibleStackInterpolator(RealRandomAccessible<T>[] slices)
```
  - NearestNeighborRealRandomAccessibleStackInterpolator
```
public NearestNeighborRealRandomAccessibleStackInterpolator(List<RealRandomAccessible<T>> slices)
```
  - NearestNeighborRealRandomAccessibleStackInterpolator
```
protected NearestNeighborRealRandomAccessibleStackInterpolator(NearestNeighborRealRandomAccessibleStackInterpolator<T> a)
```
- Method Detail
  - getSliceIndex
```
protected int getSliceIndex(double position)
```
  - getOrCreateAccess
```
protected RealRandomAccess<T> getOrCreateAccess(int i)
```
  - setSlice
```
protected void setSlice(int i)
```
  - updateSlice
```
protected void updateSlice(int i)
```
  - localize
```
public 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 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
  - getFloatPosition
```
public float getFloatPosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getDoublePosition
```
public double getDoublePosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - 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(float distance,
                 int d)
```
    Description copied from interface: RealPositionable
    
    Move the element in one dimension for some distance.
    
    Specified by:
    
    move in interface RealPositionable
  - 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
  - move
```
public void move(RealLocalizable distance)
```
    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:
    
    distance - relative offset, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - move
```
public void move(Localizable distance)
```
    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:
    
    distance - 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()
  - 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
  - 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
  - setPosition
```
public void setPosition(Localizable position)
```
    Description copied from interface: Positionable
    
    Place the element at the same location as a given Localizable
    
    Specified by:
    
    setPosition in interface Positionable
    
    Parameters:
    
    position - absolute position, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()
  - setPosition
```
public void setPosition(RealLocalizable position)
```
    Description copied from interface: RealPositionable
    
    Place the element at the same location as a given RealLocalizable
    
    Specified by:
    
    setPosition in interface RealPositionable
    
    Parameters:
    
    position - 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(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)
```
    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(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(float pos,
                        int d)
```
    Description copied from interface: RealPositionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface RealPositionable
  - setPosition
```
public void setPosition(double pos,
                        int d)
```
    Description copied from interface: RealPositionable
    
    Set the position of the element for one dimension.
    
    Specified by:
    
    setPosition in interface RealPositionable
  - 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 NearestNeighborRealRandomAccessibleStackInterpolator<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 NearestNeighborRealRandomAccessibleStackInterpolator<T> copyRealRandomAccess()
```
    Specified by:
    
    copyRealRandomAccess in interface RealRandomAccess<T>

Class NearestNeighborRealRandomAccessibleStackInterpolator<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.RealRandomAccess

Methods inherited from interface net.imglib2.RealLocalizable

Methods inherited from interface net.imglib2.EuclideanSpace

Field Detail

position

sd

sliceAccess

slices

sliceAccesses

sliceIndex

lastSliceIndex

Constructor Detail

NearestNeighborRealRandomAccessibleStackInterpolator

NearestNeighborRealRandomAccessibleStackInterpolator

NearestNeighborRealRandomAccessibleStackInterpolator

Method Detail

getSliceIndex

getOrCreateAccess

setSlice

updateSlice

localize

localize

getFloatPosition

getDoublePosition

fwd

bck

move

move

move

move

move

move

move

move

move

move

setPosition

setPosition

setPosition

setPosition

setPosition

setPosition

setPosition

setPosition

setPosition

setPosition

get

copy

copyRealRandomAccess