Operator Reference
read_object (Operator)
read_object
— Read an iconic object.
Signature
Description
read_object
reads an iconic object from the file FileName
.
The file must be written in the HALCON Iconic Object format (HOBJ),
which is supported by the operators write_object
,
write_image
, and write_region
. See write_object
for more information about the HOBJ format.
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
Object
(output_object) object(-array) →
object
Iconic object.
FileName
(input_control) filename →
(string)
Name of file.
File extension:
.hobj
Result
If the parameters are valid, the operator
read_object
returns the value 2 (
H_MSG_TRUE)
. If
necessary, an exception is raised.
Possible Predecessors
See also
write_object
,
write_image
,
read_image
Module
Foundation