serialize_imageT_serialize_imageSerializeImageSerializeImage (Operator)

Name

serialize_imageT_serialize_imageSerializeImageSerializeImage — Serialize an image object.

Signature

serialize_image(Image : : : SerializedItemHandle)

Description

serialize_imageserialize_imageSerializeImageSerializeImageSerializeImage serializes an image object (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem for an introduction of the basic principle of serialization). The image object is defined by the parameter ImageImageImageImageimage. The serialized image object is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle and can be deserialized by deserialize_imagedeserialize_imageDeserializeImageDeserializeImageDeserializeImage.

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

ImageImageImageImageimage (input_object) (multichannel-)image(-array) → object (byte / direction / cyclic / int1 / complex / int2 / uint2 / vector_field / int4 / int8 / real)

Image object.

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (output_control) serialized_item → (handle)

Handle of the serialized item.

Result

If the parameters are valid, the operator serialize_imageserialize_imageSerializeImageSerializeImageSerializeImage returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, read_imageread_imageReadImageReadImageReadImage

Possible Successors

fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem, send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemSendSerializedItem, deserialize_imagedeserialize_imageDeserializeImageDeserializeImageDeserializeImage

Module

Foundation

Operators