Colormap.Map Method (InArray<Single>, Tuple<Single, Single>, Nullable<Vector4>)

public RetArray<float> Map(
	InArray<float> A,
	Tuple<float, float> minMaxRange = null,
	Nullable<Vector4> NaNColor = null
)

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

Dim instance As Colormap
Dim A As InArray(Of Single)
Dim minMaxRange As Tuple(Of Single, Single)
Dim NaNColor As Nullable(Of Vector4)
Dim returnValue As RetArray(Of Single)

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

Parameters

A

Type: ILNumerics.InArray<Single>
Array with elements to map, values will be taken in order of storage in A and lined up by their linear indices

minMaxRange (Optional)

Type: System.Tuple<Single, Single>
[optional] If null: values in A are mapped to the range derived from the min and max values in A; otherwise val is mapped to the range given by minMaxRange.

NaNColor (Optional)

Type: System.Nullable<Vector4>
[optional] Replacement value if no valid color could be mapped, default: DefaultNaNColor (Color.Empty; transparent)

Return Value

This function maps the values given by A into a color computed from this colormap.

If elements in A lay outside of the range defined by minMaxRange, the color returned is clamped to that range.

If elements in A are not a number (NaN) the color defined by NaNColor is returned. If no NaNColor was defined in the call to Map(InArray<Single> , Tuple<Single, Single> , Nullable<Vector4> ) the default NaN color as defined by DefaultNaNColor is returned.

[ILNumerics Visualization Engine]

Reference

Other Resources