ILMathmeshgrid Method (InArraySingle, InArraySingle, InArraySingle, OutArraySingle, OutArraySingle)

public static RetArray<float> meshgrid(
	InArray<float> X,
	InArray<float> Y,
	InArray<float> Z,
	OutArray<float> outY = null,
	OutArray<float> outZ = null
)

Public Shared Function meshgrid ( 
	X As InArray(Of Single),
	Y As InArray(Of Single),
	Z As InArray(Of Single),
	Optional outY As OutArray(Of Single) = Nothing,
	Optional outZ As OutArray(Of Single) = Nothing
) As RetArray(Of Single)

Dim X As InArray(Of Single)
Dim Y As InArray(Of Single)
Dim Z As InArray(Of Single)
Dim outY As OutArray(Of Single)
Dim outZ As OutArray(Of Single)
Dim returnValue As RetArray(Of Single)

returnValue = ILMath.meshgrid(X, Y, 
	Z, outY, outZ)

Parameters

X

Type: ILNumericsInArraySingle
Vector of x values.

Y

Type: ILNumericsInArraySingle
Vector of y values.

Z

Type: ILNumericsInArraySingle
Vector of z values.

outY (Optional)

Type: ILNumericsOutArraySingle
[Output, Optional] If on entry outY is not null it holds the values for the y dimension on return.

outZ (Optional)

Type: ILNumericsOutArraySingle
[Output, Optional] If on entry outZ is not null it holds the values for the z dimension on return.

Return Value

The arrays returned can conveniently be used to evaluate and visualize functions of 3 variables X, Y and Z. Coordinates build a 3 dimensional grid with edges at all permutations of X, Y and Z.

Note that the X dimension goes along the rows, while the second dimension is considered the columns! This deviates from the common intuition and the actual storage order of matrix elements (i.e.: first dimension along the columns and 2nd dimension along the rows). The reason for it is the convenience this order gives for plotting purposes: In most plots the X axis is expected to run horizontaly.

[ILNumerics Computing Engine]

Reference

Other Resources