Operator Reference

HALCON Operator Reference / File / Region
ClassesClasses | | Operators

write_regionwrite_regionWriteRegionWriteRegionwrite_region (Operator)

write_regionwrite_regionWriteRegionWriteRegionwrite_region — Write regions to a file.

Signature

write_region(Region : : FileName : )

Herror write_region(const Hobject Region, const char* FileName)

Herror T_write_region(const Hobject Region, const Htuple FileName)

void WriteRegion(const HObject& Region, const HTuple& FileName)

void HRegion::WriteRegion(const HString& FileName) const

void HRegion::WriteRegion(const char* FileName) const

void HRegion::WriteRegion(const wchar_t* FileName) const   ( Windows only)

static void HOperatorSet.WriteRegion(HObject region, HTuple fileName)

void HRegion.WriteRegion(string fileName)

def write_region(region: HObject, file_name: str) -> None

Description

The operator write_regionwrite_regionWriteRegionWriteRegionwrite_region writes the regions in RegionRegionRegionregionregion into a binary file. The regions can be written in the HALCON Iconic Object format (HOBJ), as TIFF files or as HALCON region files. The format is selected via the file name extension of FileNameFileNameFileNamefileNamefile_name. If no extension is specified or if the file extension is '.hobj', the regions are stored in the HOBJ format. If no extension is specified in FileNameFileNameFileNamefileNamefile_name, the extension '.hobj' will be appended. See write_objectwrite_objectWriteObjectWriteObjectwrite_object for more information about the HOBJ format. If the extension '.tif' or '.tiff' is specified, the regions are stored as TIFF files. If the extension '.reg' is specified, the regions are stored as a HALCON region file. The HALCON region file format is now legacy and the file format HOBJ should be used instead unless the files must be readable with HALCON versions older than 12.0. Iconic object tuples with an arbitrary number of regions can be written. The output data can be read via the operator read_regionread_regionReadRegionReadRegionread_region.

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

RegionRegionRegionregionregion (input_object)  region(-array) → objectHRegionHObjectHObjectHobject

Region of the images which are returned.

FileNameFileNameFileNamefileNamefile_name (input_control)  filename.write → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of region file.

Default: 'region.hobj' "region.hobj" "region.hobj" "region.hobj" "region.hobj"

File extension: .hobj, .reg, .tif, .tiff

Example (HDevelop)

regiongrowing(Img,Segments,3,3,5,10)
write_region(Segments,'result1')

Example (C)

regiongrowing(Img,&Segments,3,3,5,10);
write_region(Segments,"result1");

Example (HDevelop)

regiongrowing(Img,Segments,3,3,5,10)
write_region(Segments,'result1')

Example (HDevelop)

regiongrowing(Img,Segments,3,3,5,10)
write_region(Segments,'result1')

Result

If the parameter values are correct the operator write_regionwrite_regionWriteRegionWriteRegionwrite_region returns the value 2 ( H_MSG_TRUE) . Otherwise an exception handling is raised.

Possible Predecessors

read_imageread_imageReadImageReadImageread_image, read_regionread_regionReadRegionReadRegionread_region, read_objectread_objectReadObjectReadObjectread_object, thresholdthresholdThresholdThresholdthreshold, regiongrowingregiongrowingRegiongrowingRegiongrowingregiongrowing

See also

read_regionread_regionReadRegionReadRegionread_region

Module

Foundation

ClassesClasses | | Operators