Core Optical, Inc.
Utilities GetLocalVariance Method Industrial Strength, Scientific Grade
Returns a SourceData object containing the local variance data at each point.

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

public static SourceData GetLocalVariance(
	SourceData sourceData,
	int channel,
	int localRadius,
	Int32Rect regionOfInterest = null,
	BinaryMask binaryMask = null
)

Parameters

sourceData
Type: PrecisionImage SourceData
A SourceData object containing the data to operate on.
channel
Type: OnlineSystem Int32
An OnlineInt32 type indicating the channel to operate on.
localRadius
Type: OnlineSystem Int32
An OnlineInt32 type specifying the radius of the local window for the variance calculation.
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. Default is no mask.

Return Value

A SourceData object containing the variance data.
Exceptions

ExceptionCondition
OnlineSystem ArgumentNullException Thrown when sourceData is null.
OnlineSystem ArgumentOutOfRangeException Thrown when channel refers to a channel that does not exist in sourceData.
OnlineSystem ArgumentException Thrown when the dimensions of binaryMask do not match those of sourceData.
OnlineSystem ArgumentOutOfRangeException Thrown when regionOfInterest specifies a region not completely contained within the input data.
OnlineSystem ArgumentOutOfRangeException Thrown when localRadius specifies a value less than 1.
Remarks

Use this method to retrieve a SourceData object contaiing the local variance at each point in the specified channel of sourceData. The returned object has one channel containing the data and has dimensions equal to regionOfInterest (which defaults to the entire image).

This function uses a single-pass method for computing the local variance.

See Also