convert_image_type — Convert the type of an image.
convert_image_type(Image : ImageConverted : NewType : )
convert_image_type converts images of an arbitrary
type into an arbitrary new image type. If the conversion is done
from a larger to a smaller gray value range (e.g., from 'int4' to
'byte'), too large or too small values are simply “clipped”.
If the result images are of type 'direction', gray values that
are not in the value range that is valid for 'direction' images
are set to the value 255 to mark them as invalid. It
is therefore advisable to adapt the range of gray values by calling
scale_image before calling this operator. For images of
type complex, only the real part is converted. The imaginary part
is ignored. This facilitates an efficient conversion of images that
have been transformed back from the frequency domain. Such images
always have an imaginary part of 0.
The conversion to the 'int8' image format is only available on 64 bit systems! If the source and destination image type are identical, no new image matrix is allocated.
Image (input_object) (multichannel-)image(-array) → object (byte* / direction* / cyclic* / int1* / int2* / uint2* / int4* / int8 / real* / complex*) *allowed for compute devices
Image whose image type is to be changed.
ImageConverted (output_object) (multichannel-)image(-array) → object (byte* / direction* / cyclic* / int1* / int2* / uint2* / int4* / int8 / real* / complex*) *allowed for compute devices
Converted image.
NewType (input_control) string → (string)
Desired image type (i.e., type of the gray values).
Default value: 'byte'
List of values: 'byte', 'complex', 'cyclic', 'direction', 'int1', 'int2', 'int4', 'int8', 'real', 'uint2'
List of values (for compute devices): 'int1', 'int2', 'uint2', 'int4', 'byte', 'real', 'direction', 'cyclic', 'complex'
convert_image_type returns 2 (H_MSG_TRUE) if all parameters are
correct. If the input is empty the behavior can be set via
set_system('no_object_result',<Result>).
If necessary, an exception is raised.
Foundation