Updating distortion model description (#139)

### Public-Facing Changes Updates description for distortion used in doc generation. Added details on expected parameters, underlying model, and reference implementation used. Currently [this page](https://docs.foxglove.dev/docs/visualization/message-schemas/camera-calibration/#distortion_model) is lacking that information. --------- Co-authored-by: John Hurliman <[email protected]>
foxglove · Jan 12, 2024 · b46d178 · b46d178
1 parent 4474e3b
commit b46d178
Show file tree

Hide file tree

Showing 14 changed files with 433 additions and 387 deletions.
diff --git a/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap b/internal/__snapshots__/exportTypeScriptSchemas.test.ts.snap
@@ -51,7 +51,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;
 

diff --git a/internal/schemas.ts b/internal/schemas.ts
@@ -693,7 +693,7 @@ const CameraCalibration: FoxgloveMessageSchema = {
       name: "distortion_model",
       type: { type: "primitive", name: "string" },
       description:
-        "Name of distortion model\n\nSupported values: `plumb_bob` and `rational_polynomial`",
+        "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)",
     },
     {
       name: "D",

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