update ImageAnnotation coordinate fields with comment specifying the …

…coordinate space
foxglove · May 23, 2024 · 1515b47 · 1515b47
1 parent a4b0b35
commit 1515b47
Show file tree

Hide file tree

Showing 32 changed files with 90 additions and 45 deletions.
diff --git a/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap b/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap
@@ -122,7 +122,10 @@ export type CircleAnnotation = {
   /** Timestamp of circle */
   timestamp: Time;
 
-  /** Center of the circle in 2D image coordinates (pixels) */
+  /**
+   * 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.
+   */
   position: Point2;
 
   /** Circle diameter in pixels */
@@ -708,7 +711,10 @@ export type PointsAnnotation = {
   /** Type of points annotation to draw */
   type: PointsAnnotationType;
 
-  /** Points in 2D image coordinates (pixels) */
+  /**
+   * Points in 2D image coordinates (pixels).
+   * These coordinates use the top-left corner of the top-left pixel of the image as the origin.
+   */
   points: Point2[];
 
   /** Outline color */
@@ -857,7 +863,10 @@ export type TextAnnotation = {
   /** Timestamp of annotation */
   timestamp: Time;
 
-  /** Bottom-left origin of the text label in 2D image coordinates (pixels) */
+  /**
+   * Bottom-left origin of the text label in 2D image coordinates (pixels).
+   * The coordinate uses the top-left corner of the top-left pixel of the image as the origin.
+   */
   position: Point2;
 
   /** Text to display */

diff --git a/internal/schemas.ts b/internal/schemas.ts
@@ -1085,7 +1085,8 @@ const CircleAnnotation: FoxgloveMessageSchema = {
     {
       name: "position",
       type: { type: "nested", schema: Point2 },
-      description: "Center of the circle in 2D image coordinates (pixels)",
+      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.",
     },
     {
       name: "diameter",
@@ -1147,7 +1148,8 @@ const PointsAnnotation: FoxgloveMessageSchema = {
     {
       name: "points",
       type: { type: "nested", schema: Point2 },
-      description: "Points in 2D image coordinates (pixels)",
+      description:
+        "Points in 2D image coordinates (pixels).\nThese coordinates use the top-left corner of the top-left pixel of the image as the origin.",
       array: true,
     },
     {
@@ -1188,7 +1190,8 @@ const TextAnnotation: FoxgloveMessageSchema = {
     {
       name: "position",
       type: { type: "nested", schema: Point2 },
-      description: "Bottom-left origin of the text label in 2D image coordinates (pixels)",
+      description:
+        "Bottom-left origin of the text label in 2D image coordinates (pixels).\nThe coordinate uses the top-left corner of the top-left pixel of the image as the origin.",
     },
     {
       name: "text",

diff --git a/ros_foxglove_msgs/ros1/CircleAnnotation.msg b/ros_foxglove_msgs/ros1/CircleAnnotation.msg
diff --git a/ros_foxglove_msgs/ros1/PointsAnnotation.msg b/ros_foxglove_msgs/ros1/PointsAnnotation.msg
diff --git a/ros_foxglove_msgs/ros1/TextAnnotation.msg b/ros_foxglove_msgs/ros1/TextAnnotation.msg
diff --git a/ros_foxglove_msgs/ros2/CircleAnnotation.msg b/ros_foxglove_msgs/ros2/CircleAnnotation.msg
diff --git a/ros_foxglove_msgs/ros2/PointsAnnotation.msg b/ros_foxglove_msgs/ros2/PointsAnnotation.msg
diff --git a/ros_foxglove_msgs/ros2/TextAnnotation.msg b/ros_foxglove_msgs/ros2/TextAnnotation.msg
diff --git a/schemas/README.md b/schemas/README.md
diff --git a/schemas/flatbuffer/CircleAnnotation.fbs b/schemas/flatbuffer/CircleAnnotation.fbs
diff --git a/schemas/flatbuffer/PointsAnnotation.fbs b/schemas/flatbuffer/PointsAnnotation.fbs
diff --git a/schemas/flatbuffer/TextAnnotation.fbs b/schemas/flatbuffer/TextAnnotation.fbs
diff --git a/schemas/jsonschema/CircleAnnotation.json b/schemas/jsonschema/CircleAnnotation.json
diff --git a/schemas/jsonschema/ImageAnnotations.json b/schemas/jsonschema/ImageAnnotations.json
diff --git a/schemas/jsonschema/PointsAnnotation.json b/schemas/jsonschema/PointsAnnotation.json
diff --git a/schemas/jsonschema/TextAnnotation.json b/schemas/jsonschema/TextAnnotation.json
diff --git a/schemas/jsonschema/index.ts b/schemas/jsonschema/index.ts
diff --git a/schemas/omgidl/foxglove/CircleAnnotation.idl b/schemas/omgidl/foxglove/CircleAnnotation.idl
diff --git a/schemas/omgidl/foxglove/PointsAnnotation.idl b/schemas/omgidl/foxglove/PointsAnnotation.idl
diff --git a/schemas/omgidl/foxglove/TextAnnotation.idl b/schemas/omgidl/foxglove/TextAnnotation.idl
diff --git a/schemas/proto/foxglove/CircleAnnotation.proto b/schemas/proto/foxglove/CircleAnnotation.proto
diff --git a/schemas/proto/foxglove/PointsAnnotation.proto b/schemas/proto/foxglove/PointsAnnotation.proto
diff --git a/schemas/proto/foxglove/TextAnnotation.proto b/schemas/proto/foxglove/TextAnnotation.proto
diff --git a/schemas/ros1/CircleAnnotation.msg b/schemas/ros1/CircleAnnotation.msg
diff --git a/schemas/ros1/PointsAnnotation.msg b/schemas/ros1/PointsAnnotation.msg
diff --git a/schemas/ros1/TextAnnotation.msg b/schemas/ros1/TextAnnotation.msg
diff --git a/schemas/ros2/CircleAnnotation.msg b/schemas/ros2/CircleAnnotation.msg