gen_image_protogen_image_protoGenImageProtoGenImageProtogen_image_proto (Operator)
Name
gen_image_protogen_image_protoGenImageProtoGenImageProtogen_image_proto — Create an image with a specified constant gray value.
Signature
def gen_image_proto(image: HObject, grayval: Union[int, float]) -> HObject
Description
gen_image_protogen_image_protoGenImageProtoGenImageProtoGenImageProtogen_image_proto creates an output image
ImageClearedImageClearedImageClearedImageClearedimageClearedimage_cleared with the constant gray value GrayvalGrayvalGrayvalGrayvalgrayvalgrayval.
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.
ImageClearedImageClearedImageClearedImageClearedimageClearedimage_cleared has the same dimensions and pixel type as the
input image 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
ImageImageImageImageimageimage (input_object) singlechannelimage → objectHImageHObjectHImageHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)
Input image.
ImageClearedImageClearedImageClearedImageClearedimageClearedimage_cleared (output_object) image → objectHImageHObjectHImageHobject * (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)
Image with constant gray value.
GrayvalGrayvalGrayvalGrayvalgrayvalgrayval (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_protoGenImageProtoGenImageProtoGenImageProtogen_image_proto returns 2 (
H_MSG_TRUE)
if all parameters are correct.
If necessary, an exception is raised.
Alternatives
set_grayvalset_grayvalSetGrayvalSetGrayvalSetGrayvalset_grayval,
paint_graypaint_grayPaintGrayPaintGrayPaintGraypaint_gray,
gen_image_constgen_image_constGenImageConstGenImageConstGenImageConstgen_image_const,
copy_imagecopy_imageCopyImageCopyImageCopyImagecopy_image
See also
get_image_pointer1get_image_pointer1GetImagePointer1GetImagePointer1GetImagePointer1get_image_pointer1
Module
Foundation