Interpolator (Fiji Javadocs 0-SNAPSHOT API)

All Known Subinterfaces:

Interpolator1D<T>, Interpolator2D<T>, Interpolator3D<T>

All Known Implementing Classes:

DCTInterpolator, InterpolatorImpl, LanczosInterpolator, LinearInterpolator, LinearInterpolator1D, LinearInterpolator2D, LinearInterpolator2DRealType, LinearInterpolator3D, LinearInterpolator3DRealType, NearestNeighborInterpolator, NearestNeighborInterpolator1D, NearestNeighborInterpolator2D, NearestNeighborInterpolator3D
```
public interface Interpolator<T extends Type<T>>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the interpolator and with it any cursors or other containers, images or datastructures that might have been created to make the interpolation work
`Image<T>`	`getImage()` Returns the typed image the interpolator is working on
`InterpolatorFactory<T>`	`getInterpolatorFactory()` Returns the typed interpolator factory the Interpolator has been instantiated with.
`OutOfBoundsStrategyFactory<T>`	`getOutOfBoundsStrategyFactory()` Returns the `OutOfBoundsStrategyFactory` used for interpolation
`float[]`	`getPosition()` Returns the positon of the interpolator.
`void`	`getPosition(float[] position)` Returns the positon of the interpolator.
`T`	`getType()` Returns the type which stores the value for the current position of the interpolator
`void`	`moveRel(double[] vector)` Moves the interpolator a certain distance given by the vector to a random position inside or out of image bounds.
`void`	`moveRel(float[] vector)` Moves the interpolator a certain distance given by the vector to a random position inside or out of image bounds.
`void`	`moveTo(double[] position)` Moves the interpolator to a random position inside or out of image bounds.
`void`	`moveTo(float[] position)` Moves the interpolator to a random position inside or out of image bounds.
`void`	`setPosition(double[] position)` Sets the interpolator to a random position inside or out of image bounds.
`void`	`setPosition(float[] position)` Sets the interpolator to a random position inside or out of image bounds.

- Method Detail
  - getInterpolatorFactory
```
InterpolatorFactory<T> getInterpolatorFactory()
```
    Returns the typed interpolator factory the Interpolator has been instantiated with.
    
    Returns:
    
    - the interpolator factory
  - getOutOfBoundsStrategyFactory
```
OutOfBoundsStrategyFactory<T> getOutOfBoundsStrategyFactory()
```
    Returns the OutOfBoundsStrategyFactory used for interpolation
    
    Returns:
    
    - the OutOfBoundsStrategyFactory
  - getImage
```
Image<T> getImage()
```
    Returns the typed image the interpolator is working on
    
    Returns:
    
    - the image
  - getType
```
T getType()
```
    Returns the type which stores the value for the current position of the interpolator
    
    Returns:
    
    - the Type object of the interpolator
  - moveTo
```
void moveTo(float[] position)
```
    Moves the interpolator to a random position inside or out of image bounds. This method is typically more efficient than setting the position
    
    Parameters:
    
    position - - the floating position of the same dimensionality as the image
  - moveTo
```
void moveTo(double[] position)
```
    Moves the interpolator to a random position inside or out of image bounds. This method is typically more efficient than setting the position
    
    Parameters:
    
    position - - the floating position of the same dimensionality as the image
  - moveRel
```
void moveRel(float[] vector)
```
    Moves the interpolator a certain distance given by the vector to a random position inside or out of image bounds. This method is typically more efficient than setting the position
    
    Parameters:
    
    vector - - the floating vector of the same dimensionality as the image
  - moveRel
```
void moveRel(double[] vector)
```
    Moves the interpolator a certain distance given by the vector to a random position inside or out of image bounds. This method is typically more efficient than setting the position
    
    Parameters:
    
    vector - - the floating vector of the same dimensionality as the image
  - setPosition
```
void setPosition(float[] position)
```
    Sets the interpolator to a random position inside or out of image bounds. This method is typically less efficient than moving the position
    
    Parameters:
    
    position - - the floating position of the same dimensionality as the image
  - setPosition
```
void setPosition(double[] position)
```
    Sets the interpolator to a random position inside or out of image bounds. This method is typically less efficient than moving the position
    
    Parameters:
    
    position - - the floating position of the same dimensionality as the image
  - getPosition
```
void getPosition(float[] position)
```
    Returns the positon of the interpolator.
    
    Parameters:
    
    position - - the floating position of the same dimensionality as the image
  - getPosition
```
float[] getPosition()
```
    Returns the positon of the interpolator.
    
    Returns:
    
    - the floating position of the same dimensionality as the image (as a new object)
  - close
```
void close()
```
    Closes the interpolator and with it any cursors or other containers, images or datastructures that might have been created to make the interpolation work

Interface Interpolator<T extends Type<T>>

Method Summary

Method Detail

getInterpolatorFactory

getOutOfBoundsStrategyFactory

getImage

getType

moveTo

moveTo

moveRel

moveRel

setPosition

setPosition

getPosition

getPosition

close