Core Optical, Inc.
ConstantSaturationColorScheme GetPseudocolorImageArray Method Industrial Strength, Scientific Grade
Returns a OnlineArray containing the pixel values of pseudocolor representation of the currently assigned SourceData object(s).

Namespace: PrecisionImage.Visualization
Assembly: PrecisionImage (in PrecisionImage.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax

public Array GetPseudocolorImageArray(
	ColorBitDepth outputBitDepth = ColorBitDepth.EightBit,
	Int32Rect regionOfInterest = null,
	BinaryMask binaryMask = null,
	OutputWindowing dataWindowing = null,
	bool includeAlphaChannel = false
)

Parameters

outputBitDepth (Optional)
Type: PrecisionImage ColorBitDepth
A ColorBitDepth enumeration specifying the bit-depth of the returned OnlineBitmapSource image. This parameter is optional and defaults to EightBit. Images generated using the EightBit specifier are of type OnlineBgr24 or OnlineBgra32, depending on whether or not an alpha channel has been specified. Likewise, images generated using the SixteenBit specifier are either OnlineRgb48 or OnlineRgba64, again depending on whether or not an alpha channel has been specified via the includeAlphaChannel argument.
regionOfInterest (Optional)
Type: OnlineSystem.Windows Int32Rect
An OnlineInt32Rect type indicating the region of interest. Coordinates are zero-index based. This parameter is optional and defaults to the entire image.
binaryMask (Optional)
Type: PrecisionImage.BinarizationAndMorphology BinaryMask
A BinaryMask object indicating areas to bypass. This parameter is optional and default to null (no mask).
dataWindowing (Optional)
Type: PrecisionImage.Visualization OutputWindowing
An OutputWindowing type that indicates the windowing (clipping) to apply to hue/saturation/intensity data channels. This parameter is optional and will default to the global min/max values if no region of interest and/or binary mask is specified. If a region of interest and/or binary mask is specified, the windowing values will default to the local unmasked min/max values within the region of interest. Windowing values for the hue, saturation and intensity data must be associated with channels 0, 1 and 2 respectively of the specified dataWindowing object.
includeAlphaChannel (Optional)
Type: OnlineSystem Boolean
A OnlineBoolean type indicating whether or not the generated OnlineBitmapSource image contains an alpha channel. This parameter is optional and defaults to false.

Return Value

A OnlineArray containing the pixel values portraying the pseudocolored data. To access the individual values, cast to an array of type OnlineByte or OnlineUInt16, depending on the outputBitDepth specifier. See the GetPseudocolorImage(ColorBitDepth, Int32Rect, BinaryMask, OutputWindowing, Boolean) method for the OnlinePixelFormats of the image array.
Exceptions

ExceptionCondition
OnlineSystem ArgumentException Thrown when the SourceData objects assigned to the hue, saturation and intensity channels do not have identical dimensions, or when the binaryMask does not have identical dimensions to the SourceData objects, or when HueStartAngle is equal to HueStopAngle.
OnlineSystem ArgumentOutOfRangeException Thrown when HueStartAngle and/or HueStopAngle are not contained within the range of 0.0 - 360.0, inclusive, or when regionOfInterest specifies an area not entirely contained within the assigned SourceData objects.
Remarks

Use this method to retrieve a fully-formed OnlineBitmapSource image of the pseudocolored data. The image is generated according to the method input arguments as well as the current object properties.
See Also