gen_image_protogen_image_protoGenImageProtoGenImageProto (Operator)


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


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)


gen_image_protogen_image_protoGenImageProtoGenImageProtoGenImageProto creates an output image ImageClearedImageClearedImageClearedImageClearedimageCleared 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. ImageClearedImageClearedImageClearedImageClearedimageCleared has the same dimensions and pixel type as the input image ImageImageImageImageimage.

Execution Information


ImageImageImageImageimage (input_object)  singlechannelimage objectHImageHImageHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Input image.

ImageClearedImageClearedImageClearedImageClearedimageCleared (output_object)  image objectHImageHImageHobject * (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Image with constant gray value.

GrayvalGrayvalGrayvalGrayvalgrayval (input_control)  number HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Gray value to be used for the output image.

Default value: 0

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


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


set_grayvalset_grayvalSetGrayvalSetGrayvalSetGrayval, paint_graypaint_grayPaintGrayPaintGrayPaintGray, gen_image_constgen_image_constGenImageConstGenImageConstGenImageConst, copy_imagecopy_imageCopyImageCopyImageCopyImage

See also