Interpolator2D (NASA World Wind)

java.lang.Object
- gov.nasa.worldwindx.applications.antenna.Interpolator2D

```
public class Interpolator2D
extends Object
```
Represents a 2D function defined by sample points and interpolates values within the domain of the samples. Each sample is defined by two coordinates, (s, t) and a function value, r, such that f(s,t) = r. Once the function's sample points are added to the interpolator, the interpolator determines values at any coordinate within the sample domain. An option exists to interpolate outside the sample domain by wrapping from maximum back to minimum values. See setWrapS(boolean) for a description of this option.

Field Summary

Fields
Modifier and Type	Field and Description
`protected TreeMap<Double,TreeMap<Double,Double>>`	`map`
`protected Double`	`maxS`
`protected Double`	`maxT`
`protected Double`	`maxValue`
`protected Double`	`minS`
`protected Double`	`minT`
`protected Double`	`minValue`
`protected boolean`	`wrapS`
`protected boolean`	`wrapT`

Constructor Summary

Constructors
Constructor and Description

Interpolator2D()

Constructors
Constructor and Description
`Interpolator2D()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFromFile(File file)`
`void`	`addFromStream(InputStream is)`
`void`	`addValue(double s, double t, double r)` Adds a value to this interpolator.
`Double`	`getMaxS()` Returns the maximum first coordinate within this interpolator.
`Double`	`getMaxT()` Returns the maximum second coordinate within this interpolator.
`Double`	`getMaxValue()` Returns the maximum value within this interpolator.
`Double`	`getMinS()` Returns the minimum first coordinate within this interpolator.
`Double`	`getMinT()` Returns the minimum second coordinate within this interpolator.
`Double`	`getMinValue()` Returns the minimum value within this interpolator.
`Double`	`getValue(double s, double t)` Determines and returns a value from this interpolator using bi-linear interpolation.
`boolean`	`isWrapS()` Indicates whether this interpolator interpolates between maximum and minimum first coordinates if a first coordinate outside the current range of first coordinates is specified.
`boolean`	`isWrapT()` Indicates whether this interpolator interpolates between maximum and minimum second coordinates if a second coordinate outside the current range of second coordinates is specified.
`void`	`setWrapS(boolean wrapS)` Specifies whether this interpolator interpolates between maximum and minimum first coordinates if a first coordinate outside the current range of first coordinates is specified.
`void`	`setWrapT(boolean wrapT)` Specifies whether this interpolator interpolates between maximum and minimum second coordinates if a second coordinate outside the current range of second coordinates is specified.

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

- Field Detail
  - map
```
protected TreeMap<Double,TreeMap<Double,Double>> map
```
  - maxS
```
protected Double maxS
```
  - maxT
```
protected Double maxT
```
  - maxValue
```
protected Double maxValue
```
  - minS
```
protected Double minS
```
  - minT
```
protected Double minT
```
  - minValue
```
protected Double minValue
```
  - wrapS
```
protected boolean wrapS
```
  - wrapT
```
protected boolean wrapT
```
- Constructor Detail
  - Interpolator2D
```
public Interpolator2D()
```
- Method Detail
  - addFromFile
```
public void addFromFile(File file)
                 throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException
  - addFromStream
```
public void addFromStream(InputStream is)
```
  - addValue
```
public void addValue(double s,
                     double t,
                     double r)
```
    Adds a value to this interpolator.
    
    Parameters:
    
    s - the value's first coordinate.
    
    t - the value's second coordinate.
    
    r - the value to add.
  - getMaxS
```
public Double getMaxS()
```
    Returns the maximum first coordinate within this interpolator.
    
    Returns:
    
    this interpolator's maximum first coordinate, or null if the interpolator contains no values.
  - getMaxT
```
public Double getMaxT()
```
    Returns the maximum second coordinate within this interpolator.
    
    Returns:
    
    this interpolator's maximum second coordinate, or null if the interpolator contains no values.
  - getMaxValue
```
public Double getMaxValue()
```
    Returns the maximum value within this interpolator.
    
    Returns:
    
    this interpolator's maximum value, or null if the interpolator contains no values.
  - getMinS
```
public Double getMinS()
```
    Returns the minimum first coordinate within this interpolator.
    
    Returns:
    
    this interpolator's minimum first coordinate, or null if the interpolator contains no values.
  - getMinT
```
public Double getMinT()
```
    Returns the minimum second coordinate within this interpolator.
    
    Returns:
    
    this interpolator's minimum second coordinate, or null if the interpolator contains no values.
  - getMinValue
```
public Double getMinValue()
```
    Returns the minimum value within this interpolator.
    
    Returns:
    
    this interpolator's minimum value, or null if the interpolator contains no values.
  - getValue
```
public Double getValue(double s,
                       double t)
```
    Determines and returns a value from this interpolator using bi-linear interpolation.
    
    Parameters:
    
    s - the first coordinate.
    
    t - the second coordinate.
    
    Returns:
    
    the value at the specified coordinates, or null if a specified coordinate is outside the range of this interpolator and the corresponding wrap flag is false.
    
    See Also:
    
    setWrapS(boolean), setWrapT(boolean)
  - isWrapS
```
public boolean isWrapS()
```
    Indicates whether this interpolator interpolates between maximum and minimum first coordinates if a first coordinate outside the current range of first coordinates is specified. See setWrapS(boolean) for a description of wrapping and the use of this flag.
    
    Returns:
    
    the first coordinate's wrap flag.
  - isWrapT
```
public boolean isWrapT()
```
    Indicates whether this interpolator interpolates between maximum and minimum second coordinates if a second coordinate outside the current range of second coordinates is specified. See setWrapS(boolean) for a description of wrapping and the use of wrap flags.
    
    Returns:
    
    the second coordinate's wrap flag.
    
    See Also:
    
    setWrapS(boolean)
  - setWrapS
```
public void setWrapS(boolean wrapS)
```
    Specifies whether this interpolator interpolates between maximum and minimum first coordinates if a first coordinate outside the current range of first coordinates is specified. For example, if the first coordinate represents a circular angle, and the minimum first coordinate is 0 while the maximum first coordinate is 350, when a value at a first coordinate of 355 is requested, interpolation should likely be performed between 350 and 0. If the wrap flag is true, interpolation is performed. If it is false, null is returned from getValue(double, double).
    The default wrap S flag is false.
    
    Parameters:
    
    wrapS - the first coordinate's wrap flag.
    
    See Also:
    
    setWrapS(boolean)
  - setWrapT
```
public void setWrapT(boolean wrapT)
```
    Specifies whether this interpolator interpolates between maximum and minimum second coordinates if a second coordinate outside the current range of second coordinates is specified. See setWrapS(boolean) for a description of wrapping and the use of wrap flags.
    The default T wrap flag is false.
    
    Parameters:
    
    wrapT - the second coordinate's wrap flag.
    
    See Also:
    
    setWrapS(boolean)

Class Interpolator2D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

map

maxS

maxT

maxValue

minS

minT

minValue

wrapS

wrapT

Constructor Detail

Interpolator2D

Method Detail

addFromFile

addFromStream

addValue

getMaxS

getMaxT

getMaxValue

getMinS

getMinT

getMinValue

getValue

isWrapS

isWrapT

setWrapS

setWrapT