Get calibration configuration

GET

https://ai.nvidia.com/api/v3.3/analytics/config/calibration

GET

/api/v3.3/analytics/config/calibration

curl https://ai.nvidia.com/api/v3.3/analytics/config/calibration

{
  "version": "v1",
  "osmURL": "URL",
  "calibrationType": "cartesian",
  "sensors": [
    {
      "type": "camera",
      "id": "cam1",
      "origin": {
        "lat": 0,
        "lng": 0
      },
      "geoLocation": {
        "lat": 0,
        "lng": 0
      },
      "coordinates": {
        "x": 1,
        "y": 1,
        "z": 1
      },
      "scaleFactor": 1,
      "attributes": [
        {
          "name": "source",
          "value": "vst"
        }
      ],
      "place": [
        {
          "name": "building",
          "value": "warehouse"
        }
      ],
      "imageCoordinates": [
        {
          "x": 1,
          "y": 1
        }
      ],
      "globalCoordinates": [
        {
          "x": 1,
          "y": 1,
          "z": 1
        }
      ],
      "translationToGlobalCoordinates": {
        "x": 1,
        "y": 1,
        "z": 1
      },
      "group": {
        "name": "bev-sensor-1",
        "type": "bev",
        "origin": [
          1
        ],
        "dimensions": [
          1
        ],
        "alias": "area-1"
      },
      "region": {
        "placeLevel": "building",
        "origin": [
          1
        ],
        "dimensions": {
          "length": 1,
          "width": 1
        }
      },
      "intrinsicMatrix": [
        [
          2
        ]
      ],
      "extrinsicMatrix": [
        [
          3
        ]
      ],
      "cameraMatrix": [
        [
          4
        ]
      ],
      "homography": [
        [
          5
        ]
      ],
      "rois": [
        {
          "id": "buffer_zone_1",
          "roiCoordinates": [
            {
              "x": 1,
              "y": 1,
              "z": 0
            }
          ],
          "type": "buffer_zone",
          "restrictedObjectTypes": [
            "Person"
          ],
          "confinedObjectTypes": [
            "Fourier_GR1_T2_Humanoid"
          ]
        }
      ],
      "tripwires": [
        {
          "id": "tripwire-id-1",
          "wire": {
            "p1": {
              "x": 1,
              "y": 1
            },
            "p2": {
              "x": 1,
              "y": 1
            }
          },
          "direction": {
            "p1": {
              "x": 1,
              "y": 1
            },
            "p2": {
              "x": 1,
              "y": 1
            }
          }
        }
      ]
    }
  ],
  "rois": [
    {
      "id": "buffer_zone_1",
      "roiCoordinates": [
        {
          "x": 1,
          "y": 1,
          "z": 0
        }
      ],
      "sensors": [
        "cam1"
      ],
      "groups": [
        "bev-sensor-1"
      ],
      "type": "buffer_zone",
      "restrictedObjectTypes": [
        "Person"
      ],
      "confinedObjectTypes": [
        "Fourier_GR1_T2_Humanoid"
      ]
    }
  ],
  "tripwires": [
    {
      "id": "tripwire-id-1",
      "wire": {
        "p1": {
          "x": 1,
          "y": 1
        },
        "p2": {
          "x": 1,
          "y": 1
        }
      },
      "direction": {
        "p1": {
          "x": 1,
          "y": 1
        },
        "p2": {
          "x": 1,
          "y": 1
        }
      },
      "sensors": [
        "cam1"
      ],
      "groups": [
        "bev-sensor-1"
      ]
    }
  ],
  "corridors": [
    {
      "name": "city=abc/corridor=xyz",
      "sensors": [
        "cam1"
      ],
      "directions": [
        "N"
      ],
      "length": 5
    }
  ]
}

Retrieve calibration configuration from the database, optionally for a specific sensor or as an empty result when no configuration is found.

Query parameters

sensorIdstringOptionalformat: "^.{0,10000}$"<=10000 characters

emptyIfNotFoundbooleanOptionalDefaults to true

If set to true, empty calibration will be returned when calibration config is not found.

Response headers

Access-Control-Allow-OriginstringOptionalformat: "^.{0,10000}$"<=10000 characters

CORS header to allow cross-origin requests.

X-RateLimit-LimitintegerOptional

The maximum number of requests allowed in the current time period.

X-RateLimit-RemainingintegerOptional

The number of requests remaining in the current time period.

X-RateLimit-ResetintegerOptional

The time when the rate limit will be reset (Unix timestamp).

Response

Successful Operation.

versionstringformat: "^.{1,10000}$"1-10000 characters

osmURLstringformat: "^.{0,10000}$"0-10000 characters

calibrationTypeenum

Allowed values:

sensorslist of objects

typestringformat: "^.{1,10000}$"1-10000 characters

idstringformat: "^.{1,10000}$"1-10000 characters

originobject

geoLocationobject

coordinatesobject

scaleFactordouble

attributeslist of objects

placelist of objects

imageCoordinateslist of objects

globalCoordinateslist of objects

translationToGlobalCoordinatesobjectOptional

groupobjectOptional

regionobjectOptional

intrinsicMatrixlist of lists of doublesOptional

extrinsicMatrixlist of lists of doublesOptional

cameraMatrixlist of lists of doublesOptional

homographylist of lists of doublesOptional

roislist of objectsOptional

tripwireslist of objectsOptional

roislist of objectsOptional

idstring1-10000 characters

roiCoordinateslist of objects

sensorslist of strings

groupslist of strings

typestringOptionalformat: "^.{0,10000}$"0-10000 characters

restrictedObjectTypeslist of stringsOptional

confinedObjectTypeslist of stringsOptional

tripwireslist of objectsOptional

idstringformat: "^.{1,10000}$"1-10000 characters

wireobject

directionobject

sensorslist of strings

groupslist of strings

corridorslist of objectsOptional

namestringformat: "^.{1,10000}$"1-10000 characters

sensorslist of strings

directionslist of strings

lengthdouble0-99999999

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error