@foxglove/schemas 1.7.1 → 1.7.3

package/dist/jsonschema/index.js

@@ -1,7 +1,7 @@
 "use strict";
 // Generated by https://github.com/foxglove/foxglove-sdk
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Vector3 = exports.Vector2 = exports.TriangleListPrimitive = exports.TextPrimitive = exports.TextAnnotation = exports.SpherePrimitive = exports.RawImage = exports.RawAudio = exports.Quaternion = exports.PosesInFrame = exports.PoseInFrame = exports.Pose = exports.PointsAnnotation = exports.PointCloud = exports.Point3 = exports.Point2 = exports.PackedElementField = exports.ModelPrimitive = exports.SceneUpdate = exports.SceneEntity = exports.SceneEntityDeletion = exports.Log = exports.LocationFix = exports.LinePrimitive = exports.LaserScan = exports.KeyValuePair = exports.ImageAnnotations = exports.Grid = exports.GeoJSON = exports.FrameTransforms = exports.FrameTransform = exports.CubePrimitive = exports.CylinderPrimitive = exports.CompressedVideo = exports.CompressedImage = exports.Color = exports.CircleAnnotation = exports.CameraCalibration = exports.ArrowPrimitive = void 0;
+exports.Time = exports.Vector3 = exports.Vector2 = exports.TriangleListPrimitive = exports.Timestamp = exports.TextPrimitive = exports.TextAnnotation = exports.SpherePrimitive = exports.RawImage = exports.RawAudio = exports.Quaternion = exports.PosesInFrame = exports.PoseInFrame = exports.Pose = exports.PointsAnnotation = exports.PointCloud = exports.Point3 = exports.Point2 = exports.PackedElementField = exports.ModelPrimitive = exports.SceneUpdate = exports.SceneEntity = exports.SceneEntityDeletion = exports.Log = exports.LocationFix = exports.LinePrimitive = exports.LaserScan = exports.KeyValuePair = exports.ImageAnnotations = exports.Grid = exports.GeoJSON = exports.FrameTransforms = exports.FrameTransform = exports.Duration = exports.CubePrimitive = exports.CylinderPrimitive = exports.CompressedVideo = exports.CompressedImage = exports.Color = exports.CircleAnnotation = exports.CameraCalibration = exports.ArrowPrimitive = void 0;
 exports.ArrowPrimitive = {
     "title": "foxglove.ArrowPrimitive",
     "description": "A primitive representing an arrow",
@@ -136,7 +136,7 @@ exports.CameraCalibration = {
         },
         "distortion_model": {
             "type": "string",
-            "description": "Name of distortion model\n\nSupported 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)"
+            "description": "Name of distortion model\n\nSupported parameters: `plumb_bob` (k1, k2, p1, p2, k3), `rational_polynomial` (k1, k2, p1, p2, k3, k4, k5, k6), and `kannala_brandt` (k1, k2, k3, k4). `plumb_bob` and `rational_polynomial` models are based on the pinhole model [OpenCV's](https://docs.opencv.org/4.11.0/d9/d0c/group__calib3d.html) [pinhole camera model](https://en.wikipedia.org/wiki/Distortion_%28optics%29#Software_correction). The `kannala_brandt` model matches the [OpenvCV fisheye](https://docs.opencv.org/4.11.0/db/d58/group__calib3d__fisheye.html) model."
         },
         "D": {
             "type": "array",
@@ -571,6 +571,23 @@ exports.CubePrimitive = {
         }
     }
 };
