ILNumerics Ultimate VS

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

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Creates a new surface plot, provide Z values, X and Y ranges

[ILNumerics Visualization Engine]

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

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

Parameters

Z
Type: ILNumericsInArraySingle
Positions data for the grid points, matrix of size [m x n]
X
Type: ILNumericsInArraySingle
X range: a matrix of size Z.S or a vector of length Z.S[1]
Y
Type: ILNumericsInArraySingle
Y range: a matrix of size Z.S or a vector of length Z.S[0]
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 Z, X and Y parameters define the grid positions of the new surface. Z defines the size of the surface. X and Y define the position of the surface on the X and Y axes respectively. X and Y can be vectors or matrices. If X is provided as vector, it gives the X coordinates of the grid points which are replicated for all rows. If Y is a vector, it defines the Y coords for the grid points for all columns respectively. If X or Y are given as matrices, they define the X and/or Y coordinates of all individual grid points explicitely. This allows the creation of arbitrary parametric surfaces.

If either of X or Y is null, the coords are computed based on a regular spacing, starting at 0 and running along the X and Y axis with a step width 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 (min,max) 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