RecAPI
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Modules Pages
_ZONE Struct Reference

ZONE structure. More...

#include <KernelApi.h>

Public Attributes

RECT rectBBox
 
ZONETYPE type
 
DWORD userdata
 
DWORD chk_control
 
FILLINGMETHOD fm
 
RECOGNITIONMODULE rm
 
CHR_FILTER filter
 
LPCHECKWORD_CB chk_fn
 
char chk_sect [MAXSECTNAMELEN]
 

Detailed Description

ZONE structure.

The ZONE structure contains all the necessary information for describing a zone. A zone is a rectangular or pizza-box shaped area on an image (Only OMR zones can be non-pizza-box shaped; and table zones and vertical text zones must be rectangular), but ZONE contains only its bounding box. It contains a feature of interest to the user. The image data covered by each zone is handled and processed (typically recognized) separately. A very first classification of the zones is their type: whether a zone's area is to be recognized or it should be treated as graphic. Zones containing textual information can be either flowed type or table type zones. This basic classification of zones helps the Engine to handle the textual information correctly. Zones are always associated with a FILLINGMETHOD filling method and one of the available RECOGNITIONMODULE recognition modules. These determine what kind of recognition algorithm is applied to the zone during its processing. For possible RM-FM pairs see Filling method - Recognition module combinations.

Note
Zones in a page are built into a sequential list, called the zone list. Each zone receives an internal index number, reflecting its position in this list. In some cases this zone order even determines the zone content order in the final output document. The index of the first zone in the zone list is zero (0).
It is recommended to create homogeneous user zones as much as possible, because they may give better results. It is especially important in the case of Asian languages. WT_AUTO zones can be inhomogeneous.

Member Data Documentation

◆ chk_control

DWORD _ZONE::chk_control

Checking control bit mask flag. It controls how the checking module checks the recognized result for the zone.

◆ chk_fn

LPCHECKWORD_CB _ZONE::chk_fn

Deprecated. Set it to NULL.

◆ chk_sect

char _ZONE::chk_sect[MAXSECTNAMELEN]

Deprecated. Set it to an empty string.

◆ filter

CHR_FILTER _ZONE::filter

Character Set filter for the zone (CHR_FILTER). It is used to modify the set of valid characters for recognition of the zone. Specifying the Character Set correctly is a recognition accuracy issue.

◆ fm

FILLINGMETHOD _ZONE::fm

Zone filling method (FILLINGMETHOD).

◆ rectBBox

RECT _ZONE::rectBBox

Bounding box of the rects. To obtain the exact layout of the zone call kRecGetZoneLayout or kRecGetOCRZoneLayout.

◆ rm

RECOGNITIONMODULE _ZONE::rm

Recognition module associated with the zone (RECOGNITIONMODULE).

◆ type

ZONETYPE _ZONE::type

Zone type.

◆ userdata

DWORD _ZONE::userdata

User-defined content. This field can be freely used by the application for storing zone-specific information. Additional user-defined zone attributes can be set by kRecSetZoneAttribute.