Operator Reference
serialize_region (Operator)
serialize_region — Serialize a region.
Signature
serialize_region(Region : : : SerializedItemHandle)
Description
serialize_region serializes a region (see
fwrite_serialized_item for an introduction of the basic
principle of serialization). The region is defined by the parameter
Region. The serialized region is returned by the handle
SerializedItemHandle and can be deserialized by
deserialize_region.
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
Region (input_object) region(-array) → object
Region.
SerializedItemHandle (output_control) serialized_item → (handle)
Handle of the serialized item.
Result
If the parameters are valid, the operator
serialize_region returns the value 2 (
H_MSG_TRUE)
. If
necessary, an exception is raised.
Possible Predecessors
read_image,
read_region,
threshold,
regiongrowing
Possible Successors
fwrite_serialized_item,
send_serialized_item,
deserialize_region
See also
Module
Foundation