write_objectwrite_objectWriteObjectWriteObjectwrite_object (Operator)


write_objectwrite_objectWriteObjectWriteObjectwrite_object — Write an iconic object.


write_object(Object : : FileName : )

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

Herror T_write_object(const Hobject Object, const Htuple FileName)

void WriteObject(const HObject& Object, const HTuple& FileName)

void HObject::WriteObject(const HString& FileName) const

void HObject::WriteObject(const char* FileName) const

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

static void HOperatorSet.WriteObject(HObject objectVal, HTuple fileName)

void HObject.WriteObject(string fileName)

def write_object(object: HObject, file_name: str) -> None


write_objectwrite_objectWriteObjectWriteObjectWriteObjectwrite_object writes the iconic ObjectObjectObjectObjectobjectValobject to the file FileNameFileNameFileNameFileNamefileNamefile_name. The iconic object is a (possibly mixed) tuple of images, regions, or XLDs. If no extension is specified in FileNameFileNameFileNameFileNamefileNamefile_name, the extension '.hobj'".hobj"".hobj"".hobj"".hobj"".hobj" will be appended. The iconic data is written in the HALCON Iconic Object format described below.

HALCON Iconic Object (HOBJ) (HALCON 12.0 or higher):

HOBJ is a binary file format, which provides the functionality to write and read all kinds of iconic HALCON objects (images, regions, and XLDs). Since data is written with neither compression nor conversion, writing this file format is faster than other supported file formats in most circumstances. Hence, if an application needs to read and write all kinds of iconic HALCON objects as fast as possible and no compression is required, this format should be used. The default file extension for this file format is '.hobj'".hobj"".hobj"".hobj"".hobj"".hobj". For images, all HALCON pixel types can be written. Multi-channel images are supported. The channels can have mixed pixel types but must have the same width and height. The domain of an image and it's creation date are stored in the file as well. An object tuple is written into a single file.

Execution Information


ObjectObjectObjectObjectobjectValobject (input_object)  object(-array) objectHObjectHObjectHObjectHobject

Iconic object.

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

Name of file.

File extension: .hobj


If the parameters are valid, the operator write_objectwrite_objectWriteObjectWriteObjectWriteObjectwrite_object returns the value TRUE. If necessary, an exception is raised.

Possible Successors

read_objectread_objectReadObjectReadObjectReadObjectread_object, read_imageread_imageReadImageReadImageReadImageread_image

See also

read_objectread_objectReadObjectReadObjectReadObjectread_object, write_imagewrite_imageWriteImageWriteImageWriteImagewrite_image, read_imageread_imageReadImageReadImageReadImageread_image, write_regionwrite_regionWriteRegionWriteRegionWriteRegionwrite_region, read_regionread_regionReadRegionReadRegionReadRegionread_region