paint_regionPaintRegionPaintRegionpaint_regionpaint_region🔗

Short description🔗

paint_regionPaintRegionPaintRegionpaint_regionpaint_region — Paint regions into an image.

Signature🔗

paint_region( region Region, image Image, out image ImageResult, number Grayval, string Type )

Description🔗

paint_regionPaintRegion paints the regions given in Regionregionregion with a constant gray value into the image given in Imageimageimage and returns the result in ImageResultimageResultimage_result. These gray values can either be specified for each channel once, valid for all regions, or for each region separately. To define the latter, group the channel gray values g of each region and concatenate them to a tuple according to the regions’ order, e.g., for a three channel image:

    [g(channel1,region1), g(channel2,region1), g(channel3,region1), g(channel1,region2), ... ].

If the input image is of type direction, gray values that are not in the value range that is valid for direction images are set to the value 255 to mark them as invalid. The parameter Typetypetype determines whether the region should be painted filled ('fill'"fill") or whether only its boundary should be painted ('margin'"margin").

As an alternative to paint_regionPaintRegion, you can use the operator overpaint_regionOverpaintRegion, which directly paints the regions into Imageimageimage.

Execution information🔗

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🔗

Regionregionregion (input_object) region(-array) → objectHObjectHRegionHObjectHobject

Regions to be painted into the input image.

Imageimageimage (input_object) (multichannel-)image → object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex)

Image in which the regions are to be painted.

ImageResultimageResultimage_result (output_object) image → object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex)

Image containing the result.

Grayvalgrayvalgrayval (input_control) number(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Desired gray values of the regions.

Default: 255.0255.0
Suggested values: 0.0, 1.0, 2.0, 5.0, 10.0, 16.0, 32.0, 64.0, 128.0, 253.0, 254.0, 255.0

Typetypetype (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Paint regions filled or as boundaries.

Default: 'fill'"fill"
List of values: 'fill', 'margin'"fill", "margin"

Example🔗

(HDevelop)

* Paint a rectangle into the image 'monkey'

read_image(Image,'monkey')
gen_rectangle1(Rectangle,100.0,100.0,300.0,300.0)
* paint a white rectangle
paint_region(Rectangle,Image,ImageResult,255.0,'fill')

(C)

/* Paint a rectangle into the image 'monkey'  */

read_image(&Image,"monkey")\;
gen_rectangle1(&Rectangle,100.0,100.0,300.0,300.0)\;
/* paint a white rectangle */
paint_region(Rectangle,Image,&ImageResult,255.0,"fill")\;

Result🔗

paint_regionPaintRegion returns 2 (H_MSG_TRUE) if all parameters are correct. If the input is empty the behavior can be set via set_system(::'no_object_result',<Result>:). If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

read_imageReadImage, gen_image_constGenImageConst, gen_image_protoGenImageProto, reduce_domainReduceDomain

Alternatives

set_grayvalSetGrayval, overpaint_regionOverpaintRegion, paint_xldPaintXld

Module🔗

Foundation