Operator Reference

HALCON Operator Reference / Morphology / Gray Values
ClassesClasses | | Operators

gray_closing_shapegray_closing_shapeGrayClosingShapeGrayClosingShapegray_closing_shape (Operator)

gray_closing_shapegray_closing_shapeGrayClosingShapeGrayClosingShapegray_closing_shape — Perform a gray value closing with a selected mask.

Signature

gray_closing_shape(Image : ImageClosing : MaskHeight, MaskWidth, MaskShape : )

Herror gray_closing_shape(const Hobject Image, Hobject* ImageClosing, double MaskHeight, double MaskWidth, const char* MaskShape)

Herror T_gray_closing_shape(const Hobject Image, Hobject* ImageClosing, const Htuple MaskHeight, const Htuple MaskWidth, const Htuple MaskShape)

void GrayClosingShape(const HObject& Image, HObject* ImageClosing, const HTuple& MaskHeight, const HTuple& MaskWidth, const HTuple& MaskShape)

HImage HImage::GrayClosingShape(const HTuple& MaskHeight, const HTuple& MaskWidth, const HString& MaskShape) const

HImage HImage::GrayClosingShape(double MaskHeight, double MaskWidth, const HString& MaskShape) const

HImage HImage::GrayClosingShape(double MaskHeight, double MaskWidth, const char* MaskShape) const

HImage HImage::GrayClosingShape(double MaskHeight, double MaskWidth, const wchar_t* MaskShape) const   ( Windows only)

static void HOperatorSet.GrayClosingShape(HObject image, out HObject imageClosing, HTuple maskHeight, HTuple maskWidth, HTuple maskShape)

HImage HImage.GrayClosingShape(HTuple maskHeight, HTuple maskWidth, string maskShape)

HImage HImage.GrayClosingShape(double maskHeight, double maskWidth, string maskShape)

def gray_closing_shape(image: HObject, mask_height: Union[int, float], mask_width: Union[int, float], mask_shape: str) -> HObject

Description

gray_closing_shapegray_closing_shapeGrayClosingShapeGrayClosingShapegray_closing_shape applies a gray value closing to the input image ImageImageImageimageimage with the structuring element of shape MaskShapeMaskShapeMaskShapemaskShapemask_shape. The mask's offset values are 0 and its horizontal and vertical size is defined by MaskHeightMaskHeightMaskHeightmaskHeightmask_height and MaskWidthMaskWidthMaskWidthmaskWidthmask_width. The resulting image is returned in ImageClosingImageClosingImageClosingimageClosingimage_closing.

If the parameters MaskHeightMaskHeightMaskHeightmaskHeightmask_height or MaskWidthMaskWidthMaskWidthmaskWidthmask_width are of the type integer and are even, they are changed to the next larger odd value. In contrast, if at least one of the two parameters is of the type float, the input image ImageImageImageimageimage is transformed with both the next larger and the next smaller odd mask size, and the output image ImageClosingImageClosingImageClosingimageClosingimage_closing is interpolated from the two intermediate images. Therefore, note that gray_closing_shapegray_closing_shapeGrayClosingShapeGrayClosingShapegray_closing_shape returns different results for mask sizes of, e.g., 4 and 4.0!

In case of the values 'rhombus' and 'octagon' for the MaskShapeMaskShapeMaskShapemaskShapemask_shape control parameter, MaskHeightMaskHeightMaskHeightmaskHeightmask_height and MaskWidthMaskWidthMaskWidthmaskWidthmask_width must be equal. The parameter value 'octagon' for MaskShapeMaskShapeMaskShapemaskShapemask_shape denotes an equilateral octagonal mask which is a suitable approximation for a circular structure. At the border of the image the gray values are mirrored.

The gray value closing of an image i with a structuring element s is defined as i.e., a dilation of the image with s followed by an erosion with s (see gray_dilation_shapegray_dilation_shapeGrayDilationShapeGrayDilationShapegray_dilation_shape and gray_erosion_shapegray_erosion_shapeGrayErosionShapeGrayErosionShapegray_erosion_shape).

Attention

Note that gray_closing_shapegray_closing_shapeGrayClosingShapeGrayClosingShapegray_closing_shape requires considerably more time for mask sizes of type float than for mask sizes of type integer. This is especially true for rectangular masks with different width and height!

gray_closing_shapegray_closing_shapeGrayClosingShapeGrayClosingShapegray_closing_shape can be executed on OpenCL devices. In case of mask sizes of type float the result can vary slightly from the CPU as the interpolation is calculated in single precision on the OpenCL device.

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* / uint2*) *allowed for compute devices

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

ImageClosingImageClosingImageClosingimageClosingimage_closing (output_object)  (multichannel-)image(-array) → objectHImageHObjectHObjectHobject * (byte / uint2)

Image containing the minimum gray values.

MaskHeightMaskHeightMaskHeightmaskHeightmask_height (input_control)  extent.y → HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Height of the filter mask.

Default: 11

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

Value range: 1.0 ≤ MaskHeight MaskHeight MaskHeight maskHeight mask_height ≤ 511.0

MaskWidthMaskWidthMaskWidthmaskWidthmask_width (input_control)  extent.x → HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Width of the filter mask.

Default: 11

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

Value range: 1.0 ≤ MaskWidth MaskWidth MaskWidth maskWidth mask_width ≤ 511.0

MaskShapeMaskShapeMaskShapemaskShapemask_shape (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Shape of the mask.

Default: 'octagon' "octagon" "octagon" "octagon" "octagon"

List of values: 'octagon'"octagon""octagon""octagon""octagon", 'rectangle'"rectangle""rectangle""rectangle""rectangle", 'rhombus'"rhombus""rhombus""rhombus""rhombus"

Result

gray_closing_shapegray_closing_shapeGrayClosingShapeGrayClosingShapegray_closing_shape returns 2 ( H_MSG_TRUE) if all parameters are correct.

Alternatives

gray_closinggray_closingGrayClosingGrayClosinggray_closing

See also

gray_dilation_shapegray_dilation_shapeGrayDilationShapeGrayDilationShapegray_dilation_shape, gray_erosion_shapegray_erosion_shapeGrayErosionShapeGrayErosionShapegray_erosion_shape, closingclosingClosingClosingclosing

Module

Foundation

ClassesClasses | | Operators