Region Definition

Defines a rectangular region for zonal extraction operations.

Remarks

Defines a region (zone) on one or more document pages for extracting data from a specific area.

Use this as a base for custom region types in Grooper. Regions are typically used to extract fields, tables, or other structured content from forms and documents where the location of the data is known or predictable.

How It Works

• The region is defined as a rectangle, and can be configured to apply to specific pages using the 'Page Filter' property.
• Optionally, the region can be automatically aligned to nearby lines on the page using the 'Auto Snap' property.
• Derived types must implement the logic for generating the actual page regions.

Usage Guidance

• Use region definitions to target specific areas of a document for extraction, especially when working with structured forms or tables.
• Combine with Line Snap Options for improved accuracy on documents with printed lines.
• Configure the 'Page Filter' to restrict the region to certain pages, or leave blank to apply to all pages.

Properties

Name	Type		Description
Page Filter	String	►	The page or pages to which the region applies. ConverterPage Filter Converter Specifies which pages the region should be applied to. Accepts a single page number (e.g. 1), a range (e.g. 1-3), or a comma-separated list (e.g. 1,3,5). If left blank, the region applies to all pages. This is useful for forms where the target area only appears on certain pages, or for multi-page documents where zones are needed in different locations on different pages.
Auto Snap	Line Snap Options	►	Enables or disables automatic snapping to nearby lines. ConverterOn Off Converter Can be one of the following types: Value Description Enabled Disabled When enabled, the region's edges are automatically adjusted to align with the nearest detected horizontal or vertical lines on the page. This is especially useful for extracting data from structured documents such as forms or tables, where precise alignment with printed lines improves accuracy. > Note: This feature depends on Layout Data generated by the Line Detection or Line Removal. > image processing commands. Ensure that input documents have been processed with these commands before enabling > Auto Snap, or snapping will have no effect. The Line Snap Options object provides additional configuration for snap distance, margin, and which edges to snap.

Derived Types

There are 4 implementations of Region Definition.

Fixed Region	Defines a fixed rectangular region.
Relative Region	Defines a rectangular region which is positioned relative to an anchor on the document.
Shape Region	Defines a region at or relative to the location where a shape has been detected.
Text Region	Defines a region based on the location of a text element.

See Also

Line Snap Options

Used By

Detect SignatureHighlight ZoneOrdered OMRRead Zone