Operator Reference

paint_graypaint_grayPaintGrayPaintGraypaint_gray (Operator)

paint_graypaint_grayPaintGrayPaintGraypaint_gray — Paint the gray values of an image into another image.

Signature

Herror paint_gray(const Hobject ImageSource, const Hobject ImageDestination, Hobject* MixedImage)

Herror T_paint_gray(const Hobject ImageSource, const Hobject ImageDestination, Hobject* MixedImage)

void PaintGray(const HObject& ImageSource, const HObject& ImageDestination, HObject* MixedImage)

HImage HImage::PaintGray(const HImage& ImageDestination) const

def paint_gray(image_source: HObject, image_destination: HObject) -> HObject

Description

paint_graypaint_grayPaintGrayPaintGraypaint_gray paints the gray values of the image given in ImageSourceImageSourceImageSourceimageSourceimage_source into the image in ImageDestinationImageDestinationImageDestinationimageDestinationimage_destination and returns the resulting image in MixedImageMixedImageMixedImagemixedImagemixed_image. Only the gray values of the domain of ImageSourceImageSourceImageSourceimageSourceimage_source are copied (see reduce_domainreduce_domainReduceDomainReduceDomainreduce_domain).

As an alternative to paint_graypaint_grayPaintGrayPaintGraypaint_gray, you can use the operator overpaint_grayoverpaint_grayOverpaintGrayOverpaintGrayoverpaint_gray, which directly paints the gray values into ImageDestinationImageDestinationImageDestinationimageDestinationimage_destination.

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

ImageSourceImageSourceImageSourceimageSourceimage_source (input_object)  (multichannel-)image objectHImageHObjectHObjectHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / real / complex / vector_field)

Input image containing the desired gray values.

ImageDestinationImageDestinationImageDestinationimageDestinationimage_destination (input_object)  (multichannel-)image objectHImageHObjectHObjectHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / real / complex / vector_field)

Input image to be painted over.

MixedImageMixedImageMixedImagemixedImagemixed_image (output_object)  image objectHImageHObjectHObjectHobject * (byte / direction / cyclic / int1 / int2 / uint2 / int4 / real / complex / vector_field)

Result image.

Example (HDevelop)

* Copy a circular part of the image 'monkey' into the image 'fabrik':

read_image(Image,'monkey')
gen_circle(Circle,200,200,150)
reduce_domain(Image,Circle,Mask)
read_image(Image2,'fabrik')
* Copy a part of the image 'monkey' into 'fabrik'
paint_gray(Mask,Image2,MixedImage)

Example (C)

/* Copy a circular part of the image 'monkey' into the image 'fabrik': */

read_image(&Image,"monkey");
gen_circle(&Circle,200.0,200.0,150.0);
reduce_domain(Image,Circle,&Mask);
read_image(&Image,"fabrik");
/* Copy a part of the image 'monkey' into 'fabrik' */
paint_gray(Mask,Image2,&MixedImage);

Example (HDevelop)

* Copy a circular part of the image 'monkey' into the image 'fabrik':

read_image(Image,'monkey')
gen_circle(Circle,200,200,150)
reduce_domain(Image,Circle,Mask)
read_image(Image2,'fabrik')
* Copy a part of the image 'monkey' into 'fabrik'
paint_gray(Mask,Image2,MixedImage)

Example (HDevelop)

* Copy a circular part of the image 'monkey' into the image 'fabrik':

read_image(Image,'monkey')
gen_circle(Circle,200,200,150)
reduce_domain(Image,Circle,Mask)
read_image(Image2,'fabrik')
* Copy a part of the image 'monkey' into 'fabrik'
paint_gray(Mask,Image2,MixedImage)

Result

paint_graypaint_grayPaintGrayPaintGraypaint_gray returns 2 ( H_MSG_TRUE) if all parameters are correct. 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

Alternatives

get_image_pointer1get_image_pointer1GetImagePointer1GetImagePointer1get_image_pointer1, set_grayvalset_grayvalSetGrayvalSetGrayvalset_grayval, copy_imagecopy_imageCopyImageCopyImagecopy_image, overpaint_grayoverpaint_grayOverpaintGrayOverpaintGrayoverpaint_gray

See also

paint_regionpaint_regionPaintRegionPaintRegionpaint_region, overpaint_regionoverpaint_regionOverpaintRegionOverpaintRegionoverpaint_region

Module

Foundation