Skip to content

serialize_imageSerializeImageSerializeImageserialize_imageT_serialize_image🔗

Short description🔗

serialize_imageSerializeImageSerializeImageserialize_imageT_serialize_image — Serialize an image object.

Signature🔗

serialize_image( image Image, out serialized_item SerializedItemHandle )void SerializeImage( const HObject& Image, HTuple* SerializedItemHandle )static void HOperatorSet.SerializeImage( HObject image, out HTuple serializedItemHandle )def serialize_image( image: HObject ) -> HHandle

Herror T_serialize_image( const Hobject Image, Htuple* SerializedItemHandle )

HSerializedItem HImage::SerializeImage( ) const

HSerializedItem HImage.SerializeImage( )

Description🔗

serialize_imageSerializeImage serializes an image object (see fwrite_serialized_itemFwriteSerializedItem for an introduction of the basic principle of serialization). The image object is defined by the parameter Imageimageimage. The serialized image object is returned by the handle SerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_imageDeserializeImage.

Execution information🔗

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🔗

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

Image object.

SerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → (handle)HTuple (HHandle)HSerializedItem, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the serialized item.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

read_imageReadImage

Possible successors

fwrite_serialized_itemFwriteSerializedItem, send_serialized_itemSendSerializedItem, deserialize_imageDeserializeImage

Module🔗

Foundation