gray_range_rectgray_range_rectGrayRangeRectGrayRangeRect (Operator)

Name

gray_range_rectgray_range_rectGrayRangeRectGrayRangeRect — Determine the gray value range within a rectangle.

Signature

gray_range_rect(Image : ImageResult : MaskHeight, MaskWidth : )

Description

gray_range_rectgray_range_rectGrayRangeRectGrayRangeRectGrayRangeRect calculates the gray value range, i.e., the difference (max - min) of the maximum and minimum gray values, of the input image ImageImageImageImageimage within a rectangular mask of size (MaskHeightMaskHeightMaskHeightMaskHeightmaskHeight, MaskWidthMaskWidthMaskWidthMaskWidthmaskWidth) for each image point. The resulting image is returned in ImageResultImageResultImageResultImageResultimageResult. If the parameters MaskHeightMaskHeightMaskHeightMaskHeightmaskHeight or MaskWidthMaskWidthMaskWidthMaskWidthmaskWidth are even, they are changed to the next smaller odd value. At the border of the image the gray values are mirrored.

Attention

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

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

ImageImageImageImageimage (input_object) (multichannel-)image(-array) → object (byte / cyclic / uint2 / int2 / int4 / real)

Image for which the gray value range is to be calculated.

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

Image containing the gray value range.

MaskHeightMaskHeightMaskHeightMaskHeightmaskHeight (input_control) extent.y → (integer)

Height of the filter mask.

Default value: 11

Suggested values: 3, 5, 7, 9, 11, 13, 15

Typical range of values: 3 ≤ MaskHeight MaskHeight MaskHeight MaskHeight maskHeight ≤ 511 (lin)

Minimum increment: 2

Recommended increment: 2

Restriction: odd(MaskHeight) && MaskHeight < height(Image) * 2

MaskWidthMaskWidthMaskWidthMaskWidthmaskWidth (input_control) extent.x → (integer)

Width of the filter mask.

Default value: 11

Suggested values: 3, 5, 7, 9, 11, 13, 15

Typical range of values: 3 ≤ MaskWidth MaskWidth MaskWidth MaskWidth maskWidth ≤ 511 (lin)

Minimum increment: 2

Recommended increment: 2

Restriction: odd(MaskWidth) && MaskWidth < width(Image) * 2

Result

gray_range_rectgray_range_rectGrayRangeRectGrayRangeRectGrayRangeRect 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>)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.

Alternatives

gray_dilation_rectgray_dilation_rectGrayDilationRectGrayDilationRectGrayDilationRect, gray_erosion_rectgray_erosion_rectGrayErosionRectGrayErosionRectGrayErosionRect, sub_imagesub_imageSubImageSubImageSubImage

Module

Foundation

Operators