+exports.Duration = {
+    "title": "foxglove.Duration",
+    "description": "A duration of time, composed of seconds and nanoseconds",
+    "$comment": "Generated by https://github.com/foxglove/foxglove-sdk",
+    "type": "object",
+    "properties": {
+        "sec": {
+            "type": "integer",
+            "description": "The number of seconds in the duration"
+        },
+        "nsec": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "The number of nanoseconds in the positive direction"
+        }
+    }
+};
 exports.FrameTransform = {
     "title": "foxglove.FrameTransform",
     "description": "A transform between two reference frames in 3D space",
@@ -869,39 +886,48 @@ exports.Grid = {
                         "oneOf": [
                             {
                                 "title": "UNKNOWN",
-                                "const": 0
+                                "const": 0,
+                                "description": "Unknown numeric type"
                             },
                             {
                                 "title": "UINT8",
-                                "const": 1
+                                "const": 1,
+                                "description": "Unsigned 8-bit integer"
                             },
                             {
                                 "title": "INT8",
-                                "const": 2
+                                "const": 2,
+                                "description": "Signed 8-bit integer"
                             },
                             {
                                 "title": "UINT16",
-                                "const": 3
+                                "const": 3,
+                                "description": "Unsigned 16-bit integer"
                             },
                             {
                                 "title": "INT16",
-                                "const": 4
+                                "const": 4,
+                                "description": "Signed 16-bit integer"
                             },
                             {
                                 "title": "UINT32",
-                                "const": 5
+                                "const": 5,
+                                "description": "Unsigned 32-bit integer"
                             },
                             {
                                 "title": "INT32",
-                                "const": 6
+                                "const": 6,
+                                "description": "Signed 32-bit integer"
                             },
                             {
                                 "title": "FLOAT32",
-                                "const": 7
+                                "const": 7,
+                                "description": "32-bit floating-point number"
                             },
                             {
                                 "title": "FLOAT64",
-                                "const": 8
+                                "const": 8,
+                                "description": "64-bit floating-point number"
                             }
                         ]
                     }
@@ -912,7 +938,7 @@ exports.Grid = {
         "data": {
             "type": "string",
             "contentEncoding": "base64",
-            "description": "Grid cell data, interpreted using `fields`, in row-major (y-major) order"
+            "description": "Grid cell data, interpreted using `fields`, in row-major (y-major) order — values fill each row from left to right along the X axis, with rows ordered from top to bottom along the Y axis, starting at the bottom-left corner when viewed from +Z looking towards -Z with identity orientations"
         }
     }
 };
