paint_regionpaint_regionPaintRegionPaintRegionpaint_region (Operator)
Name
paint_regionpaint_regionPaintRegionPaintRegionpaint_region — Paint regions into an image.
Signature
void PaintRegion(const HObject& Region, const HObject& Image, HObject* ImageResult, const HTuple& Grayval, const HTuple& Type)
HImage HImage::PaintRegion(const HRegion& Region, const HTuple& Grayval, const HString& Type) const
HImage HImage::PaintRegion(const HRegion& Region, double Grayval, const HString& Type) const
HImage HImage::PaintRegion(const HRegion& Region, double Grayval, const char* Type) const
HImage HImage::PaintRegion(const HRegion& Region, double Grayval, const wchar_t* Type) const
(Windows only)
HImage HRegion::PaintRegion(const HImage& Image, const HTuple& Grayval, const HString& Type) const
HImage HRegion::PaintRegion(const HImage& Image, double Grayval, const HString& Type) const
HImage HRegion::PaintRegion(const HImage& Image, double Grayval, const char* Type) const
HImage HRegion::PaintRegion(const HImage& Image, double Grayval, const wchar_t* Type) const
(Windows only)
static void HOperatorSet.PaintRegion(HObject region, HObject image, out HObject imageResult, HTuple grayval, HTuple type)
HImage HImage.PaintRegion(HRegion region, HTuple grayval, string type)
HImage HImage.PaintRegion(HRegion region, double grayval, string type)
HImage HRegion.PaintRegion(HImage image, HTuple grayval, string type)
HImage HRegion.PaintRegion(HImage image, double grayval, string type)
def paint_region(region: HObject, image: HObject, grayval: MaybeSequence[Union[int, float]], type: str) -> HObject
Description
paint_regionpaint_regionPaintRegionPaintRegionPaintRegionpaint_region paints the regions given in RegionRegionRegionRegionregionregion with a
constant gray value into the image given in ImageImageImageImageimageimage and returns the
result in ImageResultImageResultImageResultImageResultimageResultimage_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 TypeTypeTypeTypetypetype determines whether the region should be painted
filled ('fill'"fill""fill""fill""fill""fill") or whether only its boundary should be painted
('margin'"margin""margin""margin""margin""margin").
As an alternative to paint_regionpaint_regionPaintRegionPaintRegionPaintRegionpaint_region, you can use the operator
overpaint_regionoverpaint_regionOverpaintRegionOverpaintRegionOverpaintRegionoverpaint_region, which directly paints the regions into
ImageImageImageImageimageimage.
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
RegionRegionRegionRegionregionregion (input_object) region(-array) → objectHRegionHObjectHRegionHobject
Regions to be painted into the input image.
ImageImageImageImageimageimage (input_object) (multichannel-)image → objectHImageHObjectHImageHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex)
Image in which the regions are to be painted.
ImageResultImageResultImageResultImageResultimageResultimage_result (output_object) image → objectHImageHObjectHImageHobject * (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex)
Image containing the result.
GrayvalGrayvalGrayvalGrayvalgrayvalgrayval (input_control) number(-array) → HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Desired gray values of the regions.
Default value: 255.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
TypeTypeTypeTypetypetype (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Paint regions filled or as boundaries.
Default value:
'fill'
"fill"
"fill"
"fill"
"fill"
"fill"
List of values: 'fill'"fill""fill""fill""fill""fill", 'margin'"margin""margin""margin""margin""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')
Example (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");
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')
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')
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')
Result
paint_regionpaint_regionPaintRegionPaintRegionPaintRegionpaint_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>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>).
If necessary, an exception is raised.
Possible Predecessors
read_imageread_imageReadImageReadImageReadImageread_image,
gen_image_constgen_image_constGenImageConstGenImageConstGenImageConstgen_image_const,
gen_image_protogen_image_protoGenImageProtoGenImageProtoGenImageProtogen_image_proto,
reduce_domainreduce_domainReduceDomainReduceDomainReduceDomainreduce_domain
Alternatives
set_grayvalset_grayvalSetGrayvalSetGrayvalSetGrayvalset_grayval,
overpaint_regionoverpaint_regionOverpaintRegionOverpaintRegionOverpaintRegionoverpaint_region,
paint_xldpaint_xldPaintXldPaintXldPaintXldpaint_xld
See also
reduce_domainreduce_domainReduceDomainReduceDomainReduceDomainreduce_domain,
paint_graypaint_grayPaintGrayPaintGrayPaintGraypaint_gray,
overpaint_grayoverpaint_grayOverpaintGrayOverpaintGrayOverpaintGrayoverpaint_gray,
set_drawset_drawSetDrawSetDrawSetDrawset_draw,
gen_image_constgen_image_constGenImageConstGenImageConstGenImageConstgen_image_const
Module
Foundation