region_to_binregion_to_binRegionToBinRegionToBin (Operator)


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


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)


region_to_binregion_to_binRegionToBinRegionToBinRegionToBin converts the input region given in RegionRegionRegionRegionregion into a 'byte'"byte""byte""byte""byte"-image and assigns a gray value of ForegroundGrayForegroundGrayForegroundGrayForegroundGrayforegroundGray 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 BackgroundGrayBackgroundGrayBackgroundGrayBackgroundGraybackgroundGray.

Execution Information


RegionRegionRegionRegionregion (input_object)  region(-array) objectHRegionHRegionHobject

Regions to be converted.

BinImageBinImageBinImageBinImagebinImage (output_object)  image objectHImageHImageHobject * (byte)

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

ForegroundGrayForegroundGrayForegroundGrayForegroundGrayforegroundGray (input_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Gray value in which the regions are displayed.

Default value: 255

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

Typical range of values: 0 ≤ ForegroundGray ForegroundGray ForegroundGray ForegroundGray foregroundGray ≤ 255 (lin)

Recommended increment: 1

BackgroundGrayBackgroundGrayBackgroundGrayBackgroundGraybackgroundGray (input_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Gray value in which the background is displayed.

Default value: 0

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

Typical range of values: 0 ≤ BackgroundGray BackgroundGray BackgroundGray BackgroundGray backgroundGray ≤ 255 (lin)

Recommended increment: 1

WidthWidthWidthWidthwidth (input_control)  extent.x HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Width of the image to be generated.

Default value: 512

Suggested values: 256, 512, 1024

Typical range of values: 1 ≤ Width Width Width Width width ≤ 1024 (lin)

Minimum increment: 1

Recommended increment: 16

Restriction: Width >= 1

HeightHeightHeightHeightheight (input_control)  extent.y HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Height of the image to be generated.

Default value: 512

Suggested values: 256, 512, 1024

Typical range of values: 1 ≤ Height Height Height Height height ≤ 1024 (lin)

Minimum increment: 1

Recommended increment: 16

Restriction: Height >= 1




region_to_binregion_to_binRegionToBinRegionToBinRegionToBin 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>)SetSystem("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>)SetSystem("empty_region_result",<Result>). If necessary, an exception is raised.

Possible Predecessors

thresholdthresholdThresholdThresholdThreshold, connectionconnectionConnectionConnectionConnection, regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowing, pouringpouringPouringPouringPouring

Possible Successors



region_to_labelregion_to_labelRegionToLabelRegionToLabelRegionToLabel, paint_regionpaint_regionPaintRegionPaintRegionPaintRegion, set_grayvalset_grayvalSetGrayvalSetGrayvalSetGrayval

See also

gen_image_protogen_image_protoGenImageProtoGenImageProtoGenImageProto, paint_graypaint_grayPaintGrayPaintGrayPaintGray