read_objectread_objectReadObjectReadObjectread_object (Operator)

Name

read_objectread_objectReadObjectReadObjectread_object — Read an iconic object.

Signature

read_object( : Object : FileName : )

Description

read_objectread_objectReadObjectReadObjectReadObjectread_object reads an iconic object from the file FileNameFileNameFileNameFileNamefileNamefile_name. The file must be written in the HALCON Iconic Object format (HOBJ), which is supported by the operators write_objectwrite_objectWriteObjectWriteObjectWriteObjectwrite_object, write_imagewrite_imageWriteImageWriteImageWriteImagewrite_image, and write_regionwrite_regionWriteRegionWriteRegionWriteRegionwrite_region. See write_objectwrite_objectWriteObjectWriteObjectWriteObjectwrite_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

ObjectObjectObjectObjectobjectValobject (output_object) object(-array) → object

Iconic object.

FileNameFileNameFileNameFileNamefileNamefile_name (input_control) filename → (string)

Name of file.

File extension: .hobj

Result

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

Possible Predecessors

write_imagewrite_imageWriteImageWriteImageWriteImagewrite_image, write_objectwrite_objectWriteObjectWriteObjectWriteObjectwrite_object

Module

Foundation

Operators