gauss_imageGaussImageGaussImagegauss_imagegauss_image🔗

Short description🔗

gauss_imageGaussImageGaussImagegauss_imagegauss_image — Smooth an image using discrete Gaussian functions.

Warning🔗

gauss_imageGaussImage is obsolete and is only provided for reasons of backward compatibility. New applications should use the operator gauss_filterGaussFilter instead.

Signature🔗

gauss_image( image Image, out image ImageGauss, integer Size )

HImage HImage.GaussImage( int size )

Description🔗

The operator gauss_imageGaussImage smoothes images using the discrete Gaussian. The smoothing effect increases with increasing filter size. The following filter sizes (Sizesizesize) are supported (the sigma value of the Gauss function is indicated in brackets):

33 (0.65)
55 (0.87)
77 (1.43)
99 (1.88)
1111 (2.31)

For border treatment the gray values of the images are reflected at the image borders.

The operator binomial_filterBinomialFilter can be used as an alternative to gauss_imageGaussImage. binomial_filterBinomialFilter is significantly faster than gauss_imageGaussImage. It should be noted that the mask size in binomial_filterBinomialFilter does not lead to the same amount of smoothing as the mask size in gauss_imageGaussImage. Corresponding mask sizes can be determined based on the respective values of the Gaussian smoothing parameter sigma.

gauss_imageGaussImage can be executed on OpenCL devices for all supported image types. However, the OpenCL implementation can produce slightly different results from the scalar implementation.

For an explanation of the concept of smoothing filters see the introduction of chapter Filters / Smoothing.

Attention🔗

In order to be able to process gauss_imageGaussImage on an OpenCL device, Imageimageimage must be at least 64 pixels in both width and height.

Note that filter operators may return unexpected results if an image with a reduced domain is used as input. Please refer to the chapter Filters.

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 tuple level.
Automatically parallelized on channel level.
Automatically parallelized on domain level.

Parameters🔗

Imageimageimage (input_object) (multichannel-)image(-array) → object (byte* / int2* / uint2* / int4* / real*) *allowed for compute devices

Image to be smoothed.

ImageGaussimageGaussimage_gauss (output_object) (multichannel-)image(-array) → object (byte / int2 / uint2 / int4 / real)

Filtered image.

Sizesizesize (input_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Required filter size.

Default: 55
List of values: 3, 5, 7, 9, 113, 5, 7, 9, 11

Example🔗

(HDevelop)

gauss_image(Input,Gauss,7)
regiongrowing(Gauss,Segments,7,7,5,100)

(C)

gauss_image(Input,&Gauss,7,)\;
regiongrowing(Gauss,&Segments,7,7,5,100,)\;

Complexity🔗

For each pixel: \(O(Size * 2)\).

Result🔗

If the parameter values are correct the operator gauss_imageGaussImage returns the value 2 (H_MSG_TRUE). 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.

Module🔗

Foundation