Documentation
Table of contents

OutputTaskSetting Object

The OutputTaskSetting object is used to configure how to output the expected results of the ancestor TargetROIDef by filtering the results of the descendant TargetROIDef object.

{
    "Name" : "output_task",

    "OutputCondition": {
        "TaskResultArray": [
            {
                "TargetROIDefName": "B", 
                "TaskSettingNameArray": ["B_task"],
                "Operator": "AND",

                "BackwardReferenceOutput": {
                    "ReferenceTaskNameArray": ["A_task"], 
                    "ReferenceResultTypeArray":[ "ART_TEXT_LINE","ART_BARCODE","ART_FRAME", "ART_TABLE_CELL", "ART_COLOUR_REGION" ]
                }
            }
        ],
        "Operator": "AND"
    }
}

Example 1 – Parameters of OutputTaskSetting

Summary of OutputTaskSetting top-level parameters

Parameter Name Value Type Required or Optional Description
Name string Mandatory Sets the name of current OutputTaskSetting object. The value must be unique between all task-setting objects.
OutputCondition /capture-vision/docs/core/parameters/reference/output-task-setting/output-condition.html Optional Sets how the current OutputTaskSetting object outputs results that meet multiple filter conditions across products.

Design of the OutputCondition object

Concept Description
Reference TargetROIDef object Represents the TargetROIDef object where the output task is located. It may be the reference TargetROIDef of other descendant TargetROIDef objects.
Descendant TargetROIDef objects Represents descendant TargetROIDef objects. The task results of descendant TargetROIDef objects can be navigated to the task results of the reference TargetROIDef object through the reference item.

The following example shows how to set the OutputCondition object.

{
    ......
    "TargetROIDefOptions" : [
        {
            "Name" : "A_roi",  
            "TaskSettingNameArray": [
                "ddn_task",
                "output_task"
            ]
        },        
        {
            "Name" : "B_roi",  
            "TaskSettingNameArray": [
                "dbr_task"
            ], 
            "Location": 
            {
                "ReferenceObjectFilter" : {
                    "ReferenceTargetROIDefNameArray": ["A_roi"],
                    "ReferenceTaskNameArray": ["ddn_task"]
                }
            }
        },
        {
            "Name" : "C_roi",  
            "TaskSettingNameArray": [
                "dlr_task"
            ], 
            "Location": 
            {
                "ReferenceObjectFilter" : {
                    "ReferenceTargetROIDefNameArray": ["A_roi"],
                    "ReferenceTaskNameArray": ["ddn_task"]
                }
            }
        }
    ],
    "OutputTaskSettingOptions": [
        {
            "Name" : "output_task",
            "OutputCondition": {
                "TaskResultArray": [
                    {
                        "TargetROIDefName": "B_roi",
                        "BackwardReferenceOutput": {
                            "ReferenceTaskNameArray": ["ddn_task"]
                        }
                    },
                    {
                        "TargetROIDefName": "C_roi",
                        "BackwardReferenceOutput": {
                            "ReferenceTaskNameArray": ["ddn_task"]
                        }                        
                    }
                ],
                "Operator": "AND"
            }
        }
    ]
    ......
}

OutputTaskSetting example

There is a parent TargetROIDef object named A_roi which contains two tasks named ddn_task and output_task. There are two descendant TargetROIDef objects named B_roi and C_roi, and there is a task named dbr_task and dlr_task on each TargetROIDef respectively.

The output_task works as follows: After processing B_roi and C_roi, retrieve the task results from dbr_task and dlr_task, navigate to the reference result generated by ddn_task, and execute logical AND combinations to obtain the filtered results.

This page is compatible for:

Version 1.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest version (2.2.20)
    • Version 2.x
      • 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