Operator Reference

gray_erosion_rectgray_erosion_rectGrayErosionRectGrayErosionRectgray_erosion_rect (Operator)

gray_erosion_rectgray_erosion_rectGrayErosionRectGrayErosionRectgray_erosion_rect — Determine the minimum gray value within a rectangle.

Signature

gray_erosion_rect(Image : ImageMin : MaskHeight, MaskWidth : )

Herror gray_erosion_rect(const Hobject Image, Hobject* ImageMin, const Hlong MaskHeight, const Hlong MaskWidth)

Herror T_gray_erosion_rect(const Hobject Image, Hobject* ImageMin, const Htuple MaskHeight, const Htuple MaskWidth)

void GrayErosionRect(const HObject& Image, HObject* ImageMin, const HTuple& MaskHeight, const HTuple& MaskWidth)

HImage HImage::GrayErosionRect(Hlong MaskHeight, Hlong MaskWidth) const

static void HOperatorSet.GrayErosionRect(HObject image, out HObject imageMin, HTuple maskHeight, HTuple maskWidth)

HImage HImage.GrayErosionRect(int maskHeight, int maskWidth)

def gray_erosion_rect(image: HObject, mask_height: int, mask_width: int) -> HObject

Description

gray_erosion_rectgray_erosion_rectGrayErosionRectGrayErosionRectgray_erosion_rect calculates the minimum gray value of the input image ImageImageImageimageimage within a rectangular mask of size (MaskHeightMaskHeightMaskHeightmaskHeightmask_height, MaskWidthMaskWidthMaskWidthmaskWidthmask_width) for each image point. The resulting image is returned in ImageMinImageMinImageMinimageMinimage_min. If the parameters MaskHeightMaskHeightMaskHeightmaskHeightmask_height or MaskWidthMaskWidthMaskWidthmaskWidthmask_width are even, they are changed to the next larger 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) objectHImageHObjectHObjectHobject (byte / direction / cyclic / uint2 / int2 / int4 / real)

Image for which the minimum gray values are to be calculated.

ImageMinImageMinImageMinimageMinimage_min (output_object)  (multichannel-)image(-array) objectHImageHObjectHObjectHobject * (byte / direction / cyclic / uint2 / int2 / int4 / real)

Image containing the minimum gray values.

MaskHeightMaskHeightMaskHeightmaskHeightmask_height (input_control)  extent.y HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Height of the filter mask.

Default: 11

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

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

Minimum increment: 2

Recommended increment: 2

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

MaskWidthMaskWidthMaskWidthmaskWidthmask_width (input_control)  extent.x HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Width of the filter mask.

Default: 11

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

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

Minimum increment: 2

Recommended increment: 2

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

Result

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

See also

gray_dilation_rectgray_dilation_rectGrayDilationRectGrayDilationRectgray_dilation_rect

Module

Foundation