foxglove.CircleAnnotation

A circle annotation on a 2D image

RoboticsObservabilityVisualizationData PlatformPhysical AIAutonomyFleet ManagementDeveloper ToolsMCAPROS

Properties

Name	Type	Description
timestamp	object	Timestamp of circle
position	object	Center of the circle in 2D image coordinates (pixels). The coordinate uses the top-left corner of the top-left pixel of the image as the origin.
diameter	number	Circle diameter in pixels
thickness	number	Line thickness in pixels
fill_color	object	Fill color
outline_color	object	Outline color
metadata	array	Additional user-provided metadata associated with this annotation. Keys must be unique.

View JSON Schema on GitHub

JSON Schema

{
  "title": "foxglove.CircleAnnotation",
  "description": "A circle annotation on a 2D image",
  "$comment": "Generated by https://github.com/foxglove/foxglove-sdk",
  "type": "object",
  "properties": {
    "timestamp": {
      "type": "object",
      "title": "time",
      "properties": {
        "sec": {
          "type": "integer",
          "minimum": 0
        },
        "nsec": {
          "type": "integer",
          "minimum": 0,
          "maximum": 999999999
        }
      },
      "description": "Timestamp of circle"
    },
    "position": {
      "title": "foxglove.Point2",
      "description": "Center of the circle in 2D image coordinates (pixels).\nThe coordinate uses the top-left corner of the top-left pixel of the image as the origin.",
      "type": "object",
      "properties": {
        "x": {
          "type": "number",
          "description": "x coordinate position"
        },
        "y": {
          "type": "number",
          "description": "y coordinate position"
        }
      },
      "required": [
        "x",
        "y"
      ]
    },
    "diameter": {
      "type": "number",
      "description": "Circle diameter in pixels"
    },
    "thickness": {
      "type": "number",
      "description": "Line thickness in pixels"
    },
    "fill_color": {
      "title": "foxglove.Color",
      "description": "Fill color",
      "type": "object",
      "properties": {
        "r": {
          "type": "number",
          "description": "Red value between 0 and 1"
        },
        "g": {
          "type": "number",
          "description": "Green value between 0 and 1"
        },
        "b": {
          "type": "number",
          "description": "Blue value between 0 and 1"
        },
        "a": {
          "type": "number",
          "description": "Alpha value between 0 and 1"
        }
      },
      "required": [
        "r",
        "g",
        "b",
        "a"
      ]
    },
    "outline_color": {
      "title": "foxglove.Color",
      "description": "Outline color",
      "type": "object",
      "properties": {
        "r": {
          "type": "number",
          "description": "Red value between 0 and 1"
        },
        "g": {
          "type": "number",
          "description": "Green value between 0 and 1"
        },
        "b": {
          "type": "number",
          "description": "Blue value between 0 and 1"
        },
        "a": {
          "type": "number",
          "description": "Alpha value between 0 and 1"
        }
      },
      "required": [
        "r",
        "g",
        "b",
        "a"
      ]
    },
    "metadata": {
      "type": "array",
      "items": {
        "title": "foxglove.KeyValuePair",
        "description": "A key with its associated value",
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "Key"
          },
          "value": {
            "type": "string",
            "description": "Value"
          }
        },
        "required": [
          "key",
          "value"
        ]
      },
      "description": "Additional user-provided metadata associated with this annotation. Keys must be unique."
    }
  },
  "required": [
    "timestamp",
    "position",
    "diameter",
    "thickness",
    "fill_color",
    "outline_color"
  ]
}