add_imageAddImageAddImageadd_imageadd_image🔗

Short description🔗

add_imageAddImageAddImageadd_imageadd_image — Add two images.

Signature🔗

add_image( image Image1, image Image2, out image ImageResult, number Mult, number Add )

Description🔗

The operator add_imageAddImage adds two images. The gray values (g1,g2) of the input images (Image1image1image_1 and Image2image2image_2) are transformed as follows: g’ := (g1 + g2) * Mult + Add

If an overflow or an underflow occurs the values are clipped. Note that this is not the case with cyclic and direction images. The resulting image is stored in ImageResultimageResultimage_result.

* It is possible to add byte images with int2, uint2 or int4 images and to add int4 to int2 or uint2 images. In this case the result will be of type int2 or int4 respectively.

* 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.

*

Please note that the runtime of the operator varies with different control parameters. For frequently used combinations special optimizations are used. Additionally, for byte, int2, uint2, and int4 images special optimizations are implemented that use SIMD technology. The actual application of these special optimizations is controlled by the system parameter 'mmx_enable'"mmx_enable" (see set_systemSetSystem). If 'mmx_enable'"mmx_enable" is set to 'true'"true" (and the SIMD instruction set is available), the internal calculations are performed using SIMD technology.

add_imageAddImage can be executed on an OpenCL device for byte, int1, int2, uint2, int4, real, direction, cyclic, and complex images. However, since for OpenCL 1.0 only single precision floating point is supported for all devices, and not all rounding modes are supported, the OpenCL implementation can produce slightly different results from the scalar or SIMD implementations.

Attention🔗

Note that the acceleration gained by SIMD technology is highest on large, compact input regions. However, in rare cases, the execution of add_imageAddImage might take significantly longer with SIMD technology than without, depending on the input region and the capabilities of the hardware. In these cases, the use of SIMD technology can be avoided by set_system(::'mmx_enable','false':).

Execution information🔗

Execution information

Supports OpenCL compute devices.
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Automatically parallelized on domain level.

Parameters🔗

Image1image1image_1 (input_object) (multichannel-)image(-array) → object (byte* / int1* / int2* / uint2* / int4* / int8 / real* / direction* / cyclic* / complex*) *allowed for compute devices

Image(s) 1.

Image2image2image_2 (input_object) (multichannel-)image(-array) → object (byte* / int1* / int2* / uint2* / int4* / int8 / real* / direction* / cyclic* / complex*) *allowed for compute devices

Image(s) 2.

ImageResultimageResultimage_result (output_object) (multichannel-)image(-array) → object (byte / int1 / int2 / uint2 / int4 / int8 / real / direction / cyclic / complex)

Result image(s) by the addition.

Multmultmult (input_control) number → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)Union[int, float]Htuple (double / Hlong)

Factor for gray value adaption.

Default: 0.50.5
Suggested values: 0.2, 0.4, 0.6, 0.8, 1.0, 1.5, 2.0, 3.0, 5.0
Value range: -255.0 ≤ Mult ≤ 255.0
Minimum increment: 0.001
Recommended increment: 0.1

Addaddadd (input_control) number → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)Union[int, float]Htuple (double / Hlong)

Value for gray value range adaption.

Default: 00
Suggested values: 0, 64, 128, 255, 5120, 64, 128, 255, 512
Value range: -512.0 ≤ Add ≤ 512.0
Minimum increment: 0.01
Recommended increment: 1.0

Example🔗

(HDevelop)

read_image(Image1,'fabrik')
dev_display (Image1)
read_image(Image2,'monkey')
dev_display (Image2)
add_image(Image1,Image2,Result,0.5,10.0)
dev_display (Result)

(C)

read_image(&Image1,"fabrik")\;
disp_image(Image1,WindowHandle)\;
read_image(&Image2,"monkey")\;
disp_image(Image2,WindowHandle)\;
add_image(Image1,Image2,&Result,0.5,10.0)\;
disp_image(Result,WindowHandle)\;

Result🔗

The operator add_imageAddImage returns the value 2 (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 is raised.

Combinations with other operators🔗

Combinations

Alternatives

sub_imageSubImage, mult_imageMultImage

See also

sub_imageSubImage, mult_imageMultImage

Module🔗

Foundation