Documentation
Table of contents

ReferenceObjectFilter

Parameter ReferenceObjectFilter is a group of filter conditions for figuring out the reference objects.

"ReferenceObjectFilter" :
{
    "ReferenceTargetROIDefNameArray": ["TR_0", "TR_1"],
    "AtomicResultTypeArray" : ["ART_TEXT_LINE","ART_BARCODE","ART_FRAME","ART_TABLE_CELL"],
    "BarcodeFilteringCondition": 
    {
        "BarcodeFormatIds": ["BF_CODE39"], 
        "BarcodeTextRegExPattern": ".*b.*b.*b.*", 
        "RegionState": "default", 
    },
    "FrameFilteringCondition": 
    {
        "ImageDimensionRange": [16384,0x7fffffff],
        "AspectRatioRange": [1, 10000],
        "WidthRange": [1, 0x7fffffff],
        "HeightRange": [1, 0x7fffffff],
        "RegionState": "default",
    },
    "TextLineFilteringCondition":
    {
        "LineNumbers": "1,3-5",
        "LineStringRegExPattern": "Sodium[(\w| )]*",
        "RegionState": "default", 
    }
}

ReferenceTargetROIDefNameArray

Filter the reference object by specifying TargetROI names.

ReferenceTargetROIDefNameArray Parameter Summary
Type
String[]
Range
Each member should be a name of TargetROI that defined in TargetROIDefOptions.
Default Value
null

AtomicResultTypeArray

Filter the reference object by specifying the type of atomic results. In the TargetROIs algorithm task can produce atomic results that can support the localization of the other TargetROIs.

AtomicResultTypeArray Parameter Summary
Type
String[]
Range
Each member should be one of the AtomicResultType, which are ART_TEXT_LINE, ART_BARCODE, ART_FRAME, ART_TABLE_CELL, ART_GEOMETRY_LINE, ART_CORNER and ART_COLOUR_REGION
Default Value
[“ART_TEXT_LINE”,”ART_BARCODE”,”ART_FRAME”]

BarcodeFilteringCondition

One of the filter conditions. Filter the reference objects with the decoded barcode information. The parameter BarcodeFilteringCondition includes the following child parameters:

Child Parameter Name Child Parameter Summary
BarcodeFormatIds Description
Filter the reference objects by the barcode formats.
Type
String[]
Range
Each member of the array should be one of the BarcodeFormatIds as a string.
Default Value
BarcodeTextRegExPattern Description
Filter the reference objects by the barcode text with a RegEx string.
Type
String
Default Value
""

FrameFilteringCondition

One of the filter conditions. Filter the reference objects with the frame information. The parameter FrameFilteringCondition includes the following child parameters:

Child Parameter Name Child Parameter Summary
ImageDimensionRange Description
Filter the reference objects by the dimension of their original images.
Type
int[2]
Default Value
[16384,0x7fffffff]
AspectRatioRange Description
Filter the reference objects by the aspect ratio of their original images.

Aspect Ratio = BoundingRectHeight/BoundingRectWidth * 100

[MinAspectRatio, MaxAspectRatio]
Type
int[2]
Default Value
[1, 10000]
WidthRange Description
Filter the reference objects by the width of their original images.
Type
int[2]
Default Value
[1, 0x7fffffff]
HeightRange Description
Filter the reference objects by the height of their original images.
Type
int[2]
Default Value
[1, 0x7fffffff]

TextLineFilteringCondition

One of the filter conditions. Filter the reference objects with the text line content. The parameter TextLineFilteringCondition includes the following child parameters:

Child Parameter Name Child Parameter Summary
LineNumbers Description
Filter the reference objects by the line numbers.
Type
String
Range
A string of one or more of the following data, separated by commas:
1. One int value which represents a specified line index;
2. One Expression, start index and stop index connected with ""-"", which represents a specified line index range.
Default Value
""
Remarks
(1) The value is 1-based.
(2) "" represents all lines.
(3) The processed of the not specified text lines will implement the default settings.
(4) If the line number you specified doesn't exist, the library will ignore it.
LineStringRegExPattern Description
Filter the reference objects by the content of the text line with a RegEx string.
Type
String
Default Value
""

This page is compatible for:

Version 1.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest version
    • Version 2.x
      • Version 2.2.20
      • Version 2.2.10
      • Version 2.2.0
      • Version 2.0.30
      • Version 2.0.20
      • Version 2.0.10
      • Version 2.0.0
    Change +
    © 2003–2024 Dynamsoft. All rights reserved.
    Privacy Statement / Site Map / Home / Purchase / Support