read_regionread_regionReadRegionReadRegionread_region (Operator)
Name
read_regionread_regionReadRegionReadRegionread_region — Read binary images or HALCON regions.
Signature
Description
The operator read_regionread_regionReadRegionReadRegionReadRegionread_region reads regions from a binary file.
The following formats are currently supported:
- HALCON Iconic Object (HOBJ) (HALCON 12.0 or higher):
-
File format for iconic HALCON objects. The HOBJ file must contain
only regions to be readable by read_regionread_regionReadRegionReadRegionReadRegionread_region. If other
objects (e.g. images or XLDs) are stored in the file,
an exception is raised. In this case read_objectread_objectReadObjectReadObjectReadObjectread_object can
be used to read the corresponding HOBJ file.
The HOBJ format is the default file format for regions.
Therefore, the extension '.hobj'".hobj"".hobj"".hobj"".hobj"".hobj" does not have to
be specified when reading or writing the file. See
write_objectwrite_objectWriteObjectWriteObjectWriteObjectwrite_object for more information about the HOBJ format.
- HALCON regions:
-
File format for HALCON regions.
This file format supports multiple regions in a single file.
The file extension is '.reg'".reg"".reg"".reg"".reg"".reg". This format is now legacy and the
HOBJ format should be used instead.
- Tiff:
-
Binary Tiff images with extension 'tiff'"tiff""tiff""tiff""tiff""tiff" or
'tif'"tif""tif""tif""tif""tif". A tiff image can contain any number of regions.
The color white is used as foreground.
- PNG:
-
Binary PNG images with extension 'png'"png""png""png""png""png". The result is
always one region. The color white is used as foreground.
- BMP:
-
Binary Windows bitmap images with extension 'bmp'"bmp""bmp""bmp""bmp""bmp".
The result is always one region. The color white is used as
foreground.
A search path ('image_dir'"image_dir""image_dir""image_dir""image_dir""image_dir") can be defined analogous
to the operator read_imageread_imageReadImageReadImageReadImageread_image.
Attention
The clipping based on the current image format is set via the
operator set_system('clip_region',<'true'/'false'>)set_system("clip_region",<"true"/"false">)SetSystem("clip_region",<"true"/"false">)SetSystem("clip_region",<"true"/"false">)SetSystem("clip_region",<"true"/"false">)set_system("clip_region",<"true"/"false">).
Consequently, if no image of sufficient size has been created before
the call to read_regionread_regionReadRegionReadRegionReadRegionread_region,
set_system('clip_region','false')set_system("clip_region","false")SetSystem("clip_region","false")SetSystem("clip_region","false")SetSystem("clip_region","false")set_system("clip_region","false") should be called before
calling read_regionread_regionReadRegionReadRegionReadRegionread_region to ensure that the region is not being
clipped.
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
RegionRegionRegionRegionregionregion (output_object) region(-array) → objectHRegionHObjectHRegionHobject *
Read region.
FileNameFileNameFileNameFileNamefileNamefile_name (input_control) filename.read → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the region to be read.
File extension: .hobj, .reg, .tif, .tiff, .png, .bmp
Example (HDevelop)
* Reading of regions and giving them gray values.
read_image(Img,'ima_test')
read_region(Regs,'reg_test')
reduce_domain(Img,Regs,Res)
Example (C)
/* Reading of regions and giving them gray values. */
read_image(&Img,"ima_test");
read_region(&Regs,"reg_test");
reduce_domain(Img,Regs,&Res);
Example (HDevelop)
* Reading of regions and giving them gray values.
read_image(Img,'ima_test')
read_region(Regs,'reg_test')
reduce_domain(Img,Regs,Res)
Example (HDevelop)
* Reading of regions and giving them gray values.
read_image(Img,'ima_test')
read_region(Regs,'reg_test')
reduce_domain(Img,Regs,Res)
Example (HDevelop)
* Reading of regions and giving them gray values.
read_image(Img,'ima_test')
read_region(Regs,'reg_test')
reduce_domain(Img,Regs,Res)
Result
If the parameter values are correct the operator read_regionread_regionReadRegionReadRegionReadRegionread_region
returns the value TRUE. Otherwise an exception is raised.
Possible Predecessors
read_imageread_imageReadImageReadImageReadImageread_image
Possible Successors
reduce_domainreduce_domainReduceDomainReduceDomainReduceDomainreduce_domain,
disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region
See also
write_regionwrite_regionWriteRegionWriteRegionWriteRegionwrite_region,
read_imageread_imageReadImageReadImageReadImageread_image,
write_objectwrite_objectWriteObjectWriteObjectWriteObjectwrite_object
Module
Foundation