serialize_imageT_serialize_imageSerializeImageSerializeImageserialize_image (Operator)
Name
serialize_imageT_serialize_imageSerializeImageSerializeImageserialize_image — Serialize an image object.
Signature
def serialize_image(image: HObject) -> HHandle
Description
serialize_imageserialize_imageSerializeImageSerializeImageSerializeImageserialize_image serializes an image object (see
fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item for an introduction of the basic
principle of serialization). The image object is defined by the parameter
ImageImageImageImageimageimage. The serialized image object is returned by the handle
SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by
deserialize_imagedeserialize_imageDeserializeImageDeserializeImageDeserializeImagedeserialize_image.
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) (multichannel-)image(-array) → objectHImageHObjectHImageHobject (byte / direction / cyclic / int1 / complex / int2 / uint2 / vector_field / int4 / int8 / real)
Image object.
SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → HSerializedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the serialized item.
Result
If the parameters are valid, the operator
serialize_imageserialize_imageSerializeImageSerializeImageSerializeImageserialize_image returns the value 2 (H_MSG_TRUE). If
necessary, an exception is raised.
Possible Predecessors
open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window,
read_imageread_imageReadImageReadImageReadImageread_image
Possible Successors
fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item,
send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemSendSerializedItemsend_serialized_item,
deserialize_imagedeserialize_imageDeserializeImageDeserializeImageDeserializeImagedeserialize_image
Module
Foundation