Updated on 2024-02-29 GMT+08:00

Common Algorithm Parameters

target_roi

JSON structures are used to represent lines and polygons in the region of interest. The meanings of these lines and polygons depend on the services that use them.

  • target_roi parameters

    Parameter

    Mandatory

    Type

    Description

    lines

    No

    List<Object>

    A list of lines

    polygons

    No

    List<Object>

    A list of polygons

  • Object parameter structure in lines

    Parameter

    Mandatory

    Type

    Description

    data

    Yes

    List<Object>

    Sets of start and end points that form lines, for example, [[50,60],[1000,1000]]. The first point indicates the start point, and the second point end point.

    name

    No

    String

    Name of a line

    properties

    No

    Object

    Line properties

  • Object parameter structure in properties

    Parameter

    Mandatory

    Type

    Description

    side1_name

    No

    String

    side1_name and side2_name indicate the two sides of a straight line. For a non-horizontal line, the left side is side1, and for a horizontal line, the upper side is side1.

    side2_name

    No

    String

    side1_name and side2_name indicate the two sides of a straight line. For a non-horizontal line, the right side is side2, and for a horizontal line, the lower side is side2.

  • Object parameter structure in polygons

    Parameter

    Mandatory

    Type

    Description

    data

    Yes

    List<Object>

    A set of three or more points that form a polygon, for example, [[50,60],[1000,1000],[1000,2000][50,2000]]. The value has specified the sequence of the points in forming the polygon.

    name

    No

    String

    Name of a polygon

    properties

    No

    Object

    Properties of a polygon