Operator Reference

HALCON Operator Reference / Image / Creation

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

region_to_binregion_to_binRegionToBinRegionToBinregion_to_bin (Operator)

region_to_binregion_to_binRegionToBinRegionToBinregion_to_bin — Convert a region into a binary byte-image.

Signature

region_to_bin(Region : BinImage : ForegroundGray, BackgroundGray, Width, Height : )

Herror region_to_bin(const Hobject Region, Hobject* BinImage, const Hlong ForegroundGray, const Hlong BackgroundGray, const Hlong Width, const Hlong Height)

Herror T_region_to_bin(const Hobject Region, Hobject* BinImage, const Htuple ForegroundGray, const Htuple BackgroundGray, const Htuple Width, const Htuple Height)

void RegionToBin(const HObject& Region, HObject* BinImage, const HTuple& ForegroundGray, const HTuple& BackgroundGray, const HTuple& Width, const HTuple& Height)

HImage HRegion::RegionToBin(Hlong ForegroundGray, Hlong BackgroundGray, Hlong Width, Hlong Height) const

static void HOperatorSet.RegionToBin(HObject region, out HObject binImage, HTuple foregroundGray, HTuple backgroundGray, HTuple width, HTuple height)

HImage HRegion.RegionToBin(int foregroundGray, int backgroundGray, int width, int height)

def region_to_bin(region: HObject, foreground_gray: int, background_gray: int, width: int, height: int) -> HObject

Description

region_to_binregion_to_binRegionToBinRegionToBinregion_to_bin converts the input region given in RegionRegionRegionregionregion into a byte-image and assigns a gray value of ForegroundGrayForegroundGrayForegroundGrayforegroundGrayforeground_gray to all pixels in the region. If the input region is larger than the generated image, it is clipped at the image borders. The background is set to BackgroundGrayBackgroundGrayBackgroundGraybackgroundGraybackground_gray.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

RegionRegionRegionregionregion (input_object)  region(-array) → objectHRegionHObjectHObjectHobject

Regions to be converted.

BinImageBinImageBinImagebinImagebin_image (output_object)  image → objectHImageHObjectHObjectHobject * (byte)

Result image of dimension Width * Height containing the converted regions.

ForegroundGrayForegroundGrayForegroundGrayforegroundGrayforeground_gray (input_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Gray value in which the regions are displayed.

Default: 255

Suggested values: 0, 1, 50, 100, 128, 150, 200, 254, 255

Value range: 0 ≤ ForegroundGray ForegroundGray ForegroundGray foregroundGray foreground_gray ≤ 255 (lin)

Recommended increment: 1

BackgroundGrayBackgroundGrayBackgroundGraybackgroundGraybackground_gray (input_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Gray value in which the background is displayed.

Default: 0

Suggested values: 0, 1, 50, 100, 128, 150, 200, 254, 255

Value range: 0 ≤ BackgroundGray BackgroundGray BackgroundGray backgroundGray background_gray ≤ 255 (lin)

Recommended increment: 1

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

Width of the image to be generated.

Default: 512

Suggested values: 256, 512, 1024

Value range: 1 ≤ Width Width Width width width ≤ 1024 (lin)

Minimum increment: 1

Recommended increment: 16

Restriction: Width >= 1

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

Height of the image to be generated.

Default: 512

Suggested values: 256, 512, 1024

Value range: 1 ≤ Height Height Height height height ≤ 1024 (lin)

Minimum increment: 1

Recommended increment: 16

Restriction: Height >= 1

Complexity

O(2*HeightHeightHeightheightheight*WidthWidthWidthwidthwidth).

Result

region_to_binregion_to_binRegionToBinRegionToBinregion_to_bin always returns 2 ( H_MSG_TRUE) . The behavior in case of empty input (no regions given) 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>) and the behavior in case of an empty input region via set_system('empty_region_result',<Result>)set_system("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)set_system("empty_region_result",<Result>). If necessary, an exception is raised.

Possible Predecessors

thresholdthresholdThresholdThresholdthreshold, connectionconnectionConnectionConnectionconnection, regiongrowingregiongrowingRegiongrowingRegiongrowingregiongrowing, pouringpouringPouringPouringpouring

Possible Successors

get_grayvalget_grayvalGetGrayvalGetGrayvalget_grayval

Alternatives

region_to_labelregion_to_labelRegionToLabelRegionToLabelregion_to_label, paint_regionpaint_regionPaintRegionPaintRegionpaint_region, set_grayvalset_grayvalSetGrayvalSetGrayvalset_grayval

See also

gen_image_protogen_image_protoGenImageProtoGenImageProtogen_image_proto, paint_graypaint_grayPaintGrayPaintGraypaint_gray

Module

Foundation

---

ClassesClasses | | Operators