pat_RegisterZones

Registers and adjusts the positions of all fields on the current source page, based on the positions of the page's designated Anchor field(s).

Member of namespace

PatternMatch

Syntax

bool pat_RegisterZones ()

Parameters

None.

Returns

True if the ruleset with this action is bound to a Page object of the Document Hierarchy, and if the action can find all designated Anchor fields. Otherwise, False.

Level

Page only.

Details

pat_RegisterZones registers and adjusts the positions of all fields on the current page, based on the previously matched positions of the page's designated Anchor field(s). Anchor fields are determined by the Anchor Field setting in Datacap Studio, for each field. Prior to calling pat_RegisterZones, usually in a different task or ruleset, one of the PatternMatch actions that performs Anchor matching must be called. Then, when the pat_RegisterZones action is called, the expected positions of the Anchor fields on the image (taking into account the Fingerprint classification) are compared with the recognized positions of the fields identified as an Anchor field. The action ReadZones must be called prior to pat_RegisterZones. If any required Anchors are not matched, an operator may be required to update the Anchor position in a verify or fixup task.

All matched or manually adjusted Anchor positions are used for adjustment, Anchors that are not matched are ignored.

If one Anchor is found, the field positions are all shifted by the same amount.
If two or more Anchors are found, the field positions are shifted by different amounts, depending on their distance from each Anchor. This process is called Interpolation.

The expected positions of the Anchor fields on the image (taking into account the Fingerprint classification) are compared with the recognized positions of those Anchor fields - or the Anchor positions set manually by a Fixup task's operator.

Example

ReadZones()
pat_RegisterZones()
PrecognizePageFieldsOCR_S()