ILNumerics Ultimate VS

Interpolationinterp3 Method (InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, Int32, InterpolationMethod)

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Interpolate query points on a regular grid from gridded 3D data.

[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> interp3(
	InArray<double> V,
	InArray<double> X1 = null,
	InArray<double> X2 = null,
	InArray<double> X3 = null,
	InArray<double> Xn1 = null,
	InArray<double> Xn2 = null,
	InArray<double> Xn3 = null,
	int k = 0,
	InterpolationMethod method = InterpolationMethod.linear
)

Parameters

V
Type: ILNumericsInArrayDouble
3 dimensional array with sample values.
X1 (Optional)
Type: ILNumericsInArrayDouble
[Optional] Positions of grid points in V for dimension 1, specified as a matrix in meshgrid format or grid vector. Monotonically increasing.
X2 (Optional)
Type: ILNumericsInArrayDouble
[Optional] Positions of grid points in V for dimension 2, specified as a matrix in meshgrid format or grid vector. Monotonically increasing.
X3 (Optional)
Type: ILNumericsInArrayDouble
[Optional] Positions of grid points in V for dimension 3, specified as a matrix in meshgrid format or grid vector. Monotonically increasing.
Xn1 (Optional)
Type: ILNumericsInArrayDouble
[Optional] Query point positions for dimension 1, specified as grid vector or matrix in meshgrid format. Monotonically increasing.
Xn2 (Optional)
Type: ILNumericsInArrayDouble
[Optional] Query point positions for dimension 2, specified as grid vector or matrix in meshgrid format. Monotonically increasing.
Xn3 (Optional)
Type: ILNumericsInArrayDouble
[Optional] Query point positions for dimension 3, specified as grid vector or matrix in meshgrid format. Monotonically increasing.
k (Optional)
Type: SystemInt32
[Optional] Refinement factor for default query grid positions. Ranges specified by X1,X2 and/or X3 are split k times. Ignored for any of Xn1, Xn2 or Xn3 being not null.
method (Optional)
Type: ILNumerics.ToolboxesInterpolationMethod
[Optional] Interpolation method. Default: linear.

Return Value

Type: RetArrayDouble
3 dimensional array with interpolated values. Corresponds to the grid determined by Xn1, Xn2 and Xn3.
Remarks

interp3(InArrayDouble, NullableDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, Int32, InterpolationMethod) performs three dimensional interpolation over the given data array V. The parameter X1 specifies the positions of the grid points in V along the first dimension (the columns of V). X2 determines the positions along the 2nd dimension (rows of V) and so forth. Hence, V forms a regular, rectilinear grid of (non-)uniform spacing in three dimensions.

Values in X1, X2 and X3, if provided, must be strictly monotonically increasing but not necessarily be uniform. If any of X1, X2 and/or X3 are ommitted for dimension d, default grid positions are assumed with uniform range of spacing 1: 0:1:m, where m = size(V, d).

Values in Xn1, Xn2 and Xn3, if provided, must be strictly monotonically increasing but not necessarily have uniform spacing. If any of Xn1, Xn2 and/or Xn3 are ommitted, default query grid positions are assumed by subdividing X1, X2 and/or X3 respectively, 'k' times.

Interpolation methods: all methods from the enum InterpolationMethod are supported. See interp1(InArrayDouble, NullableDouble, InArrayDouble, InArrayDouble, Int32, InterpolationMethod) for a detailed description.

By default interp3(InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, Int32, InterpolationMethod) assigns NaN to all query points laying outside of the range of X1, X2 and X3. Use the overload interp3(InArrayDouble, NullableDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, Int32, InterpolationMethod) in order to specify another value for grid points laying out-of-range or to create extrapolated values for them by specifying the outOfRange parameter as null.

[ILNumerics Interpolation Toolbox]

See Also

Reference