overpaint_regionoverpaint_regionOverpaintRegionOverpaintRegionoverpaint_region (Operator)

Name

overpaint_regionoverpaint_regionOverpaintRegionOverpaintRegionoverpaint_region — Overpaint regions in an image.

Signature

Description

overpaint_regionoverpaint_regionOverpaintRegionOverpaintRegionoverpaint_region paints the regions given in RegionRegionRegionregionregion with a constant gray value into the image given in ImageImageImageimageimage. 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 TypeTypeTypetypetype determines whether the region should be painted filled ('fill'"fill""fill""fill""fill") or whether only its boundary should be painted ('margin'"margin""margin""margin""margin").

If you do not want to modify ImageImageImageimageimage itself, you can use the operator paint_regionpaint_regionPaintRegionPaintRegionpaint_region, which returns the result in a newly created image.

Attention

overpaint_regionoverpaint_regionOverpaintRegionOverpaintRegionoverpaint_region modifies the content of an already existing image (ImageImageImageimageimage). Besides, even other image objects may be affected: For example, if you created ImageImageImageimageimage via copy_objcopy_objCopyObjCopyObjcopy_obj from another image object (or vice versa), overpaint_regionoverpaint_regionOverpaintRegionOverpaintRegionoverpaint_region will also modify the image matrix of this other image object. Therefore, overpaint_regionoverpaint_regionOverpaintRegionOverpaintRegionoverpaint_region should only be used to overpaint newly created image objects. Typical operators for this task are, e.g., gen_image_constgen_image_constGenImageConstGenImageConstgen_image_const (creates a new image with a specified size), gen_image_protogen_image_protoGenImageProtoGenImageProtogen_image_proto (creates an image with the size of a specified prototype image) or copy_imagecopy_imageCopyImageCopyImagecopy_image (creates an image as the copy of a specified image).

Execution Information

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

This operator modifies the state of the following input parameter:

• ImageImageImageimageimage

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

* Paint a rectangle into a new image (New1)

gen_rectangle1(Rectangle,100.0,100.0,300.0,300.0)
* generate a black image
gen_image_const(New1,'byte', 768, 576)
* paint a white rectangle
overpaint_region(New1,Rectangle,255.0,'fill')

/* Paint a rectangle into a new image (New1) */

gen_rectangle1(&Rectangle,100.0,100.0,300.0,300.0);
/* generate a black image */
gen_image_const(&New1,"byte", 768, 576)
/* paint a white rectangle */
overpaint_region(New1,Rectangle,255.0,"fill");

* Paint a rectangle into a new image (New1)

gen_rectangle1(Rectangle,100.0,100.0,300.0,300.0)
* generate a black image
gen_image_const(New1,'byte', 768, 576)
* paint a white rectangle
overpaint_region(New1,Rectangle,255.0,'fill')

* Paint a rectangle into a new image (New1)

gen_rectangle1(Rectangle,100.0,100.0,300.0,300.0)
* generate a black image
gen_image_const(New1,'byte', 768, 576)
* paint a white rectangle
overpaint_region(New1,Rectangle,255.0,'fill')

Result

overpaint_regionoverpaint_regionOverpaintRegionOverpaintRegionoverpaint_region 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>:)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>). If necessary, an exception is raised.

Possible Predecessors

read_imageread_imageReadImageReadImageread_image, gen_image_constgen_image_constGenImageConstGenImageConstgen_image_const, gen_image_protogen_image_protoGenImageProtoGenImageProtogen_image_proto, reduce_domainreduce_domainReduceDomainReduceDomainreduce_domain

Alternatives

set_grayvalset_grayvalSetGrayvalSetGrayvalset_grayval, paint_regionpaint_regionPaintRegionPaintRegionpaint_region, paint_xldpaint_xldPaintXldPaintXldpaint_xld

See also

reduce_domainreduce_domainReduceDomainReduceDomainreduce_domain, set_drawset_drawSetDrawSetDrawset_draw, paint_graypaint_grayPaintGrayPaintGraypaint_gray, overpaint_grayoverpaint_grayOverpaintGrayOverpaintGrayoverpaint_gray, gen_image_constgen_image_constGenImageConstGenImageConstgen_image_const

Module

Foundation