ClassesClasses | | Operators

gauss_filtergauss_filterGaussFilterGaussFilter (Operator)

Name

gauss_filtergauss_filterGaussFilterGaussFilter — Smooth using discrete gauss functions.

Signature

gauss_filter(Image : ImageGauss : Size : )

Herror gauss_filter(const Hobject Image, Hobject* ImageGauss, const Hlong Size)

Herror T_gauss_filter(const Hobject Image, Hobject* ImageGauss, const Htuple Size)

void GaussFilter(const HObject& Image, HObject* ImageGauss, const HTuple& Size)

HImage HImage::GaussFilter(Hlong Size) const

static void HOperatorSet.GaussFilter(HObject image, out HObject imageGauss, HTuple size)

HImage HImage.GaussFilter(int size)

Description

The operator gauss_filtergauss_filterGaussFilterGaussFilterGaussFilter smoothes images using the discrete Gaussian, a discrete approximation of the Gaussian function,

The smoothing effect increases with increasing filter size. The following filter sizes (SizeSizeSizeSizesize) are supported (the sigma value of the gauss function is indicated in brackets):

    3    (0.600)
    5    (1.075)
    7    (1.550)
    9    (2.025)
    11   (2.550)
For border treatment the gray values of the images are reflected at the image borders. Notice that, contrary to the operator gauss_imagegauss_imageGaussImageGaussImageGaussImage, the relationship between the filter mask size and its respective value for the sigma parameter is linear.

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

gauss_filtergauss_filterGaussFilterGaussFilterGaussFilter can be executed on OpenCL devices for all supported image types. However, the OpenCL impelementation 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_filtergauss_filterGaussFilterGaussFilterGaussFilter on on OpenCL device, ImageImageImageImageimage 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

Parameters

ImageImageImageImageimage (input_object)  (multichannel-)image(-array) objectHImageHImageHobject (byte* / int2* / uint2* / int4* / real*) *allowed for compute devices

Image to be smoothed.

ImageGaussImageGaussImageGaussImageGaussimageGauss (output_object)  (multichannel-)image(-array) objectHImageHImageHobject * (byte / int2 / uint2 / int4 / real)

Filtered image.

SizeSizeSizeSizesize (input_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Required filter size.

Default value: 5

List of values: 3, 5, 7, 9, 11

Example (HDevelop)

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

Example (C)

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

Example (HDevelop)

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

Example (HDevelop)

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

Example (HDevelop)

gauss_filter(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_filtergauss_filterGaussFilterGaussFilterGaussFilter 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>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>). If necessary an exception is raised.

Possible Predecessors

read_imageread_imageReadImageReadImageReadImage, grab_imagegrab_imageGrabImageGrabImageGrabImage

Possible Successors

regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowing, thresholdthresholdThresholdThresholdThreshold, sub_imagesub_imageSubImageSubImageSubImage, dyn_thresholddyn_thresholdDynThresholdDynThresholdDynThreshold, auto_thresholdauto_thresholdAutoThresholdAutoThresholdAutoThreshold

Alternatives

binomial_filterbinomial_filterBinomialFilterBinomialFilterBinomialFilter, smooth_imagesmooth_imageSmoothImageSmoothImageSmoothImage, derivate_gaussderivate_gaussDerivateGaussDerivateGaussDerivateGauss, isotropic_diffusionisotropic_diffusionIsotropicDiffusionIsotropicDiffusionIsotropicDiffusion

See also

mean_imagemean_imageMeanImageMeanImageMeanImage, anisotropic_diffusionanisotropic_diffusionAnisotropicDiffusionAnisotropicDiffusionAnisotropicDiffusion, sigma_imagesigma_imageSigmaImageSigmaImageSigmaImage, gen_lowpassgen_lowpassGenLowpassGenLowpassGenLowpass

Module

Foundation


ClassesClasses | | Operators