Operator Reference

read_objectread_objectReadObjectReadObjectread_object (Operator)

read_objectread_objectReadObjectReadObjectread_object — Read an iconic object.

Signature

read_object( : Object : FileName : )

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

Herror T_read_object(Hobject* Object, const Htuple FileName)

void ReadObject(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)

static void HOperatorSet.ReadObject(out HObject objectVal, HTuple fileName)

void HObject.ReadObject(string fileName)

def read_object(file_name: str) -> HObject

Description

read_objectread_objectReadObjectReadObjectread_object reads an iconic object from the file FileNameFileNameFileNamefileNamefile_name. The file must be written in the HALCON Iconic Object format (HOBJ), which is supported by the operators write_objectwrite_objectWriteObjectWriteObjectwrite_object, write_imagewrite_imageWriteImageWriteImagewrite_image, and write_regionwrite_regionWriteRegionWriteRegionwrite_region. See write_objectwrite_objectWriteObjectWriteObjectwrite_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

ObjectObjectObjectobjectValobject (output_object)  object(-array) objectHObjectHObjectHObjectHobject *

Iconic object.

FileNameFileNameFileNamefileNamefile_name (input_control)  filename HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of file.

File extension: .hobj

Result

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

Possible Predecessors

write_imagewrite_imageWriteImageWriteImagewrite_image, write_objectwrite_objectWriteObjectWriteObjectwrite_object

See also

write_objectwrite_objectWriteObjectWriteObjectwrite_object, write_imagewrite_imageWriteImageWriteImagewrite_image, read_imageread_imageReadImageReadImageread_image

Module

Foundation