Skip to content

deviation_imageDeviationImageDeviationImagedeviation_imagedeviation_image🔗

Short description🔗

deviation_imageDeviationImageDeviationImagedeviation_imagedeviation_image — Calculate the standard deviation of gray values within rectangular windows.

Signature🔗

deviation_image( image Image, out image ImageDeviation, extent.x Width, extent.y Height )void DeviationImage( const HObject& Image, HObject* ImageDeviation, const HTuple& Width, const HTuple& Height )static void HOperatorSet.DeviationImage( HObject image, out HObject imageDeviation, HTuple width, HTuple height )def deviation_image( image: HObject, width: int, height: int ) -> HObject

Herror deviation_image( const Hobject Image, Hobject* ImageDeviation, const Hlong Width, const Hlong Height )

Herror T_deviation_image( const Hobject Image, Hobject* ImageDeviation, const Htuple Width, const Htuple Height )

HImage HImage::DeviationImage( Hlong Width, Hlong Height ) const

HImage HImage.DeviationImage( int width, int height )

Description🔗

deviation_imageDeviationImage calculates the standard deviation of gray values in the image Imageimageimage within a rectangular mask of size (Heightheightheight, Widthwidthwidth). The resulting image is returned in ImageDeviationimageDeviationimage_deviation. To better use the range of gray values available in the output image, the result is multiplied by 2. If the parameters Heightheightheight and Widthwidthwidth are even, they are changed to the next larger odd value. At the image borders the gray values are mirrored.

Attention🔗

deviation_imageDeviationImage can be executed on OpenCL devices. As the same OpenCL code is used, the same limitations as for mean_imageMeanImage apply. Since deviation_imageDeviationImage uses single precision floating point arithmetic internally, the results may differ slightly from the CPU version.

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* / int4* / real* / int2* / uint2*)HObject (byte* / int4* / real* / int2* / uint2*)HImage (byte* / int4* / real* / int2* / uint2*)HObject (byte* / int4* / real* / int2* / uint2*)Hobject (byte* / int4* / real* / int2* / uint2*) *allowed for compute devices

Image for which the standard deviation is to be calculated.

ImageDeviationimageDeviationimage_deviation (output_object) image(-array) → object (byte / int4 / real / int2 / uint2)HObject (byte / int4 / real / int2 / uint2)HImage (byte / int4 / real / int2 / uint2)HObject (byte / int4 / real / int2 / uint2)Hobject * (byte / int4 / real / int2 / uint2)

Image containing the standard deviation.

Widthwidthwidth (input_control) extent.x → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Width of the mask in which the standard deviation is calculated.

Default: 1111
Suggested values: 3, 5, 7, 9, 11, 13, 15, 17, 19, 21, 23, 253, 5, 7, 9, 11, 13, 15, 17, 19, 21, 23, 25
Restriction: 3 <= Width && odd(Width) && Width < width(Image) * 2

Heightheightheight (input_control) extent.y → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Height of the mask in which the standard deviation is calculated.

Default: 1111
Suggested values: 3, 5, 7, 9, 11, 13, 15, 17, 19, 21, 23, 253, 5, 7, 9, 11, 13, 15, 17, 19, 21, 23, 25
Restriction: 3 <= Height && odd(Height) && Height < height(Image) * 2

Example🔗

(HDevelop)

read_image(Image,'fabrik')
dev_display(Image)
deviation_image(Image,Deviation,9,9)
dev_display(Image)
(C)
read_image(&Image,"fabrik")\;
disp_image(Image,WindowHandle)\;
deviation_image(Image,&Deviation,9,9)\;
disp_image(Deviation,WindowHandle)\; 

Result🔗

deviation_imageDeviationImage returns 2 (H_MSG_TRUE) if all parameters are correct. If the input is empty the behavior can be set via set_system('no_object_result',<Result>). If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible successors

disp_imageDispImage

Alternatives

entropy_imageEntropyImage, entropy_grayEntropyGray

See also

convol_imageConvolImage, texture_lawsTextureLaws, intensityIntensity

Module🔗

Foundation