Horus Doc || Global Function Guide || General documentation   | Function documentation  

HxMulVal

Synopsis

HxImageRep HxMulVal(HxImageRep img, HxValue val)

Input

HxImageRep img
The input image you want to multiply with a value.

HxValue val
The input value.

Return value

HxImageRep
The input image multiplied with the input value, pixel wise.

Description

The function HxMulVal multiplies the values of the input image with the input value on a pixel-by-pixel basis. If the pixel type of the input image and the type of the value are both vectors with the same dimensionality, they are treated component wise. If the input image has vector type pixels and the dimensionality of the input value is 1, every component of a pixel vector is multiplied with the input value.

Remarks

Valid input images and values
The dimensionality of the input value should be 1 or equal to the pixel dimensionality of the image.

Overflow error
The function HxMulVal can result in an overflow error.

See also

HxPowVal, HxDivVal, HxMul,

Keywords

Binary value, Arithmetic,


Generated on Mon Jan 27 15:45:01 2003 for GlobalFunctionGuide by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001