mult_image

Herror ::mult_image ( Hobject Image1, Hobject Image2, Hobject *ImageResult, const HTuple &Mult, const HTuple &Add ) HImage HImage::MultImage ( const HImageArray &Image2, const HTuple &Mult, const HTuple &Add ) const HImageArray HImageArray::MultImage ( const HImageArray &Image2, const HTuple &Mult, const HTuple &Add ) const

Multiply two images.

::mult_image multiplies two images. The gray values (g1,g2) of the input images (Image1) are transformed as follows: g' := g1 * g2 * Mult + Add If an overflow or an underflow occurs the values are clipped.

Several images can be processed in one call. In this case both input parameters contain the same number of images which are then processed in pairs. An output image is generated for every pair.

Parameters

`Image1` (input_object)	(multichannel-)image(-array) `->` Hobject: HImage(Array) ( byte / int1 / int2 / int4 / real / direction / cyclic / complex )
Image(s) 1.

`Image2` (input_object)	(multichannel-)image(-array) `->` Hobject: HImage(Array) ( byte / int1 / int2 / int4 / real / direction / cyclic / complex )
Image(s) 2.

`ImageResult` (output_object)	(multichannel-)image(-array) `->` Hobject : HImage(Array)* ( byte / int1 / int2 / int4 / real / direction / cyclic / complex )
Result image(s) by the product.

`Mult` (input_control)	number `->` HTuple.double / long
Factor for gray range adaption.
Default value: 0.005
Suggested values: 0.001, 0.01, 0.5, 1.0, 2.0, 3.0, 5.0, 10.0
Typical range of values: `-255.0 <= Mult <= 255.0`
Minimum increment: 0.001
Recommended increment: 0.1

`Add` (input_control)	number `->` HTuple.double / long
Value for gray range adaption.
Default value: 0
Suggested values: 0.0, 128.0, 256.0
Typical range of values: `-512.0 <= Add <= 512.0`
Minimum increment: 0.01
Recommended increment: 1.0

Example

read_image(&Image0,"fabrik");
disp_image(Image0,WindowHandle);
read_image(&Image1,"Affe");
disp_image(Image1,WindowHandle);
mult_image(Image0,Image1,&Result,2.0,10.0);
disp_image(Result,WindowHandle);

Result

The operator ::mult_image returns the value H_MSG_TRUE if the parameters are correct. The behavior in case of empty input (no input images available) is set via the operator ::set_system('no_object_result',<Result>) If necessary an exception handling is raised.

Alternatives

::add_image, ::sub_image, ::div_image

Module

Image filters