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

public Class SmoothingPolynomialBicubicSplineInterpolator

extends BicubicSplineInterpolator
Class Inheritance
Annotations
@Deprecated
Imports
org.apache.commons.math3.exception.DimensionMismatchException, .NoDataException, .NonMonotonicSequenceException, .NotPositiveException, .NullArgumentException, org.apache.commons.math3.util.MathArrays, .Precision, org.apache.commons.math3.optim.nonlinear.vector.jacobian.GaussNewtonOptimizer, org.apache.commons.math3.fitting.PolynomialFitter, org.apache.commons.math3.analysis.polynomials.PolynomialFunction, org.apache.commons.math3.optim.SimpleVectorValueChecker

Deprecated

To be removed in 4.0 (see MATH-1166).

Generates a bicubic interpolation function. Prior to generating the interpolating function, the input is smoothed using polynomial fitting.
Since
2.2

Field Summary

Modifier and TypeField and Description
private final int
xDegree

Degree of the fitting polynomial.

private final PolynomialFitter
xFitter

Deprecated as a consequence of PolynomialFitter being deprecated.
Fitter for x.
private final int
yDegree

Degree of the fitting polynomial.

private final PolynomialFitter
yFitter

Deprecated as a consequence of PolynomialFitter being deprecated.
Fitter for y.

Constructor Summary

AccessConstructor and Description
public
public
SmoothingPolynomialBicubicSplineInterpolator(int
Degree of the polynomial fitting functions.
degree
)

public
SmoothingPolynomialBicubicSplineInterpolator(int
Degree of the polynomial fitting functions along the x-dimension.
xDegree
,
int
Degree of the polynomial fitting functions along the y-dimension.
yDegree
)

Method Summary

Modifier and TypeMethod and Description
public BicubicSplineInterpolatingFunction
interpolate(final double[]
All the x-coordinates of the interpolation points, sorted in increasing order.
xval
,
final double[]
All the y-coordinates of the interpolation points, sorted in increasing order.
yval
,
final double[][]
The values of the interpolation points on all the grid knots: fval[i][j] = f(xval[i], yval[j]).
fval
)

Overrides org.apache.commons.math3.analysis.interpolation.BicubicSplineInterpolator.interpolate.

Implements org.apache.commons.math3.analysis.interpolation.BivariateGridInterpolator.interpolate.

Deprecated as a consequence of BicubicSplineInterpolatingFunction being deprecated.

Compute an interpolating function for the dataset.

Field Detail

xDegreeback to summary
private final int xDegree

Degree of the fitting polynomial.

xFitterback to summary
private final PolynomialFitter xFitter

Deprecated

as a consequence of PolynomialFitter being deprecated. See corresponding docs for further information.

Fitter for x.

yDegreeback to summary
private final int yDegree

Degree of the fitting polynomial.

yFitterback to summary
private final PolynomialFitter yFitter

Deprecated

as a consequence of PolynomialFitter being deprecated. See corresponding docs for further information.

Fitter for y.

Constructor Detail

SmoothingPolynomialBicubicSplineInterpolatorback to summary
public SmoothingPolynomialBicubicSplineInterpolator()

Default constructor. The degree of the fitting polynomials is set to 3.

SmoothingPolynomialBicubicSplineInterpolatorback to summary
public SmoothingPolynomialBicubicSplineInterpolator(int degree) throws NotPositiveException
Parameters
degree:int

Degree of the polynomial fitting functions.

Exceptions
NotPositiveException:
if degree is not positive
SmoothingPolynomialBicubicSplineInterpolatorback to summary
public SmoothingPolynomialBicubicSplineInterpolator(int xDegree, int yDegree) throws NotPositiveException
Parameters
xDegree:int

Degree of the polynomial fitting functions along the x-dimension.

yDegree:int

Degree of the polynomial fitting functions along the y-dimension.

Exceptions
NotPositiveException:
if degrees are not positive

Method Detail

interpolateback to summary
public BicubicSplineInterpolatingFunction interpolate(final double[] xval, final double[] yval, final double[][] fval) throws NoDataException, NullArgumentException, DimensionMismatchException, NonMonotonicSequenceException

Overrides org.apache.commons.math3.analysis.interpolation.BicubicSplineInterpolator.interpolate.

Implements org.apache.commons.math3.analysis.interpolation.BivariateGridInterpolator.interpolate.

Doc from org.apache.commons.math3.analysis.interpolation.BicubicSplineInterpolator.interpolate.

Deprecated

as a consequence of BicubicSplineInterpolatingFunction being deprecated. See corresponding docs for further information.

Compute an interpolating function for the dataset.

Parameters
xval:double[]

Doc from org.apache.commons.math3.analysis.interpolation.BivariateGridInterpolator.interpolate.

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

yval:double[]

Doc from org.apache.commons.math3.analysis.interpolation.BivariateGridInterpolator.interpolate.

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

fval:double[][]

Doc from org.apache.commons.math3.analysis.interpolation.BivariateGridInterpolator.interpolate.

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

Returns:BicubicSplineInterpolatingFunction

Doc from org.apache.commons.math3.analysis.interpolation.BivariateGridInterpolator.interpolate.

a function which interpolates the dataset.

Annotations
@Override
Exceptions
NoDataException:

Doc from org.apache.commons.math3.analysis.interpolation.BivariateGridInterpolator.interpolate.

if any of the arrays has zero length.

DimensionMismatchException:

Doc from org.apache.commons.math3.analysis.interpolation.BivariateGridInterpolator.interpolate.

if the array lengths are inconsistent.

NonMonotonicSequenceException:

Doc from org.apache.commons.math3.analysis.interpolation.BivariateGridInterpolator.interpolate.

if the array is not sorted.