DLRReferenceRegion

Interface used to get or set (via the RuntimeSettings) the reference region used to identify the label.

Attributes

Attribute	Type
localizationSourceType	DLRLocalizationSourceType
points	Point[4]
regionMeasuredByPercentage	number
regionPredetectionModesIndex	number
barcodeFormatIds	number
barcodeFormatIds_2	number
barcodeTextRegExPattern	string

localizationSourceType

The source type used to localize the reference region(s).

Value Range

A value of DLRLocalizationSourceType Enumeration items.

Default value

DLR_LST_MANUAL_SPECIFICATION

points

Four vertices in a clockwise direction of a quadrilateral. Index 0 represents the left-most vertex.

Remarks

It works only when localizationSourceType is setting to DLR_LST_MANUAL_SPECIFICATION.
The library will localize reference region(s) based on the quadrilateral set by current setting.

regionMeasuredByPercentage

Whether or not to use percentage to measure the coordinate.

Value Range

[0, 1]

Default value

1

Remarks

It works only when localizationSourceType is setting to DLR_LST_MANUAL_SPECIFICATION.
0: not by percentage
1: by percentage
When it’s set to 1, the values of points indicate percentage (from 0 to 100); Otherwise, they indicate coordinates in pixel.

regionPredetectionModesIndex

The index of a specific region predetection mode in the regionPredetectionModes parameter.

Value Range

[-1, 0x7fffffff]

Default value

-1

Remarks

It works only when localizationSourceType is setting to DLR_LST_PREDETECTED_REGION.
The library will localize reference region(s) based on the detected regions from the specified region predetection mode.
-1: all region predetection modes in the regionPredetectionModes parameter

barcodeFormatIds

The formats of the barcode in BarcodeFormat group 1.

Value Range

A combined value of DLRBarcodeFormat Enumeration items

Default value

DLR_BF_ALL

Remarks

Barcode formats in DLRBarcodeFormat group 1 can be combined.
It works only when localizationSourceType is setting to DLR_LST_BARCODE.
The library will localize reference region(s) based on the barcodes whose format meets current setting.

barcodeFormatIds_2

The formats of the barcode in BarcodeFormat group 2.

Value Range

A combined value of DLRBarcodeFormat_2 Enumeration items

Default value

DLR_BF2_NULL

Remarks

Barcode formats in DLRBarcodeFormat group 2 can be combined.
It works only when localizationSourceType is setting to DLR_LST_BARCODE.
The library will localize reference region(s) based on the barcodes whose format meets current setting.

barcodeTextRegExPattern

The regular express pattern of barcode text.

Remarks

It works only when localizationSourceType is setting to DLR_LST_BARCODE.
The library will localize reference region(s) based on the barcodes whose text meets current setting.