region_to_labelregion_to_labelRegionToLabelRegionToLabel (Operator)

Name

region_to_labelregion_to_labelRegionToLabelRegionToLabel — Convert regions to a label image.

Signature

region_to_label(Region : ImageLabel : Type, Width, Height : )

Description

region_to_labelregion_to_labelRegionToLabelRegionToLabelRegionToLabel converts the input regions into a label image according to their index (1..n), i.e., the first region is painted with the gray value 1, the second the gray value 2, etc. Only positive gray values are used. For 'byte'"byte""byte""byte""byte"-images the index is entered modulo 256.

Regions larger than the generated image are clipped appropriately. If regions overlap the regions with the higher image are entered (i.e., they are painted in the order in which they are contained in the input regions). If so desired, the regions can be made non-overlapping by calling expand_regionexpand_regionExpandRegionExpandRegionExpandRegion.

The background, i.e., the area not covered by any regions, is set to 0. This can be used to test in which image range no region is present.

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.

ImageLabelImageLabelImageLabelImageLabelimageLabel (output_object) image → object (byte / int2 / int4)

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

TypeTypeTypeTypetype (input_control) string → (string)

Pixel type of the result image.

Default value: 'int2' "int2" "int2" "int2" "int2"

List of values: 'byte'"byte""byte""byte""byte", 'int2'"int2""int2""int2""int2", 'int4'"int4""int4""int4""int4", 'int8'"int8""int8""int8""int8"

WidthWidthWidthWidthwidth (input_control) extent.y → (integer)

Width of the image to be generated.

Default value: 512

Suggested values: 64, 128, 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.x → (integer)

Height of the image to be generated.

Default value: 512

Suggested values: 64, 128, 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_labelregion_to_labelRegionToLabelRegionToLabelRegionToLabel 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, regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowing, connectionconnectionConnectionConnectionConnection, expand_regionexpand_regionExpandRegionExpandRegionExpandRegion

Possible Successors

get_grayvalget_grayvalGetGrayvalGetGrayvalGetGrayval, get_image_pointer1get_image_pointer1GetImagePointer1GetImagePointer1GetImagePointer1

Alternatives

region_to_binregion_to_binRegionToBinRegionToBinRegionToBin, paint_regionpaint_regionPaintRegionPaintRegionPaintRegion

Module

Foundation

Operators