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

public Class MicrosphereInterpolator

extends Object
implements MultivariateInterpolator
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.analysis.interpolation.MultivariateInterpolator
Annotations
@Deprecated
Imports
org.apache.commons.math3.analysis.MultivariateFunction, org.apache.commons.math3.exception.NotPositiveException, .NotStrictlyPositiveException, .NoDataException, .DimensionMismatchException, .NullArgumentException, org.apache.commons.math3.random.UnitSphereRandomVectorGenerator

Deprecated

Code will be removed in 4.0. Use InterpolatingMicrosphere and MicrosphereProjectionInterpolator instead.

Interpolator that implements the algorithm described in William Dudziak's MS thesis.
Since
2.1

Field Summary

Modifier and TypeField and Description
private final int
brightnessExponent

Exponent used in the power law that computes the weights of the sample data.

public static final int
DEFAULT_BRIGHTNESS_EXPONENT

Default exponent used the weights calculation.

public static final int
DEFAULT_MICROSPHERE_ELEMENTS

Default number of surface elements that composes the microsphere.

private final int
microsphereElements

Number of surface elements of the microsphere.

Constructor Summary

AccessConstructor and Description
public
MicrosphereInterpolator()

Create a microsphere interpolator with default settings.

public
MicrosphereInterpolator(final int
Number of surface elements of the microsphere.
elements, final int
Exponent used in the power law that computes the weights (distance dimming factor) of the sample data.
exponent)

Create a microsphere interpolator.

Method Summary

Modifier and TypeMethod and Description
public MultivariateFunction
interpolate(final double[][]
the arguments for the interpolation points. xval[i][0] is the first component of interpolation point i, xval[i][1] is the second component, and so on until xval[i][d-1], the last component of that interpolation point (where d is thus the dimension of the space).
xval, final double[]
the values for the interpolation points
yval)

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

Computes an interpolating function for the data set.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

brightnessExponentback to summary
private final int brightnessExponent

Exponent used in the power law that computes the weights of the sample data.

DEFAULT_BRIGHTNESS_EXPONENTback to summary
public static final int DEFAULT_BRIGHTNESS_EXPONENT

Default exponent used the weights calculation.

DEFAULT_MICROSPHERE_ELEMENTSback to summary
public static final int DEFAULT_MICROSPHERE_ELEMENTS

Default number of surface elements that composes the microsphere.

microsphereElementsback to summary
private final int microsphereElements

Number of surface elements of the microsphere.

Constructor Detail

MicrosphereInterpolatorback to summary
public MicrosphereInterpolator()

Create a microsphere interpolator with default settings. Calling this constructor is equivalent to call MicrosphereInterpolator(MicrosphereInterpolator.DEFAULT_MICROSPHERE_ELEMENTS, MicrosphereInterpolator.DEFAULT_BRIGHTNESS_EXPONENT).

MicrosphereInterpolatorback to summary
public MicrosphereInterpolator(final int elements, final int exponent) throws NotPositiveException, NotStrictlyPositiveException

Create a microsphere interpolator.

Parameters
elements:int

Number of surface elements of the microsphere.

exponent:int

Exponent used in the power law that computes the weights (distance dimming factor) of the sample data.

Exceptions
NotPositiveException:
if exponent < 0.
NotStrictlyPositiveException:
if elements <= 0.

Method Detail

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

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

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

Computes an interpolating function for the data set.

Parameters
xval:double[][]

the arguments for the interpolation points. xval[i][0] is the first component of interpolation point i, xval[i][1] is the second component, and so on until xval[i][d-1], the last component of that interpolation point (where d is thus the dimension of the space).

yval:double[]

the values for the interpolation points

Returns:MultivariateFunction

a function which interpolates the data set

Exceptions
DimensionMismatchException:
when the array dimensions are not consistent.
NoDataException:
if an array has zero-length.
NullArgumentException:
if the arguments are null.