Interpolant (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.interpolation.Interpolant<T,F>

All Implemented Interfaces:

EuclideanSpace, RealRandomAccessible<T>, View
```
public final class Interpolant<T,F>
extends Object
implements RealRandomAccessible<T>, View
```
A RealRandomAccessible that is generated through interpolation.

Author:

Stephan Saalfeld, Tobias Pietzsch

Field Summary

Fields
Modifier and Type Field and Description

protected int n

protected F source

Fields
Modifier and Type	Field and Description
`protected int`	`n`
`protected F`	`source`

Constructor Summary

Constructors
Constructor and Description
`Interpolant(EuclideanSpace source, InterpolatorFactory<T,F> factory)` Deprecated. use the compile time safe constructor `Interpolant(Object, InterpolatorFactory, int)` instead
`Interpolant(F source, InterpolatorFactory<T,F> factory, int n)` Create an `Interpolant` for a source, a compatible intepolator factory and a specified number of dimensions.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InterpolatorFactory<T,F>`	`getInterpolatorFactory()`
`F`	`getSource()`
`int`	`numDimensions()` Gets the space's number of dimensions.
`RealRandomAccess<T>`	`realRandomAccess()` Create a random access sampler for real coordinates.
`RealRandomAccess<T>`	`realRandomAccess(RealInterval interval)`

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

Methods inherited from interface net.imglib2.RealRandomAccessible
getAt, getAt, getAt

- Field Detail
  - source
```
protected final F source
```
  - n
```
protected final int n
```
- Constructor Detail
  - Interpolant
```
@Deprecated
public Interpolant(EuclideanSpace source,
                               InterpolatorFactory<T,F> factory)
```
    Deprecated. use the compile time safe constructor Interpolant(Object, InterpolatorFactory, int) instead
    
    Parameters:
    
    source -
    
    factory -
  - Interpolant
```
public Interpolant(F source,
                   InterpolatorFactory<T,F> factory,
                   int n)
```
    Create an Interpolant for a source, a compatible intepolator factory and a specified number of dimensions.
    
    Parameters:
    
    source -
    
    factory -
    
    n -
- Method Detail
  - numDimensions
```
public int numDimensions()
```
    Description copied from interface: EuclideanSpace
    
    Gets the space's number of dimensions.
    
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - realRandomAccess
```
public RealRandomAccess<T> realRandomAccess()
```
    Description copied from interface: RealRandomAccessible
    
    Create a random access sampler for real coordinates.
    
    Specified by:
    
    realRandomAccess in interface RealRandomAccessible<T>
    
    Returns:
    
    random access sampler
  - realRandomAccess
```
public RealRandomAccess<T> realRandomAccess(RealInterval interval)
```
    Specified by:
    
    realRandomAccess in interface RealRandomAccessible<T>
  - getSource
```
public F getSource()
```
  - getInterpolatorFactory
```
public InterpolatorFactory<T,F> getInterpolatorFactory()
```
    Returns:
    
    InterpolatorFactory used for interpolation

Class Interpolant<T,F>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.RealRandomAccessible

Field Detail

source

n

Constructor Detail

Interpolant

Interpolant

Method Detail

numDimensions

realRandomAccess

realRandomAccess

getSource

getInterpolatorFactory