@@ -1047,7 +1073,8 @@ exports.ImageAnnotations = {
                         "oneOf": [
                             {
                                 "title": "UNKNOWN",
-                                "const": 0
+                                "const": 0,
+                                "description": "Unknown points annotation type"
                             },
                             {
                                 "title": "POINTS",
@@ -1604,19 +1631,23 @@ exports.LocationFix = {
             "oneOf": [
                 {
                     "title": "UNKNOWN",
-                    "const": 0
+                    "const": 0,
+                    "description": "Unknown position covariance type"
                 },
                 {
                     "title": "APPROXIMATED",
-                    "const": 1
+                    "const": 1,
+                    "description": "Position covariance is approximated"
                 },
                 {
                     "title": "DIAGONAL_KNOWN",
-                    "const": 2
+                    "const": 2,
+                    "description": "Position covariance is per-axis, so put it along the diagonal"
                 },
                 {
                     "title": "KNOWN",
-                    "const": 3
+                    "const": 3,
+                    "description": "Position covariance of the fix is known"
                 }
             ]
         }
@@ -1650,27 +1681,33 @@ exports.Log = {
             "oneOf": [
                 {
                     "title": "UNKNOWN",
-                    "const": 0
+                    "const": 0,
+                    "description": "Unknown log level"
                 },
                 {
                     "title": "DEBUG",
-                    "const": 1
+                    "const": 1,
+                    "description": "Debug log level"
                 },
                 {
                     "title": "INFO",
-                    "const": 2
+                    "const": 2,
+                    "description": "Info log level"
                 },
                 {
                     "title": "WARNING",
-                    "const": 3
+                    "const": 3,
+                    "description": "Warning log level"
                 },
                 {
                     "title": "ERROR",
-                    "const": 4
+                    "const": 4,
+                    "description": "Error log level"
                 },
                 {
                     "title": "FATAL",
-                    "const": 5
+                    "const": 5,
+                    "description": "Fatal log level"
                 }
             ]
         },
@@ -3956,39 +3993,48 @@ exports.PackedElementField = {
             "oneOf": [
                 {
                     "title": "UNKNOWN",
-                    "const": 0
+                    "const": 0,
+                    "description": "Unknown numeric type"
                 },
                 {
                     "title": "UINT8",
-                    "const": 1
+                    "const": 1,
+                    "description": "Unsigned 8-bit integer"
                 },
                 {
                     "title": "INT8",
-                    "const": 2
+                    "const": 2,
+                    "description": "Signed 8-bit integer"
                 },
                 {
                     "title": "UINT16",
-                    "const": 3
+                    "const": 3,
+                    "description": "Unsigned 16-bit integer"
                 },
                 {
                     "title": "INT16",
-                    "const": 4
+                    "const": 4,
+                    "description": "Signed 16-bit integer"
                 },
                 {
                     "title": "UINT32",
-                    "const": 5
+                    "const": 5,
+                    "description": "Unsigned 32-bit integer"
                 },
                 {
                     "title": "INT32",
-                    "const": 6
+                    "const": 6,
+                    "description": "Signed 32-bit integer"
                 },
                 {
                     "title": "FLOAT32",
-                    "const": 7
+                    "const": 7,
+                    "description": "32-bit floating-point number"
                 },
                 {
                     "title": "FLOAT64",
-                    "const": 8
+                    "const": 8,
+                    "description": "64-bit floating-point number"
                 }
             ]
         }
@@ -4132,39 +4178,48 @@ exports.PointCloud = {
                         "oneOf": [
                             {
                                 "title": "UNKNOWN",
-                                "const": 0
+                                "const": 0,
+                                "description": "Unknown numeric type"
                             },
                             {
                                 "title": "UINT8",
-                                "const": 1
+                                "const": 1,
+                                "description": "Unsigned 8-bit integer"
                             },
                             {
                                 "title": "INT8",
-                                "const": 2
+                                "const": 2,
+                                "description": "Signed 8-bit integer"
                             },
                             {
                                 "title": "UINT16",
-                                "const": 3
+                                "const": 3,
+                                "description": "Unsigned 16-bit integer"
                             },
                             {
                                 "title": "INT16",
-                                "const": 4
+                                "const": 4,
+                                "description": "Signed 16-bit integer"
                             },
                             {
                                 "title": "UINT32",
-                                "const": 5
+                                "const": 5,
+                                "description": "Unsigned 32-bit integer"
                             },
                             {
                                 "title": "INT32",
-                                "const": 6
+                                "const": 6,
+                                "description": "Signed 32-bit integer"
                             },
                             {
                                 "title": "FLOAT32",
-                                "const": 7
+                                "const": 7,
+                                "description": "32-bit floating-point number"
                             },
                             {
                                 "title": "FLOAT64",
-                                "const": 8
+                                "const": 8,
+                                "description": "64-bit floating-point number"
                             }
                         ]
                     }
@@ -4207,7 +4262,8 @@ exports.PointsAnnotation = {
             "oneOf": [
                 {
                     "title": "UNKNOWN",
-                    "const": 0
+                    "const": 0,
+                    "description": "Unknown points annotation type"
                 },
                 {
                     "title": "POINTS",
@@ -4633,26 +4689,26 @@ exports.RawImage = {
         "width": {
             "type": "integer",
             "minimum": 0,
-            "description": "Image width"
+            "description": "Image width in pixels"
         },
         "height": {
             "type": "integer",
             "minimum": 0,
-            "description": "Image height"
+            "description": "Image height in pixels"
         },
         "encoding": {
             "type": "string",
-            "description": "Encoding of the raw image data\n\nSupported values: `8UC1`, `8UC3`, `16UC1` (little endian), `32FC1` (little endian), `bayer_bggr8`, `bayer_gbrg8`, `bayer_grbg8`, `bayer_rggb8`, `bgr8`, `bgra8`, `mono8`, `mono16`, `rgb8`, `rgba8`, `uyvy` or `yuv422`, `yuyv` or `yuv422_yuy2`"
+            "description": "Encoding of the raw image data. See the `data` field description for supported values."
         },
         "step": {
             "type": "integer",
             "minimum": 0,
-            "description": "Byte length of a single row"
+            "description": "Byte length of a single row. This is usually some multiple of `width` depending on the encoding, but can be greater to incorporate padding."
         },
         "data": {
             "type": "string",
             "contentEncoding": "base64",
-            "description": "Raw image data"
+            "description": "Raw image data.\n\nFor each `encoding` value, the `data` field contains image pixel data serialized as follows:\n\n- `yuv422` or `uyvy`:\n  - Pixel colors are decomposed into [Y'UV](https://en.wikipedia.org/wiki/Y%E2%80%B2UV) channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - U and V values are shared between horizontal pairs of pixels. Each pair of output pixels is serialized as [U, Y1, V, Y2].\n  - `step` must be greater than or equal to `width` * 2.\n- `yuv422_yuy2` or  `yuyv`:\n  - Pixel colors are decomposed into [Y'UV](https://en.wikipedia.org/wiki/Y%E2%80%B2UV) channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - U and V values are shared between horizontal pairs of pixels. Each pair of output pixels is encoded as [Y1, U, Y2, V].\n  - `step` must be greater than or equal to `width` * 2.\n- `rgb8`:\n  - Pixel colors are decomposed into Red, Green, and Blue channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - Each output pixel is serialized as [R, G, B].\n  - `step` must be greater than or equal to `width` * 3.\n- `rgba8`:\n  - Pixel colors are decomposed into Red, Green, Blue, and Alpha channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - Each output pixel is serialized as [R, G, B, Alpha].\n  - `step` must be greater than or equal to `width` * 4.\n- `bgr8` or `8UC3`:\n  - Pixel colors are decomposed into Red, Blue, Green, and Alpha channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - Each output pixel is serialized as [B, G, R].\n  - `step` must be greater than or equal to `width` * 3.\n- `bgra8`:\n  - Pixel colors are decomposed into Blue, Green, Red, and Alpha channels.\n  - Pixel channel values are represented as unsigned 8-bit integers.\n  - Each output pixel is encoded as [B, G, R, Alpha].\n  - `step` must be greater than or equal to `width` * 4.\n- `32FC1`:\n  - Pixel brightness is represented as a single-channel, 32-bit little-endian IEEE 754 floating-point value, ranging from 0.0 (black) to 1.0 (white).\n  - `step` must be greater than or equal to `width` * 4.\n- `bayer_rggb8`, `bayer_bggr8`, `bayer_rggb8`, `bayer_gbrg8`, or `bayer_grgb8`:\n  - Pixel colors are decomposed into Red, Blue and Green channels.\n  - Pixel channel values are represented as unsigned 8-bit integers, and serialized in a 2x2 bayer filter pattern.\n  - The order of the four letters after `bayer_` determine the layout, so for `bayer_wxyz8` the pattern is:\n  ```plaintext\n  w | x\n  - + -\n  y | z\n  ```\n  - `step` must be greater than or equal to `width`.\n- `mono8` or `8UC1`:\n  - Pixel brightness is represented as unsigned 8-bit integers.\n  - `step` must be greater than or equal to `width`.\n- `mono16` or `16UC1`:\n  - Pixel brightness is represented as 16-bit unsigned little-endian integers. Rendering of these values is controlled in [Image panel color mode settings](https://docs.foxglove.dev/docs/visualization/panels/image#general).\n  - `step` must be greater than or equal to `width` * 2.\n"
         }
     }
 };
@@ -4944,6 +5000,24 @@ exports.TextPrimitive = {
         }
     }
 };
+exports.Timestamp = {
+    "title": "foxglove.Timestamp",
+    "description": "A timestamp composed of seconds and nanoseconds",
+    "$comment": "Generated by https://github.com/foxglove/foxglove-sdk",
+    "type": "object",
+    "properties": {
+        "sec": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "The number of seconds since a user-defined epoch"
+        },
+        "nsec": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "The number of nanoseconds since the sec value"
+        }
+    }
+};
 exports.TriangleListPrimitive = {
     "title": "foxglove.TriangleListPrimitive",
     "description": "A primitive representing a set of triangles or a surface tiled by triangles",
@@ -5118,4 +5192,5 @@ exports.Vector3 = {
         }
     }
 };
+exports.Time = exports.Timestamp;
 //# sourceMappingURL=index.js.map