Operator Reference

HALCON Operator Reference / Image / Creation
ClassesClasses | | Operators

gen_image_protogen_image_protoGenImageProtoGenImageProtogen_image_proto (Operator)

gen_image_protogen_image_protoGenImageProtoGenImageProtogen_image_proto — Create an image with a specified constant gray value.

Signature

gen_image_proto(Image : ImageCleared : Grayval : )

Herror gen_image_proto(const Hobject Image, Hobject* ImageCleared, double Grayval)

Herror T_gen_image_proto(const Hobject Image, Hobject* ImageCleared, const Htuple Grayval)

void GenImageProto(const HObject& Image, HObject* ImageCleared, const HTuple& Grayval)

HImage HImage::GenImageProto(const HTuple& Grayval) const

HImage HImage::GenImageProto(double Grayval) const

static void HOperatorSet.GenImageProto(HObject image, out HObject imageCleared, HTuple grayval)

HImage HImage.GenImageProto(HTuple grayval)

HImage HImage.GenImageProto(double grayval)

def gen_image_proto(image: HObject, grayval: Union[int, float]) -> HObject

Description

gen_image_protogen_image_protoGenImageProtoGenImageProtogen_image_proto creates an output image ImageClearedImageClearedImageClearedimageClearedimage_cleared with the constant gray value GrayvalGrayvalGrayvalgrayvalgrayval. If the input image is of type direction, gray values in result image that are not in the value range that is valid for direction images are set to the value 255 to mark them as invalid. ImageClearedImageClearedImageClearedimageClearedimage_cleared has the same dimensions and pixel type as the input image ImageImageImageimageimage.

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

ImageImageImageimageimage (input_object)  singlechannelimage → objectHImageHObjectHObjectHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Input image.

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

Image with constant gray value.

GrayvalGrayvalGrayvalgrayvalgrayval (input_control)  number → HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Gray value to be used for the output image.

Default: 0

Suggested values: 0, 1, 2, 5, 10, 16, 32, 64, 128, 253, 254, 255

Result

gen_image_protogen_image_protoGenImageProtoGenImageProtogen_image_proto returns 2 ( H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Alternatives

set_grayvalset_grayvalSetGrayvalSetGrayvalset_grayval, paint_graypaint_grayPaintGrayPaintGraypaint_gray, gen_image_constgen_image_constGenImageConstGenImageConstgen_image_const, copy_imagecopy_imageCopyImageCopyImagecopy_image

See also

get_image_pointer1get_image_pointer1GetImagePointer1GetImagePointer1get_image_pointer1

Module

Foundation

ClassesClasses | | Operators