Top Description Methods
org.apache.commons.math3.analysis.interpolation

public Interface TrivariateGridInterpolator

Known Direct Implementers
org.apache.commons.math3.analysis.interpolation.TricubicInterpolator, org.apache.commons.math3.analysis.interpolation.TricubicSplineInterpolator
Imports
org.apache.commons.math3.analysis.TrivariateFunction, org.apache.commons.math3.exception.DimensionMismatchException, .NoDataException, .NonMonotonicSequenceException, .NumberIsTooSmallException

Interface representing a trivariate real interpolating function where the sample points must be specified on a regular grid.
Since
2.2

Method Summary

Modifier and TypeMethod and Description
public TrivariateFunction

Returns:

a function that interpolates the data set.
interpolate
(double[]
All the x-coordinates of the interpolation points, sorted in increasing order.
xval
,
double[]
All the y-coordinates of the interpolation points, sorted in increasing order.
yval
,
double[]
All the z-coordinates of the interpolation points, sorted in increasing order.
zval
,
double[][][]
the values of the interpolation points on all the grid knots: fval[i][j][k] = f(xval[i], yval[j], zval[k]).
fval
)

Compute an interpolating function for the dataset.

Method Detail

interpolateback to summary
public TrivariateFunction interpolate(double[] xval, double[] yval, double[] zval, double[][][] fval) throws NoDataException, NumberIsTooSmallException, DimensionMismatchException, NonMonotonicSequenceException

Compute an interpolating function for the dataset.

Parameters
xval:double[]

All the x-coordinates of the interpolation points, sorted in increasing order.

yval:double[]

All the y-coordinates of the interpolation points, sorted in increasing order.

zval:double[]

All the z-coordinates of the interpolation points, sorted in increasing order.

fval:double[][][]

the values of the interpolation points on all the grid knots: fval[i][j][k] = f(xval[i], yval[j], zval[k]).

Returns:TrivariateFunction

a function that interpolates the data set.

Exceptions
NoDataException:
if any of the arrays has zero length.
NumberIsTooSmallException:
if the number of points is too small for the order of the interpolation
DimensionMismatchException:
if the array lengths are inconsistent.
NonMonotonicSequenceException:
if arrays are not sorted