@foxglove/schemas 1.6.2 → 1.6.3

package/schemas/ros1/PointsAnnotation.msg

@@ -23,7 +23,8 @@ uint8 LINE_LIST=4
 # Type of points annotation to draw
 uint8 type
 
-# 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.
 foxglove_msgs/Point2[] points
 
 # Outline color

package/schemas/ros1/TextAnnotation.msg

@@ -6,7 +6,8 @@
 # Timestamp of annotation
 time timestamp
 
-# 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.
 foxglove_msgs/Point2 position
 
 # Text to display

package/schemas/ros2/CameraCalibration.msg

@@ -17,7 +17,7 @@ uint32 height
 
 # Name of distortion model
 # 
-# Supported values: `plumb_bob` and `rational_polynomial`
+# Supported parameters: `plumb_bob` (k1, k2, p1, p2, k3) and `rational_polynomial` (k1, k2, p1, p2, k3, k4, k5, k6). Distortion models are based on [OpenCV's](https://docs.opencv.org/2.4/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.html) [pinhole camera model](https://en.wikipedia.org/wiki/Distortion_%28optics%29#Software_correction). This is the same [implementation used by ROS](http://docs.ros.org/en/diamondback/api/image_geometry/html/c++/pinhole__camera__model_8cpp_source.html)
 string distortion_model
 
 # Distortion parameters

package/schemas/ros2/CircleAnnotation.msg

@@ -6,7 +6,8 @@
 # Timestamp of circle
 builtin_interfaces/Time timestamp
 
-# 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.
 foxglove_msgs/Point2 position
 
 # Circle diameter in pixels

package/schemas/ros2/CompressedVideo.msg

@@ -13,7 +13,7 @@ string frame_id
 
 # Compressed video frame data.
 # 
-# For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead.
+# For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead.
 uint8[] data
 
 # Video format.

package/schemas/ros2/PointsAnnotation.msg

@@ -23,7 +23,8 @@ uint8 LINE_LIST=4
 # Type of points annotation to draw
 uint8 type
 
-# 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.
 foxglove_msgs/Point2[] points
 
 # Outline color

package/schemas/ros2/TextAnnotation.msg

@@ -6,7 +6,8 @@
 # Timestamp of annotation
 builtin_interfaces/Time timestamp
 
-# 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.
 foxglove_msgs/Point2 position
 
 # Text to display

package/schemas/typescript/CameraCalibration.d.ts

