docs: update documentation for Gemini 330 series, including EnhancedDepthFilter and FalsePositiveFilter usage guides, and clarify SDK JSON import/export instructions

This commit is contained in:
ob-yalian
2026-07-20 13:58:37 +08:00
parent b12a821600
commit 45b3e1a5f0
12 changed files with 22 additions and 22 deletions
@@ -165,7 +165,7 @@ Here is the device support list of main branch (v1.x) and v2-main branch (v2.x):
</tbody> </tbody>
</table> </table>
**Note**: If you do not find your device, please contact our FAE or sales representative for help. **Note**: LiDAR devices are supported in v2.6.3 and later versions. For usage details, please refer to the [LiDAR documentation](../../lidar_devices/index.rst). If you do not find your device, please contact our FAE or sales representative for help.
**Definition**: **Definition**:
@@ -265,10 +265,10 @@ The following are the launch parameters available:
* Set the color MJPEG encoding quality. **Range:** `1–100`; **Default:** `-1` (leave the current device value unchanged). Firmware version `1.8.11` or later is required. * Set the color MJPEG encoding quality. **Range:** `1–100`; **Default:** `-1` (leave the current device value unchanged). Firmware version `1.8.11` or later is required.
> **Supported Modules**: Gemini 330 series > **Supported Modules**: Gemini 330 series
* **`enable_false_positive_filter`** * **`enable_false_positive_filter`**
* Enable this option to reduce ghosting noise. For usage examples and runtime tuning, see [False Positive Filtering for Gemini 330 Series](../5_advanced_guide/configuration/false_positive_filter.md). * Enable this option to reduce ghosting noise. For usage examples and runtime tuning, see [Gemini 330 Series FalsePositiveFilter Usage Guide](../5_advanced_guide/configuration/false_positive_filter.md).
> **Supported Modules**: Gemini 330 series / Gemini 340 series > **Supported Modules**: Gemini 330 series / Gemini 340 series
* **`enable_enhanced_depth`** * **`enable_enhanced_depth`**
* Enable LingBot enhanced depth filtering. The default is `false`. Both Color and Depth must be enabled, and D2C/C2D alignment must be configured. For complete environment, startup, and image requirements, see the [ROS2 EnhancedDepthFilter Usage Guide](../5_advanced_guide/configuration/enhanced_depth_filter.md). * Enable LingBot enhanced depth filtering. The default is `false`. Both Color and Depth must be enabled, and D2C/C2D alignment must be configured. For complete environment, startup, and image requirements, see the [Gemini 330 Series EnhancedDepthFilter Usage Guide](../5_advanced_guide/configuration/enhanced_depth_filter.md).
> **Supported Modules**: Gemini 330 series > **Supported Modules**: Gemini 330 series
* **`enhanced_depth_model_path`** * **`enhanced_depth_model_path`**
* Path to the LingBot `model.sm4` file. The default is empty. This parameter is required when enhanced depth filtering is enabled; an absolute path is recommended. The model file cannot be changed at runtime. * Path to the LingBot `model.sm4` file. The default is empty. This parameter is required when enhanced depth filtering is enabled; an absolute path is recommended. The model file cannot be changed at runtime.
@@ -349,10 +349,10 @@ The following are the launch parameters available:
* **`config_file_path`** * **`config_file_path`**
* The path to the YAML configuration file. Default is `""`. If not specified, default parameters from the launch file will be used. Some presets or special modes are configured through YAML. See [predefined presets](../5_advanced_guide/configuration/predefined_presets.md). * The path to the YAML configuration file. Default is `""`. If not specified, default parameters from the launch file will be used. Some presets or special modes are configured through YAML. See [predefined presets](../5_advanced_guide/configuration/predefined_presets.md).
* **`load_config_json_file_path`** * **`load_config_json_file_path`**
* SDK JSON configuration import path. When set, the node imports the JSON configuration during initialization. For Gemini 330 series, use `gemini_330_series_sdk_json.launch.py` as the dedicated SDK JSON launch file. See [SDK JSON Import and Export for Gemini 330 Series](../5_advanced_guide/configuration/sdk_json_config.md). * SDK JSON configuration import path. When set, the node imports the JSON configuration during initialization. For Gemini 330 series, use `gemini_330_series_sdk_json.launch.py` as the dedicated SDK JSON launch file. See [Gemini 330 Series SDK JSON Usage Guide](../5_advanced_guide/configuration/sdk_json_config.md).
* If the JSON contains `application_config`, the node syncs stream enable states, resolution, frame rate, format, undistortion, point cloud, HDR merge, and device-level decimation from it when the corresponding launch / YAML parameters have not been passed to the node. * If the JSON contains `application_config`, the node syncs stream enable states, resolution, frame rate, format, undistortion, point cloud, HDR merge, and device-level decimation from it when the corresponding launch / YAML parameters have not been passed to the node.
* **`export_config_json_file_path`** * **`export_config_json_file_path`**
* SDK JSON configuration export path. When set, the node exports the current device configuration to JSON after initialization. You can also export at runtime with the `/camera/export_config_json` service. See [SDK JSON Import and Export for Gemini 330 Series](../5_advanced_guide/configuration/sdk_json_config.md). * SDK JSON configuration export path. When set, the node exports the current device configuration to JSON after initialization. You can also export at runtime with the `/camera/export_config_json` service. See [Gemini 330 Series SDK JSON Usage Guide](../5_advanced_guide/configuration/sdk_json_config.md).
* Before export, the node syncs the current ROS2 sensor stream, point cloud, and HDR merge settings into the SDK `application_config` when the device supports it. * Before export, the node syncs the current ROS2 sensor stream, point cloud, and HDR merge settings into the SDK `application_config` when the device supports it.
* **`frame_aggregate_mode`** * **`frame_aggregate_mode`**
* Set frame aggregate output mode. Optional values: `full_frame`, `color_frame`, `ANY`, `disable`. * Set frame aggregate output mode. Optional values: `full_frame`, `color_frame`, `ANY`, `disable`.
@@ -185,7 +185,7 @@
ros2 service call /camera/get_sdk_version orbbec_camera_msgs/srv/GetString ros2 service call /camera/get_sdk_version orbbec_camera_msgs/srv/GetString
``` ```
* `/camera/export_config_json` * `/camera/export_config_json`
Export the current device configuration to an SDK JSON file. For the Gemini 330 series JSON import and export workflow, see [SDK JSON Import and Export for Gemini 330 Series](../5_advanced_guide/configuration/sdk_json_config.md). Export the current device configuration to an SDK JSON file. For the Gemini 330 series JSON import and export workflow, see [Gemini 330 Series SDK JSON Usage Guide](../5_advanced_guide/configuration/sdk_json_config.md).
```bash ```bash
ros2 service call /camera/export_config_json orbbec_camera_msgs/srv/SetString "{data: '/tmp/orbbec_camera_config.json'}" ros2 service call /camera/export_config_json orbbec_camera_msgs/srv/SetString "{data: '/tmp/orbbec_camera_config.json'}"
``` ```
@@ -231,7 +231,7 @@
### Depth Filter Configuration ### Depth Filter Configuration
* `/camera/set_filter` * `/camera/set_filter`
For `FalsePositiveFilter` startup parameters, status checks, and named-parameter tuning examples, see [False Positive Filtering for Gemini 330 Series](../5_advanced_guide/configuration/false_positive_filter.md). For `EnhancedDepthFilter` environment requirements, startup parameters, and status checks, see the [ROS2 EnhancedDepthFilter Usage Guide](../5_advanced_guide/configuration/enhanced_depth_filter.md). For `FalsePositiveFilter` startup parameters, status checks, and named-parameter tuning examples, see [Gemini 330 Series FalsePositiveFilter Usage Guide](../5_advanced_guide/configuration/false_positive_filter.md). For `EnhancedDepthFilter` environment requirements, startup parameters, and status checks, see the [Gemini 330 Series EnhancedDepthFilter Usage Guide](../5_advanced_guide/configuration/enhanced_depth_filter.md).
```bash ```bash
# filter_name is the filter name, and filter_enable indicates whether the filter is enabled. # filter_name is the filter name, and filter_enable indicates whether the filter is enabled.
# filter_param is the legacy positional parameter form; filter_config is the new named parameter form. # filter_param is the legacy positional parameter form; filter_config is the new named parameter form.
@@ -1,4 +1,4 @@
# EnhancedDepthFilter Usage Guide # Gemini 330 Series EnhancedDepthFilter Usage Guide
The LingBot Enhanced Depth Filter (`EnhancedDepthFilter`) uses both color and depth information to improve depth image quality by reducing noise, filling depth holes, and refining object edges. The LingBot Enhanced Depth Filter (`EnhancedDepthFilter`) uses both color and depth information to improve depth image quality by reducing noise, filling depth holes, and refining object edges.
@@ -1,4 +1,4 @@
# False Positive Filtering for Gemini 330 Series # Gemini 330 Series FalsePositiveFilter Usage Guide
This document describes how to use the `FalsePositiveFilter` in ROS2 for Gemini 330 series cameras, including enabling it at startup, checking its status, enabling or disabling it at runtime, and temporarily tuning its parameters. This document describes how to use the `FalsePositiveFilter` in ROS2 for Gemini 330 series cameras, including enabling it at startup, checking its status, enabling or disabling it at runtime, and temporarily tuning its parameters.
@@ -41,7 +41,7 @@ Notes:
## Optional: Import an SDK JSON File ## Optional: Import an SDK JSON File
If false positive filter parameters are already written in an SDK JSON file, import it with `load_config_json_file_path`. For the Gemini 330 series SDK JSON import and export workflow, parameter priority, and log checks, see [SDK JSON Import and Export for Gemini 330 Series](sdk_json_config.md). If false positive filter parameters are already written in an SDK JSON file, import it with `load_config_json_file_path`. For the Gemini 330 series SDK JSON import and export workflow, parameter priority, and log checks, see [Gemini 330 Series SDK JSON Usage Guide](sdk_json_config.md).
Common cases: Common cases:
@@ -1,4 +1,4 @@
# SDK JSON Import and Export for Gemini 330 Series # Gemini 330 Series SDK JSON Usage Guide
This document describes how to import and export SDK JSON configuration files for Gemini 330 series cameras in ROS2. This document describes how to import and export SDK JSON configuration files for Gemini 330 series cameras in ROS2.
@@ -165,7 +165,7 @@ OrbbecSDK ROS2 封装为 Orbbec 相机与 ROS 2 环境提供无缝集成。它
</tbody> </tbody>
</table> </table>
**注意**: 如果未找到您的设备,请联系我们的 FAE 或销售代表获取帮助。 **注意**: 雷达设备在 v2.6.3 及之后的版本中支持。使用详情请参考[雷达文档](../../lidar_devices/index.rst)。如果未找到您的设备,请联系我们的 FAE 或销售代表获取帮助。
**术语定义**: **术语定义**:
@@ -264,10 +264,10 @@
* 设置彩色 MJPEG 编码质量。**范围:** `1–100`,**默认值:** `-1`(不修改设备当前值)。需要固件版本大于等于 `1.8.11`。 * 设置彩色 MJPEG 编码质量。**范围:** `1–100`,**默认值:** `-1`(不修改设备当前值)。需要固件版本大于等于 `1.8.11`。
> **支持模组**:Gemini 330 系列。 > **支持模组**:Gemini 330 系列。
* **`enable_false_positive_filter`** * **`enable_false_positive_filter`**
* 启用鬼影滤波。可减少重影噪声,使用示例和运行时调参方法请参考 [Gemini 330 系列鬼影滤波](../5_advanced_guide/configuration/false_positive_filter.md)。 * 启用鬼影滤波。可减少重影噪声,使用示例和运行时调参方法请参考 [Gemini 330 系列 FalsePositiveFilter 使用说明](../5_advanced_guide/configuration/false_positive_filter.md)。
> **支持模组**:Gemini 330 系列 / Gemini 340 系列。 > **支持模组**:Gemini 330 系列 / Gemini 340 系列。
* **`enable_enhanced_depth`** * **`enable_enhanced_depth`**
* 启用 LingBot 增强深度滤波,默认值为 `false`。该功能需要同时启用 Color 和 Depth,并配置 D2C/C2D 对齐。完整环境、启动和图像要求请参考 [ROS2 EnhancedDepthFilter 使用说明](../5_advanced_guide/configuration/enhanced_depth_filter.md)。 * 启用 LingBot 增强深度滤波,默认值为 `false`。该功能需要同时启用 Color 和 Depth,并配置 D2C/C2D 对齐。完整环境、启动和图像要求请参考 [Gemini 330 系列 EnhancedDepthFilter 使用说明](../5_advanced_guide/configuration/enhanced_depth_filter.md)。
> **支持模组**:Gemini 330 系列。 > **支持模组**:Gemini 330 系列。
* **`enhanced_depth_model_path`** * **`enhanced_depth_model_path`**
* LingBot `model.sm4` 文件路径,默认值为空。启用增强深度滤波时必须设置,建议使用绝对路径;运行时不能更换模型文件。 * LingBot `model.sm4` 文件路径,默认值为空。启用增强深度滤波时必须设置,建议使用绝对路径;运行时不能更换模型文件。
@@ -347,10 +347,10 @@
* **`config_file_path`** * **`config_file_path`**
* YAML配置文件的路径。默认为 `""`。如果未指定,将使用启动文件中的默认参数。部分 preset 或特殊模式会通过 YAML 配置,示例参考 [设备预设](../5_advanced_guide/configuration/predefined_presets.md)。 * YAML配置文件的路径。默认为 `""`。如果未指定,将使用启动文件中的默认参数。部分 preset 或特殊模式会通过 YAML 配置,示例参考 [设备预设](../5_advanced_guide/configuration/predefined_presets.md)。
* **`load_config_json_file_path`** * **`load_config_json_file_path`**
* SDK JSON 配置导入路径。设置后节点会在初始化时调用 SDK 导入 JSON 配置。Gemini 330 系列可使用 `gemini_330_series_sdk_json.launch.py` 作为专用启动文件,使用方法参考 [Gemini 330 系列 SDK JSON 配置导入与导出](../5_advanced_guide/configuration/sdk_json_config.md)。 * SDK JSON 配置导入路径。设置后节点会在初始化时调用 SDK 导入 JSON 配置。Gemini 330 系列可使用 `gemini_330_series_sdk_json.launch.py` 作为专用启动文件,使用方法参考 [Gemini 330 系列 SDK JSON 使用说明](../5_advanced_guide/configuration/sdk_json_config.md)。
* 如果 JSON 中包含 `application_config`,节点会在对应 launch / YAML 参数未传入节点时同步其中的流开关、分辨率、帧率、格式、去畸变、点云、HDR 合并和设备级下采样配置。 * 如果 JSON 中包含 `application_config`,节点会在对应 launch / YAML 参数未传入节点时同步其中的流开关、分辨率、帧率、格式、去畸变、点云、HDR 合并和设备级下采样配置。
* **`export_config_json_file_path`** * **`export_config_json_file_path`**
* SDK JSON 配置导出路径。设置后节点会在初始化完成后将当前设备配置导出为 JSON。也可以通过 `/camera/export_config_json` 服务运行时导出,使用方法参考 [Gemini 330 系列 SDK JSON 配置导入与导出](../5_advanced_guide/configuration/sdk_json_config.md)。 * SDK JSON 配置导出路径。设置后节点会在初始化完成后将当前设备配置导出为 JSON。也可以通过 `/camera/export_config_json` 服务运行时导出,使用方法参考 [Gemini 330 系列 SDK JSON 使用说明](../5_advanced_guide/configuration/sdk_json_config.md)。
* 导出前会把当前 ROS2 参数中的传感器流、点云和 HDR 合并配置同步到 SDK `application_config`(设备支持时)。 * 导出前会把当前 ROS2 参数中的传感器流、点云和 HDR 合并配置同步到 SDK `application_config`(设备支持时)。
* **`frame_aggregate_mode`** * **`frame_aggregate_mode`**
* 设置帧聚合输出模式。可选值:`full_frame`、`color_frame`、`ANY`、`disable`。 * 设置帧聚合输出模式。可选值:`full_frame`、`color_frame`、`ANY`、`disable`。
@@ -185,7 +185,7 @@
ros2 service call /camera/get_sdk_version orbbec_camera_msgs/srv/GetString ros2 service call /camera/get_sdk_version orbbec_camera_msgs/srv/GetString
``` ```
* `/camera/export_config_json` * `/camera/export_config_json`
导出当前设备配置为 SDK JSON 文件。Gemini 330 系列的 JSON 导入导出流程请参考 [Gemini 330 系列 SDK JSON 配置导入与导出](../5_advanced_guide/configuration/sdk_json_config.md)。 导出当前设备配置为 SDK JSON 文件。Gemini 330 系列的 JSON 导入导出流程请参考 [Gemini 330 系列 SDK JSON 使用说明](../5_advanced_guide/configuration/sdk_json_config.md)。
```bash ```bash
ros2 service call /camera/export_config_json orbbec_camera_msgs/srv/SetString "{data: '/tmp/orbbec_camera_config.json'}" ros2 service call /camera/export_config_json orbbec_camera_msgs/srv/SetString "{data: '/tmp/orbbec_camera_config.json'}"
``` ```
@@ -231,7 +231,7 @@
### 深度滤波器配置 ### 深度滤波器配置
* `/camera/set_filter` * `/camera/set_filter`
`FalsePositiveFilter` 的启动参数、状态确认和命名参数调参示例可参考 [Gemini 330 系列鬼影滤波](../5_advanced_guide/configuration/false_positive_filter.md)。`EnhancedDepthFilter` 的环境要求、启动参数和状态确认方法可参考 [ROS2 EnhancedDepthFilter 使用说明](../5_advanced_guide/configuration/enhanced_depth_filter.md)。 `FalsePositiveFilter` 的启动参数、状态确认和命名参数调参示例可参考 [Gemini 330 系列 FalsePositiveFilter 使用说明](../5_advanced_guide/configuration/false_positive_filter.md)。`EnhancedDepthFilter` 的环境要求、启动参数和状态确认方法可参考 [Gemini 330 系列 EnhancedDepthFilter 使用说明](../5_advanced_guide/configuration/enhanced_depth_filter.md)。
```bash ```bash
# filter_name 为滤波器名称,filter_enable 表示是否开启滤波器开关。 # filter_name 为滤波器名称,filter_enable 表示是否开启滤波器开关。
# filter_param 为旧的按位置传参方式;filter_config 为新的命名参数方式。 # filter_param 为旧的按位置传参方式;filter_config 为新的命名参数方式。
@@ -1,4 +1,4 @@
# EnhancedDepthFilter 使用说明 # Gemini 330 系列 EnhancedDepthFilter 使用说明
LingBot 增强深度滤波器(`EnhancedDepthFilter`)同时使用彩色和深度信息,通过降低噪声、填补深度空洞和优化物体边缘来改善深度图像质量。 LingBot 增强深度滤波器(`EnhancedDepthFilter`)同时使用彩色和深度信息,通过降低噪声、填补深度空洞和优化物体边缘来改善深度图像质量。
@@ -1,4 +1,4 @@
# Gemini 330 系列鬼影滤波 # Gemini 330 系列 FalsePositiveFilter 使用说明
本文档说明如何在 ROS2 中为 Gemini 330 系列相机使用鬼影滤波 `FalsePositiveFilter`,包括启动时开启、状态确认、运行时开关和临时调参。 本文档说明如何在 ROS2 中为 Gemini 330 系列相机使用鬼影滤波 `FalsePositiveFilter`,包括启动时开启、状态确认、运行时开关和临时调参。
@@ -41,7 +41,7 @@ device_preset: "<preset_name>"
## 可选:导入 SDK JSON ## 可选:导入 SDK JSON
如果鬼影滤波参数已经写入 SDK JSON,可通过 `load_config_json_file_path` 导入。Gemini 330 系列 SDK JSON 的导入导出流程、参数优先级和日志确认方法,请参考 [Gemini 330 系列 SDK JSON 配置导入与导出](sdk_json_config.md)。 如果鬼影滤波参数已经写入 SDK JSON,可通过 `load_config_json_file_path` 导入。Gemini 330 系列 SDK JSON 的导入导出流程、参数优先级和日志确认方法,请参考 [Gemini 330 系列 SDK JSON 使用说明](sdk_json_config.md)。
常见情况: 常见情况:
@@ -1,4 +1,4 @@
# Gemini 330 系列 SDK JSON 配置导入与导出 # Gemini 330 系列 SDK JSON 使用说明
本文档说明如何在 ROS2 中为 Gemini 330 系列相机导入和导出 SDK JSON 配置文件。 本文档说明如何在 ROS2 中为 Gemini 330 系列相机导入和导出 SDK JSON 配置文件。