Core Optical, Inc.
Utilities MultiplyValue Method Industrial Strength, Scientific Grade
Multiplies a single value with the data contained in the SourceData object.

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

public static void MultiplyValue(
	SourceData sourceData,
	int channel,
	float value,
	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.
value
Type: OnlineSystem Single
A OnlineSingle type whose value is to be multiplied with the data.
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.
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.
Remarks

Use this function to multiply a single value with the data contained in the specified channel of sourceData.
See Also