Skip to main content
Version: 3.5.0

Tagging

note

This resource allows user to tag a specific object to differentiate it from other objects.

PUT​

/internal/commands/object-tag​

  • Tag an object with a specific ID based on its object_id or Geomerty (position, bounding box)
  • This request can only be handled in Runtime-setup mode

Note: the object ID may not be reliable if tracking is not stable for some reason (e.g., lack of coverage or a complex interaction between objects.) Tagging by geometry can be applied instead. With the expected position, dimensions, and yaw, it tags the most similar object to the given.

  • Parameters
    • (optional) object_id: Used for querying an object based on its object_id
    • (optional) position : Used for querying an object in place of object_id
    • (optional) dimension : Desired object dimensions; also used for object query
    • (optional) yaw : Desired object heading; also used for object query
    • (optional) class : Desired object type
    • (optional) stage : Current stage
  • Return code
    • 200 OK
    • 400 BAD REQ

  • Example

# tagging by ID
curl --command PUT "http://localhost:9080/internal/commands/object-tag?tag=13&object_id=373"\
     --header "Content-Type: application/json"\
     --data '{"dimensions": [4.9, 2.2, 1.5], "yaw": 1.57, "class": 1, "stage": 0}'

# tagging by bounding box
curl --command PUT "http://localhost:9080/internal/commands/object-tag?tag=21"\
     --header "Content-Type: application/json"\
     --data '{"position": [10.0, -15.0, 0.0], "dimensions": [4.9, 2.2, 1.5], "yaw": -0.4, "class": 1, "stage": 0}'

POST​

/internal/commands/object-tag​

  • Update a tagged object tag ID.

  • Parameters
    • (mandatory) tag: Current tag of the object
    • (optional) dimension : Desired object dimensions; also used for object query
    • (optional) yaw : Desired object heading; also used for object query
    • (optional) class : Desired object type
    • (optional) stage : Current stage
  • Return code
    • 200 OK
    • 400 BAD REQ

  • Example

curl --command POST "http://localhost:9080/internal/commands/object-tag?tag=13"\
     --header "Content-Type: application/json"\
     --data '{"dimensions": [4.9, 2.2, 1.5], "yaw": 1.57, "stage": 1}'

Logo
If you need access, please contact