ILNumerics Ultimate VS

Interpolationinterpns Method (InArrayDouble, InCell, InArrayDouble, NullableDouble, InterpolationMethod)

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Interpolate scattered query points from gridded sample data in Rn.

[ILNumerics Interpolation Toolbox]

Namespace:  ILNumerics.Toolboxes
Assembly:  ILNumerics.Toolboxes.Interpolation (in ILNumerics.Toolboxes.Interpolation.dll) Version: 5.5.0.0 (5.5.7503.3146)
Syntax

public static RetArray<double> interpns(
	InArray<double> V,
	InCell X,
	InArray<double> Xn,
	Nullable<double> outOfRangeValues,
	InterpolationMethod method = InterpolationMethod.linear
)

Parameters

V
Type: ILNumericsInArrayDouble
Known values, specified as matrix in meshgrid format.
X
Type: ILNumericsInCell
Sample positions of grid points in V, specified as cell array elements for each dimension in V.
Xn
Type: ILNumericsInArrayDouble
Matrix, [n x l] with the coordinates of the query points in l columns of length n.
outOfRangeValues
Type: SystemNullableDouble
Fixed scalar value to be assigned to query points laying outside of the domain of V.
method (Optional)
Type: ILNumerics.ToolboxesInterpolationMethod
[Optional] Interpolation method. Default: linear

Return Value

Type: RetArrayDouble
Row vector with interpolated values at query points Xn.
Remarks

interpns(InArrayDouble, InCell, InCell, InterpolationMethod) performs n-dimensional interpolation of individual scattered points on the n-dimensional domain V. While V corresponds to a rectilinear grid with uniform or non-uniform ranges for any dimension, new query points for interpolation are layed out in a scattered manner and not arranged in a grid. The query points for interpolation are specified dimension-wise in the individual cell elements of Xn. Therefore, all such cells elements must be not null and have all the same number of elements.

The positions of the grid elements in V are specified by X for the individual dimensions in V. Any dimension i specified as null in X is considered as auto-ranged with values from 0...size(V,i)-1. Otherwise, all arrays provided in X must have strictly monotonically increasing elements.

Any interpolation method out of the enum InterpolationMethod is supported, with the exception of polynomial and parabolic. By default, linear interpolation is performed.

V may contain NaN values. Depending on the interpolation method used interpolated query points on surronding hypercubes will return NaN as well.

Any elements in Xn being NaN will cause the corresponding interpolation result to be considered as 'out of range: the value given in outOfRangeValues will be assigned to it. If outOfRangeValues is null those elements are mapped to the first grid element in V.

Any elements outside of the domain of V are marked with the value provided in outOfRangeValues. Set this value to null in order to achieve extrapolation for those values.

The array returned is of size [n x l], where l corresponds to the length of the arrays in Xn, i.e. the number of query points.

[ILNumerics Interpolation Toolbox]

See Also

Reference