gray_opening_shapegray_opening_shapeGrayOpeningShapeGrayOpeningShape (Operator)


gray_opening_shapegray_opening_shapeGrayOpeningShapeGrayOpeningShape — Perform a gray value opening with a selected mask.


gray_opening_shape(Image : ImageOpening : MaskHeight, MaskWidth, MaskShape : )

Herror gray_opening_shape(const Hobject Image, Hobject* ImageOpening, double MaskHeight, double MaskWidth, const char* MaskShape)

Herror T_gray_opening_shape(const Hobject Image, Hobject* ImageOpening, const Htuple MaskHeight, const Htuple MaskWidth, const Htuple MaskShape)

void GrayOpeningShape(const HObject& Image, HObject* ImageOpening, const HTuple& MaskHeight, const HTuple& MaskWidth, const HTuple& MaskShape)

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

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

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

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

static void HOperatorSet.GrayOpeningShape(HObject image, out HObject imageOpening, HTuple maskHeight, HTuple maskWidth, HTuple maskShape)

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

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


gray_opening_shapegray_opening_shapeGrayOpeningShapeGrayOpeningShapeGrayOpeningShape applies a gray value opening to the input image ImageImageImageImageimage with the structuring element of shape MaskShapeMaskShapeMaskShapeMaskShapemaskShape. The mask's offset values are 0 and its horizontal and vertical size is defined by MaskHeightMaskHeightMaskHeightMaskHeightmaskHeight and MaskWidthMaskWidthMaskWidthMaskWidthmaskWidth. The resulting image is returned in ImageOpeningImageOpeningImageOpeningImageOpeningimageOpening.

If the parameters MaskHeightMaskHeightMaskHeightMaskHeightmaskHeight or MaskWidthMaskWidthMaskWidthMaskWidthmaskWidth 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 ImageOpeningImageOpeningImageOpeningImageOpeningimageOpening is interpolated from the two intermediate images. Therefore, note that gray_opening_shapegray_opening_shapeGrayOpeningShapeGrayOpeningShapeGrayOpeningShape returns different results for mask sizes of, e.g., 4 and 4.0!

In case of the values 'rhombus' and 'octagon' for the MaskShapeMaskShapeMaskShapeMaskShapemaskShape control parameter, MaskHeightMaskHeightMaskHeightMaskHeightmaskHeight and MaskWidthMaskWidthMaskWidthMaskWidthmaskWidth must be equal. The parameter value 'octagon' for MaskShapeMaskShapeMaskShapeMaskShapemaskShape 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 opening of an image i with a structuring element s is defined as i.e., an erosion of the image with s followed by a dilation with s (see gray_erosion_shapegray_erosion_shapeGrayErosionShapeGrayErosionShapeGrayErosionShape and gray_dilation_shapegray_dilation_shapeGrayDilationShapeGrayDilationShapeGrayDilationShape).


Note that gray_opening_shapegray_opening_shapeGrayOpeningShapeGrayOpeningShapeGrayOpeningShape 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_opening_shapegray_opening_shapeGrayOpeningShapeGrayOpeningShapeGrayOpeningShape 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


ImageImageImageImageimage (input_object)  (multichannel-)image(-array) objectHImageHImageHobject (byte* / uint2*) *allowed for compute devices

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

ImageOpeningImageOpeningImageOpeningImageOpeningimageOpening (output_object)  (multichannel-)image(-array) objectHImageHImageHobject * (byte / uint2)

Image containing the minimum gray values.

MaskHeightMaskHeightMaskHeightMaskHeightmaskHeight (input_control)  extent.y HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Height of the filter mask.

Default value: 11

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

Typical range of values: 1.0 ≤ MaskHeight MaskHeight MaskHeight MaskHeight maskHeight ≤ 511.0

MaskWidthMaskWidthMaskWidthMaskWidthmaskWidth (input_control)  extent.x HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Width of the filter mask.

Default value: 11

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

Typical range of values: 1.0 ≤ MaskWidth MaskWidth MaskWidth MaskWidth maskWidth ≤ 511.0

MaskShapeMaskShapeMaskShapeMaskShapemaskShape (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Shape of the mask.

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

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


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



See also

gray_dilation_shapegray_dilation_shapeGrayDilationShapeGrayDilationShapeGrayDilationShape, gray_erosion_shapegray_erosion_shapeGrayErosionShapeGrayErosionShapeGrayErosionShape, openingopeningOpeningOpeningOpening