Operator Reference

gray_bothatgray_bothatGrayBothatGrayBothatgray_bothat (Operator)

gray_bothatgray_bothatGrayBothatGrayBothatgray_bothat — Perform a gray value bottom hat transformation on an image.

Signature

gray_bothat(Image, SE : ImageBotHat : : )

Herror gray_bothat(const Hobject Image, const Hobject SE, Hobject* ImageBotHat)

Herror T_gray_bothat(const Hobject Image, const Hobject SE, Hobject* ImageBotHat)

void GrayBothat(const HObject& Image, const HObject& SE, HObject* ImageBotHat)

HImage HImage::GrayBothat(const HImage& SE) const

static void HOperatorSet.GrayBothat(HObject image, HObject SE, out HObject imageBotHat)

HImage HImage.GrayBothat(HImage SE)

def gray_bothat(image: HObject, se: HObject) -> HObject

Description

gray_bothatgray_bothatGrayBothatGrayBothatgray_bothat applies a gray value bottom hat transformation to the input image ImageImageImageimageimage with the structuring element SESESESEse. The image type of the structuring element SESESESEse must match the image type of the input image ImageImageImageimageimage. The gray value bottom hat transformation of an image i with a structuring element s is defined as i.e., the difference of the closing of the image with s and the image (see gray_closinggray_closingGrayClosingGrayClosinggray_closing). For the generation of structuring elements, see read_gray_seread_gray_seReadGraySeReadGraySeread_gray_se.

The gray value erosion is particularly fast for flat structuring elements, i.e. structuring elements with a constant gray level within their domain.

Execution Information

  • 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 internal data level.

Parameters

ImageImageImageimageimage (input_object)  (multichannel-)image(-array) objectHImageHObjectHObjectHobject (byte / uint2 / real)

Input image.

SESESESEse (input_object)  singlechannelimage objectHImageHObjectHObjectHobject (byte / uint2 / real)

Structuring element.

ImageBotHatImageBotHatImageBotHatimageBotHatimage_bot_hat (output_object)  (multichannel-)image(-array) objectHImageHObjectHObjectHobject * (byte / uint2 / real)

Bottom hat image.

Result

gray_bothatgray_bothatGrayBothatGrayBothatgray_bothat returns 2 ( H_MSG_TRUE) if the structuring element is not the empty region. Otherwise, an exception is raised.

Possible Predecessors

read_gray_seread_gray_seReadGraySeReadGraySeread_gray_se, gen_disc_segen_disc_seGenDiscSeGenDiscSegen_disc_se, read_imageread_imageReadImageReadImageread_image

Possible Successors

thresholdthresholdThresholdThresholdthreshold

Alternatives

gray_closinggray_closingGrayClosingGrayClosinggray_closing

See also

gray_tophatgray_tophatGrayTophatGrayTophatgray_tophat, top_hattop_hatTopHatTopHattop_hat, gray_erosion_rectgray_erosion_rectGrayErosionRectGrayErosionRectgray_erosion_rect, sub_imagesub_imageSubImageSubImagesub_image

Module

Foundation