i/OrbbecSDK_ROS2
1
0
Fork 0
mirror of https://github.com/orbbec/OrbbecSDK_ROS2.git synced 2026-10-09 06:17:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: enhance launch parameters and services documentation with new filter options and color preset details

Browse Source
This commit is contained in:
ob-yalian
2026-06-26 10:11:47 +08:00
parent 0f73825d71
commit a178389fe7
8 changed files with 40 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/source/camera_devices/4_application_guide/launch_parameters.md
+10 -1
View File
@@ -121,7 +121,7 @@ The following are the launch parameters available:
* **`color_powerline_freq`**
* Set the power line freq. The possible values are `disable`, `50hz`, `60hz`, `auto`.
* **`color_preset`**
* Set the Color preset for Gemini 330 series devices. Options include `Default` and `Warm Biased AWB`.
* Set the Color preset by name. Supported on Gemini 330 series and Gemini 305 series devices. Common options include `Default`, `Warm Biased AWB`, and `Cold Biased AWB`; the exact list is reported by the device. The name comparison is case-insensitive.
* **`color_anti_flicker`**
* Enable Color anti-flicker. Supported by Gemini 330 series firmware `1.7.13` and above, and Gemini 305 series firmware `1.0.54` and above.
* **`enable_color_decimation_filter`** / **`color_decimation_filter_scale`**
@@ -226,6 +226,15 @@ The following are the launch parameters available:
* **`enable_false_positive_filter`**
* Enable this option to reduce ghosting noise.
> **Supported Modules**: DaBaiA / DaBaiAL / Gemini 330 series / Gemini345 / Gemini345Lg
* **`enable_edge_noise_removal_filter`**
* Enable EdgeNoiseRemovalFilter to reduce edge noise in depth frames.
> **Supported Modules**: DaBai Max Pro
* **`enable_disp_outliers_filter`**
* Enable DispOutliersFilter to remove disparity outliers in depth frames.
> **Supported Modules**: DaBai Max Pro
* **`disp_outliers_filter_search_mode`**
* Set the DispOutliersFilter search mode. Leave it empty to keep the SDK default. Options: `FULL`, `OFFSET_80`. The value is case-insensitive.
> **Supported Modules**: DaBai Max Pro
### Disparity
* **`disparity_to_depth_mode`**
* `HW`: use hardware disparity to depth conversion. `SW`: use software disparity to depth conversion. Use `disable` to turn it off.
docs/en/source/camera_devices/4_application_guide/services.md
+6
View File
@@ -247,10 +247,16 @@
ros2 service call /camera/set_filter orbbec_camera_msgs/srv/SetFilter '{filter_name: MgcNoiseRemovalFilter, filter_enable: true, filter_param: []}'
ros2 service call /camera/set_filter orbbec_camera_msgs/srv/SetFilter '{filter_name: LutNoiseRemovalFilter, filter_enable: true, filter_param: []}'
# Set EdgeNoiseRemovalFilter: []
ros2 service call /camera/set_filter orbbec_camera_msgs/srv/SetFilter '{filter_name: EdgeNoiseRemovalFilter, filter_enable: true, filter_param: []}'
# Tune filters with named parameters
ros2 service call /camera/set_filter orbbec_camera_msgs/srv/SetFilter "{filter_name: NoiseRemovalFilter, filter_enable: true, filter_config: [{name: min_diff, value: '256'}, {name: max_size, value: '80'}]}"
ros2 service call /camera/set_filter orbbec_camera_msgs/srv/SetFilter "{filter_name: HardwareNoiseRemovalFilter, filter_enable: true, filter_config: [{name: threshold, value: '0.2'}]}"
ros2 service call /camera/set_filter orbbec_camera_msgs/srv/SetFilter "{filter_name: SpatialAdvancedFilter, filter_enable: true, filter_config: [{name: alpha, value: '0.5'}, {name: disp_diff, value: '160'}, {name: magnitude, value: '1'}, {name: radius, value: '8'}]}"
# Set DispOutliersFilter. search_mode accepts FULL or OFFSET_80, case-insensitive.
ros2 service call /camera/set_filter orbbec_camera_msgs/srv/SetFilter "{filter_name: DispOutliersFilter, filter_enable: true, filter_config: [{name: search_mode, value: 'FULL'}]}"
```
Filter status is updated after service calls on `/camera/depth_filter_status` and `/camera/depth_filters/status`. `/camera/depth_filters/status` uses the structured `orbbec_camera_msgs/msg/DepthFiltersStatus` message and includes each filter's enabled state and parameters.
docs/en/source/camera_devices/5_advanced_guide/configuration/predefined_presets.md
+2
View File
@@ -67,6 +67,8 @@ The configuration file is located at `orbbec_camera/config/gemini2L_dual_ir.yaml
> Since the parameter configuration of `Dual Color Streams` mode is quite different from that of `Default` mode, we provide the corresponding YAML configuration file.
Please set `config_file_path` to `gemini305_dual_color.yaml`, the configuration file is located in the config directory.
Gemini 305 also supports Color preset selection with the `color_preset` parameter. Set the preset by name, for example `Default`, `Warm Biased AWB`, or `Cold Biased AWB`. The available names are reported by the device.
## Extended presets
### G33X Close Range High Accuracy (Gemini 330 / Gemini 335 / Gemini 336)