ColormapMap Method (Single, TupleSingle, Single, NullableVector4)

public Vector4 Map(
	float val,
	Tuple<float, float> minMaxRange = null,
	Nullable<Vector4> NaNColor = null
)

Public Function Map ( 
	val As Single,
	Optional minMaxRange As Tuple(Of Single, Single) = Nothing,
	Optional NaNColor As Nullable(Of Vector4) = Nothing
) As Vector4

Dim instance As Colormap
Dim val As Single
Dim minMaxRange As Tuple(Of Single, Single)
Dim NaNColor As Nullable(Of Vector4)
Dim returnValue As Vector4

returnValue = instance.Map(val, minMaxRange, 
	NaNColor)

Parameters

val

Type: SystemSingle
Value to map, range of this colormap data range (i.e. column 0 in Data matrix)

minMaxRange (Optional)

Type: SystemTupleSingle, Single
[optional] If null: val is mapped to the colormap range; otherwise, val is mapped to the range given by minMaxRange.

NaNColor (Optional)

Type: SystemNullableVector4
[optional] Replacement value if no valid color could be mapped, default: transparent

Return Value

This function maps the single value given by val into a color computed from this colormap.

If val lays outside of the range defined by the colormap key points (commonly 0..1), the color returned is clamped to the colormap range.

If val is not a number (NaN) the color defined by NaNColor is returned. If no NaNColor was defined in the call to Map(InArraySingle, TupleSingle, Single, NullableVector4) the default NaN color as defined by DefaultNaNColor is returned.

[ILNumerics Visualization Engine]

Reference

Other Resources