Operator Reference

HALCON Operator Reference / File / Images
ClassesClasses | | Operators

serialize_imageT_serialize_imageSerializeImageSerializeImageserialize_image (Operator)

serialize_imageT_serialize_imageSerializeImageSerializeImageserialize_image — Serialize an image object.

Signature

serialize_image(Image : : : SerializedItemHandle)

Herror T_serialize_image(const Hobject Image, Htuple* SerializedItemHandle)

void SerializeImage(const HObject& Image, HTuple* SerializedItemHandle)

HSerializedItem HImage::SerializeImage() const

static void HOperatorSet.SerializeImage(HObject image, out HTuple serializedItemHandle)

HSerializedItem HImage.SerializeImage()

def serialize_image(image: HObject) -> HHandle

Description

serialize_imageserialize_imageSerializeImageSerializeImageserialize_image serializes an image object (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item 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 SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_imagedeserialize_imageDeserializeImageDeserializeImagedeserialize_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

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

Image object.

SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_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_imageSerializeImageSerializeImageserialize_image returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.

Possible Predecessors

read_imageread_imageReadImageReadImageread_image

Possible Successors

fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item, send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemsend_serialized_item, deserialize_imagedeserialize_imageDeserializeImageDeserializeImagedeserialize_image

Module

Foundation

ClassesClasses | | Operators