region_to_binregion_to_binRegionToBinRegionToBin (Operator)

Name

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

Signature

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

Description

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

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) → object

Regions to be converted.

BinImageBinImageBinImageBinImagebinImage (output_object) image → object (byte)

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

ForegroundGrayForegroundGrayForegroundGrayForegroundGrayforegroundGray (input_control) integer → (integer)

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 → (integer)

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 → (integer)

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 → (integer)

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

Complexity

O(2*HeightHeightHeightHeightheight*WidthWidthWidthWidthwidth).

Result

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

get_grayvalget_grayvalGetGrayvalGetGrayvalGetGrayval

Alternatives

region_to_labelregion_to_labelRegionToLabelRegionToLabelRegionToLabel, paint_regionpaint_regionPaintRegionPaintRegionPaintRegion, set_grayvalset_grayvalSetGrayvalSetGrayvalSetGrayval

Module

Foundation

Operators