ILNumerics Ultimate VS

Surface Constructor (InArraySingle, InArraySingle, TupleSingle, Single, Colormap, Object)

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Creates a new surface plot, provide Z, X and/or Y coordinates

[ILNumerics Visualization Engine]

Namespace:  ILNumerics.Drawing.Plotting
Assembly:  ILNumerics.Drawing (in ILNumerics.Drawing.dll) Version: ILNumerics Ultimate VS 4
Syntax

public Surface(
	InArray<float> ZXYPositions,
	InArray<float> C = null,
	Tuple<float, float> colorsDataRange = null,
	Colormap colormap = null,
	Object tag = null
)

Parameters

ZXYPositions
Type: ILNumericsInArraySingle
Positions data for the grid points, matrix of size [m x n x [1|2|3]]
C (Optional)
Type: ILNumericsInArraySingle
[optional] Colors for the grid points, size [m x n x [1|4]], default: colormapped heights (Z-values)
colorsDataRange (Optional)
Type: SystemTupleSingle, Single
[optional] if not null, the lower (Item1) and the upper (Item2) limit of the inherent data range of the C parameter in colormap mode. If null, the maximum and the minimum values are taken from C.
colormap (Optional)
Type: ILNumerics.Drawing.PlottingColormap
[optional] Colormap to be used for colormappings, default: 'ILNumerics'
tag (Optional)
Type: SystemObject
[optional]tag used to identify the surface within the scene graph
Remarks

The ZXYPositions parameter defines the grid positions of the new surface. The array is of size [m x n x 3]. m and m are the number of rows / columns respectively. The position coordinates for each grid point is stored along the 3rd dimension. Note the order of the coordinates: Z,X,Y ! Z is obligatory, X and Y are optional. If X and/or Y are ommitted (i.e. a matrix with Z values is provided only), a regular grid will be created for the missing axis, having evenly spaced grid distances of 1.

The optional C parameter is used to define the coloring of each grid point. One of the following modes are available:

  • C is an 3d array of size [m x n x [3|4]] with individual RGB[A] color tupels for every grid point.
  • If C is a matrix of size [m x n], the values are mapped into the current colormap. If the current colormap is changed, the resulting colors will change as well. Values of C are mapped onto the colorrange of the current colormap. colorsDataRange can be used to adjust the data range used for mapping.

The optional colormap parameter can be used to set the surfaces colormap to an individual map. If this parameter is ommitted, the predefined 'ILNumerics' colormap is taken by default.

[ILNumerics Visualization Engine]

See Also

Reference