IMcOperations2MultEx Method
|
|
Multiplies 2 images or an image and a constant.
Namespace:
MediaCy.IQL.Operations
Assembly:
MediaCy.IQL.Operations (in MediaCy.IQL.Operations.dll) Version: 10.0.6912.0
SyntaxFunction MultEx (
vOperand2 As Object,
<OptionalAttribute> ScaleOffset As Object,
Optional ConversionMode As mcConversionMode = mcConversionMode.mccmDirect,
<OptionalAttribute> vOperand1 As Object
) As McImage
Parameters
- vOperand2
- Type: SystemObject
Right hand operand of the operation. A McImage, or number
(array for multi-channel images). - ScaleOffset (Optional)
- Type: SystemObject
If given, a single value or an array of N-channels values that
is used to scale the result before storing the operation result. If a
single value is supplied, then that value is used to scale all channels; if
an array is supplied each value in the array is used to scale the result for
the corresponding color channel. If not given, no scaling is done. A
scaling value of zero is ignored, so that no scaling of the result is done. - ConversionMode (Optional)
- Type: MediaCy.IQL.OperationsmcConversionMode
If given, specifies if the pixels of a vOperand2 McImage
should be scaled or copied directly when the bit depth of vOperand2 and the
destination image differ. The value is mccmDirect by default, which is most
often appropriate for arithmetic operations on images. - vOperand1 (Optional)
- Type: SystemObject
Optional first image operand (operator applies to parent image
when parameter is omitted).
Return Value
Type:
McImageThe resulting McImage
RemarksA conversion is performed on vOperand2 so that it has the same type as
the destination image. The conversion rules are defined by the value of the
ConversionMode argument.
The the result of the operation is multiplied by the ScaleOffset argument value to
produce the final result:
Parent image [or vOperand1] * vOperand2 * ScaleOffset
which is stored in the parent image or vOperand1 if there is no parent.
For floating point image types, the stored results may exceed the bounds
of the current destination McImage.RangeMin to McImage.RangeMax. These
range properties are not changed automatically.
See Also