Interpolationinterp2 Method (InArraySingle, InArraySingle, InArraySingle, InArraySingle, InArraySingle, Int32, InterpolationMethod)

public static RetArray<float> interp2(
	InArray<float> V,
	InArray<float> X1 = null,
	InArray<float> X2 = null,
	InArray<float> Xn1 = null,
	InArray<float> Xn2 = null,
	int k = 0,
	InterpolationMethod method = InterpolationMethod.linear
)

Public Shared Function interp2 ( 
	V As InArray(Of Single),
	Optional X1 As InArray(Of Single) = Nothing,
	Optional X2 As InArray(Of Single) = Nothing,
	Optional Xn1 As InArray(Of Single) = Nothing,
	Optional Xn2 As InArray(Of Single) = Nothing,
	Optional k As Integer = 0,
	Optional method As InterpolationMethod = InterpolationMethod.linear
) As RetArray(Of Single)

Dim V As InArray(Of Single)
Dim X1 As InArray(Of Single)
Dim X2 As InArray(Of Single)
Dim Xn1 As InArray(Of Single)
Dim Xn2 As InArray(Of Single)
Dim k As Integer
Dim method As InterpolationMethod
Dim returnValue As RetArray(Of Single)

returnValue = Interpolation.interp2(V, X1, 
	X2, Xn1, Xn2, k, method)

Parameters

V

Type: ILNumericsInArraySingle
Matrix with sample values defined in meshgrid format.

X1 (Optional)

Type: ILNumericsInArraySingle
[Optional] Positions of grid points along the rows of V, specified as a matrix in meshgrid format or grid vector. Monotonically increasing along the rows.

X2 (Optional)

Type: ILNumericsInArraySingle
[Optional] Positions of grid points along the columns of V, specified as a matrix in meshgrid format or grid vector. Monotonically increasing along the columns.

Xn1 (Optional)

Type: ILNumericsInArraySingle
[Optional] Query point positions for dimension 1 (rows), specified as grid vector or matrix in meshgrid format. Monotonically increasing.

Xn2 (Optional)

Type: ILNumericsInArraySingle
[Optional] Query point positions for dimension 2 (columns), 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 and/or X2 are split k times. Ignored for Xn1 or Xn2 being not null respectively. Default: 1.

method (Optional)

Type: ILNumerics.ToolboxesInterpolationMethod
[Optional] Interpolation method. Default: linear.

Return Value

interp2(InArraySingle, NullableSingle, InArraySingle, InArraySingle, InArraySingle, InArraySingle, Int32, InterpolationMethod) performs two dimensional interpolation over the given data matrix V defined in meshgrid(InArraySingle, InArraySingle, InArraySingle, OutArraySingle, OutArraySingle) format. The parameter X1 specifies the positions of the grid points in V along the first dimension (along the rows of V). X2 determines the positions along the 2nd dimension (along the columns of V). Hence, V forms a regular, rectilinear grid of (non-)uniform spacing. Note the order of the dimensions in V: as determined by the meshgrid function the first dimension is considered to correspond to the rows instead of the columns. This order is useful for visualization purposes and plotting, where the X axis is commonly expected along the rows. Use interpn(InArraySingle, NullableSingle, InCell, InCell, InterpolationMethod) as an alternative.

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

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

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

By default interp2(InArraySingle, InArraySingle, InArraySingle, InArraySingle, InArraySingle, Int32, InterpolationMethod) assigns NaN to all query points laying outside of the range of X1 and X2. Use the overload interp2(InArraySingle, NullableSingle, InArraySingle, InArraySingle, InArraySingle, InArraySingle, Int32, InterpolationMethod) with an additional 'outOfRange' parameter in order to specify another value for out-of-range points or to create extrapolated values for them by specifying the outOfRange parameter as null.

[ILNumerics Interpolation Toolbox]

//generate any meshgrid
Array<float> X2 = 1;
Array<float> X1 = meshgrid(linspace<float>(-2, 2, 20), linspace<float>(-2, 2, 20), X2);
Array<float> V = X1 * exp(-(X1 * X1 + X2 * X2));

//define query meshgrid
Array<float> Xn2 = 1;
Array<float> Xn1 = meshgrid(linspace<float>(-3, 3, 50), linspace<float>(-3, 3, 50), Xn2);

//Interpolate
Array<float> Vq = Interpolation.interp2(V, X1, X2, Xn1, Xn2, method:InterpolationMethod.spline, outOfRangeValues: float.NaN);

//or spline interpolate using refinement factor
Array<float> Vq = Interpolation.interp2(V, X1, X2, k:2, method:InterpolationMethod.spline);

//or nearest neighbor interpolation of a meshgrid with only one Xn2 specified.
Array<float> Vq = Interpolation.interp2(V, X1, X2, Xn2:Xn2, method:InterpolationMethod.nearest);

//or linear interpolate a meshgrid
Array<float> Vq = Interpolation.interp2(V);

Reference