serialize_regionT_serialize_regionSerializeRegionSerializeRegionserialize_region (Operator)

Name

serialize_regionT_serialize_regionSerializeRegionSerializeRegionserialize_region — Serialize a region.

Signature

serialize_region(Region : : : SerializedItemHandle)

Herror T_serialize_region(const Hobject Region, Htuple* SerializedItemHandle)

void SerializeRegion(const HObject& Region, HTuple* SerializedItemHandle)

HSerializedItem HRegion::SerializeRegion() const

static void HOperatorSet.SerializeRegion(HObject region, out HTuple serializedItemHandle)

HSerializedItem HRegion.SerializeRegion()

def serialize_region(region: HObject) -> HHandle

Description

serialize_regionserialize_regionSerializeRegionSerializeRegionSerializeRegionserialize_region serializes a region (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item for an introduction of the basic principle of serialization). The region is defined by the parameter RegionRegionRegionRegionregionregion. The serialized region is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by deserialize_regiondeserialize_regionDeserializeRegionDeserializeRegionDeserializeRegiondeserialize_region.

Execution Information

Parameters

RegionRegionRegionRegionregionregion (input_object)  region(-array) objectHRegionHObjectHRegionHobject

Region.

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window, read_imageread_imageReadImageReadImageReadImageread_image, read_regionread_regionReadRegionReadRegionReadRegionread_region, thresholdthresholdThresholdThresholdThresholdthreshold, regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowingregiongrowing

Possible Successors

fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item, send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemSendSerializedItemsend_serialized_item, deserialize_regiondeserialize_regionDeserializeRegionDeserializeRegionDeserializeRegiondeserialize_region

See also

deserialize_regiondeserialize_regionDeserializeRegionDeserializeRegionDeserializeRegiondeserialize_region

Module

Foundation