Core Optical, Inc.
LinearPerceptionColorScheme GetPseudocolorImageArray Method Industrial Strength, Scientific Grade
Returns a OnlineBitmapSource 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(
	SourceData sourceData,
	int channel,
	ColorBitDepth outputBitDepth = ColorBitDepth.EightBit,
	Int32Rect regionOfInterest = null,
	BinaryMask binaryMask = null,
	OutputWindowing dataWindowing = null,
	bool includeAlphaChannel = false
)

Parameters

sourceData
Type: PrecisionImage SourceData
A SourceData type containing the image data.
channel
Type: OnlineSystem Int32
An OnlineInt32 type indicating the data channel to process.
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 the source data. 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 unmasked region of interest.
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 OnlineBitmapSource image portraying the pseudocolored data.
Exceptions

ExceptionCondition
OnlineSystem ArgumentNullException Thrown when sourceData is null.
OnlineSystem ArgumentOutOfRangeException Thrown when the specified channel does not exist in the sourceData object.
OnlineSystem ArgumentException Thrown when the dimensions of binaryMask do not match those of sourceData.
OnlineSystem ArgumentOutOfRangeException Thrown when regionOfInterest is not completely contained within the dimensions of sourceData.
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