gray_range_rectgray_range_rectGrayRangeRectGrayRangeRectgray_range_rect (Operator)

Name

gray_range_rectgray_range_rectGrayRangeRectGrayRangeRectgray_range_rect — Determine the gray value range within a rectangle.

Signature

gray_range_rect(Image : ImageResult : MaskHeight, MaskWidth : )

Description

gray_range_rectgray_range_rectGrayRangeRectGrayRangeRectGrayRangeRectgray_range_rect calculates the gray value range, i.e., the difference (max - min) of the maximum and minimum gray values, of the input image ImageImageImageImageimageimage within a rectangular mask of size (MaskHeightMaskHeightMaskHeightMaskHeightmaskHeightmask_height, MaskWidthMaskWidthMaskWidthMaskWidthmaskWidthmask_width) for each image point. The resulting image is returned in ImageResultImageResultImageResultImageResultimageResultimage_result. If the parameters MaskHeightMaskHeightMaskHeightMaskHeightmaskHeightmask_height or MaskWidthMaskWidthMaskWidthMaskWidthmaskWidthmask_width 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

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

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

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

Image containing the gray value range.

MaskHeightMaskHeightMaskHeightMaskHeightmaskHeightmask_height (input_control) extent.y → (integer)

Height of the filter mask.

Default: 11

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

Value range: 3 ≤ MaskHeight MaskHeight MaskHeight MaskHeight maskHeight mask_height ≤ 511 (lin)

Minimum increment: 2

Recommended increment: 2

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

MaskWidthMaskWidthMaskWidthMaskWidthmaskWidthmask_width (input_control) extent.x → (integer)

Width of the filter mask.

Default: 11

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

Value range: 3 ≤ MaskWidth MaskWidth MaskWidth MaskWidth maskWidth mask_width ≤ 511 (lin)

Minimum increment: 2

Recommended increment: 2

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

Result

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

Alternatives

gray_dilation_rectgray_dilation_rectGrayDilationRectGrayDilationRectGrayDilationRectgray_dilation_rect, gray_erosion_rectgray_erosion_rectGrayErosionRectGrayErosionRectGrayErosionRectgray_erosion_rect, sub_imagesub_imageSubImageSubImageSubImagesub_image

Module

Foundation

Operators