Skip to content

read_objectReadObjectReadObjectread_objectread_object🔗

Short description🔗

read_objectReadObjectReadObjectread_objectread_object — Read an iconic object.

Signature🔗

read_object( out object Object, filename FileName )void ReadObject( HObject* Object, const HTuple& FileName )static void HOperatorSet.ReadObject( out HObject objectVal, HTuple fileName )def read_object( file_name: str ) -> HObject

Herror read_object( Hobject* Object, const char* FileName )

Herror T_read_object( Hobject* Object, const Htuple FileName )

void HObject::ReadObject( const HString& FileName )

void HObject::ReadObject( const char* FileName )

void HObject::ReadObject( const wchar_t* FileName ) (Windows only)

void HObject.ReadObject( string fileName )

Description🔗

read_objectReadObject reads an iconic object from the file FileNamefileNamefile_name. The file must be written in the HALCON Iconic Object format (HOBJ), which is supported by the operators write_objectWriteObject, write_imageWriteImage, and write_regionWriteRegion. See write_objectWriteObject for more information about the HOBJ format.

Execution information🔗

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🔗

ObjectobjectValobject (output_object) object(-array) → objectHObjectHObjectHObjectHobject *

Iconic object.

FileNamefileNamefile_name (input_control) filename → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of file.

File extension: .hobj

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

write_imageWriteImage, write_objectWriteObject

See also

write_objectWriteObject, write_imageWriteImage, read_imageReadImage

Module🔗

Foundation