clear_image ( Image : ImageCleared : Greyval : )

Set the gray values of an image to a specified value.

clear_image sets the gray values of the image ImageCleared to the value Greyval. The input image is not modified. It is merely used to determine the size of the output image.


Parameters

Image (input_object)
image -> object
Image, whose gray values are to be cleared.

ImageCleared (output_object)
image -> object
Image with constant gray value.

Greyval (input_control)
number -> real / integer
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


Result

clear_image returns TRUE if all parameters are correct. If necessary, an exception is raised.


Possible Predecessors

obj_def


Alternatives

set_greyval__, paint_grey__, new_image__, dup_image


See also

get_image_pointer__



Copyright © 1996-1997 MVTec Software GmbH