@@ -12,7 +12,7 @@ export type CameraCalibration = {
     /**
      * Name of distortion model
      *
-     * Supported values: `plumb_bob` and `rational_polynomial`
+     * Supported parameters: `plumb_bob` (k1, k2, p1, p2, k3) and `rational_polynomial` (k1, k2, p1, p2, k3, k4, k5, k6). Distortion models are based on [OpenCV's](https://docs.opencv.org/2.4/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.html) [pinhole camera model](https://en.wikipedia.org/wiki/Distortion_%28optics%29#Software_correction). This is the same [implementation used by ROS](http://docs.ros.org/en/diamondback/api/image_geometry/html/c++/pinhole__camera__model_8cpp_source.html)
      */
     distortion_model: string;
     /** Distortion parameters */

package/schemas/typescript/CameraCalibration.ts

@@ -20,7 +20,7 @@ export type CameraCalibration = {
   /**
    * Name of distortion model
    * 
-   * Supported values: `plumb_bob` and `rational_polynomial`
+   * Supported parameters: `plumb_bob` (k1, k2, p1, p2, k3) and `rational_polynomial` (k1, k2, p1, p2, k3, k4, k5, k6). Distortion models are based on [OpenCV's](https://docs.opencv.org/2.4/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.html) [pinhole camera model](https://en.wikipedia.org/wiki/Distortion_%28optics%29#Software_correction). This is the same [implementation used by ROS](http://docs.ros.org/en/diamondback/api/image_geometry/html/c++/pinhole__camera__model_8cpp_source.html)
    */
   distortion_model: string;
 

package/schemas/typescript/CircleAnnotation.d.ts

@@ -5,7 +5,10 @@ import { Time } from "./Time";
 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 */
     diameter: number;

package/schemas/typescript/CircleAnnotation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CircleAnnotation.d.ts","sourceRoot":"","sources":["CircleAnnotation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,wCAAwC;AACxC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,0BAA0B;IAC1B,SAAS,EAAE,IAAI,CAAC;IAEhB,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,CAAC;IAEjB,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IAEjB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAElB,iBAAiB;IACjB,UAAU,EAAE,KAAK,CAAC;IAElB,oBAAoB;IACpB,aAAa,EAAE,KAAK,CAAC;CACtB,CAAC"}
+{"version":3,"file":"CircleAnnotation.d.ts","sourceRoot":"","sources":["CircleAnnotation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,wCAAwC;AACxC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,0BAA0B;IAC1B,SAAS,EAAE,IAAI,CAAC;IAEhB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IAEjB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAElB,iBAAiB;IACjB,UAAU,EAAE,KAAK,CAAC;IAElB,oBAAoB;IACpB,aAAa,EAAE,KAAK,CAAC;CACtB,CAAC"}

package/schemas/typescript/CircleAnnotation.ts

@@ -10,7 +10,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 */

package/schemas/typescript/CompressedVideo.d.ts

@@ -12,7 +12,7 @@ export type CompressedVideo = {
     /**
      * Compressed video frame data.
      *
-     * For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead.
+     * For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead.
      */
     data: Uint8Array;
     /**

package/schemas/typescript/CompressedVideo.ts

@@ -18,7 +18,7 @@ export type CompressedVideo = {
   /**
    * Compressed video frame data.
    * 
-   * For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove Studio does not support video streams that include B frames because they require lookahead.
+   * For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead.
    */
   data: Uint8Array;
 

package/schemas/typescript/PointsAnnotation.d.ts

@@ -8,7 +8,10 @@ export type PointsAnnotation = {
     timestamp: Time;
     /** 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 */
     outline_color: Color;

package/schemas/typescript/PointsAnnotation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PointsAnnotation.d.ts","sourceRoot":"","sources":["PointsAnnotation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,uCAAuC;AACvC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,8BAA8B;IAC9B,SAAS,EAAE,IAAI,CAAC;IAEhB,wCAAwC;IACxC,IAAI,EAAE,oBAAoB,CAAC;IAE3B,8CAA8C;IAC9C,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB,oBAAoB;IACpB,aAAa,EAAE,KAAK,CAAC;IAErB,oIAAoI;IACpI,cAAc,EAAE,KAAK,EAAE,CAAC;IAExB,iBAAiB;IACjB,UAAU,EAAE,KAAK,CAAC;IAElB,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"PointsAnnotation.d.ts","sourceRoot":"","sources":["PointsAnnotation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,uCAAuC;AACvC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,8BAA8B;IAC9B,SAAS,EAAE,IAAI,CAAC;IAEhB,wCAAwC;IACxC,IAAI,EAAE,oBAAoB,CAAC;IAE3B;;;OAGG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB,oBAAoB;IACpB,aAAa,EAAE,KAAK,CAAC;IAErB,oIAAoI;IACpI,cAAc,EAAE,KAAK,EAAE,CAAC;IAExB,iBAAiB;IACjB,UAAU,EAAE,KAAK,CAAC;IAElB,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/schemas/typescript/PointsAnnotation.ts

@@ -14,7 +14,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 */

package/schemas/typescript/TextAnnotation.d.ts

@@ -5,7 +5,10 @@ import { Time } from "./Time";
 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 */
     text: string;

package/schemas/typescript/TextAnnotation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextAnnotation.d.ts","sourceRoot":"","sources":["TextAnnotation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,iCAAiC;AACjC,MAAM,MAAM,cAAc,GAAG;IAC3B,8BAA8B;IAC9B,SAAS,EAAE,IAAI,CAAC;IAEhB,4EAA4E;IAC5E,QAAQ,EAAE,MAAM,CAAC;IAEjB,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IAEb,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;IAElB,iBAAiB;IACjB,UAAU,EAAE,KAAK,CAAC;IAElB,4BAA4B;IAC5B,gBAAgB,EAAE,KAAK,CAAC;CACzB,CAAC"}
+{"version":3,"file":"TextAnnotation.d.ts","sourceRoot":"","sources":["TextAnnotation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,iCAAiC;AACjC,MAAM,MAAM,cAAc,GAAG;IAC3B,8BAA8B;IAC9B,SAAS,EAAE,IAAI,CAAC;IAEhB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IAEb,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;IAElB,iBAAiB;IACjB,UAAU,EAAE,KAAK,CAAC;IAElB,4BAA4B;IAC5B,gBAAgB,EAAE,KAAK,CAAC;CACzB,CAAC"}

package/schemas/typescript/TextAnnotation.ts

@@ -10,7 +10,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 */