Skip to content

Commit

Permalink
Restore docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jjiszjj committed Dec 24, 2024
1 parent 9177191 commit 829f1d2
Show file tree
Hide file tree
Showing 150 changed files with 581 additions and 4,515 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -764,8 +764,6 @@ FodyWeavers.xsd
# JetBrains Rider
*.sln.iml

docs/
_html/

### VisualStudio Patch ###
# Additional files built by Visual Studio
Expand Down
2 changes: 0 additions & 2 deletions docs/.gitignore

This file was deleted.

16 changes: 0 additions & 16 deletions docs/.gitlab-ci.yml

This file was deleted.

Empty file removed docs/.nojekyll
Empty file.
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

87 changes: 0 additions & 87 deletions docs/README.md

This file was deleted.

40 changes: 40 additions & 0 deletions docs/align_depth_color.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## Aligning Depth to Color in ROS 2

This section explains how to align depth images with color images to create an overlay image using ROS 2. This is particularly useful for applications requiring synchronized visual information from different sensor modalities.

### Commands to Align and View Depth and Color Images

1. **Basic Depth to Color Alignment:**

To simply align the depth image to the color image, use the following command:

```bash
ros2 launch orbbec_camera gemini_330_series.launch.py depth_registration:=true
```

This command activates the depth registration feature without opening a viewer.

2. **Viewing Depth to Color Overlay:**

If you wish to view the depth to color overlay, you need to enable the viewer by using the command below:

```bash
ros2 launch orbbec_camera gemini_330_series.launch.py depth_registration:=true enable_d2c_viewer:=true
```

This launches the camera node with depth to color registration and opens a viewer to display the overlay image.

### Selecting Topics in RViz2

To visualize the aligned images in RViz2:

1. Launch RViz2 after running one of the above commands.
2. Select the topic for the depth to color overlay image. An example topic selection is shown here:

![Topic Selection for Depth to Color Overlay](./images/image3.png)

### Example of Depth to Color Overlay

After selecting the appropriate topic in RViz2, you will be able to see the depth to color overlay image. Here's what it might look like:

![Depth to Color Overlay Image](./images/image4.jpg)
40 changes: 40 additions & 0 deletions docs/align_depth_color_CN.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## 在ROS 2中将深度图像与彩色图像对齐

本节介绍如何使用ROS 2将深度图像与彩色图像对齐,以创建叠加图像。这对于需要来自不同传感器模态的同步视觉信息的应用程序特别有用。

### 对齐并查看深度和彩色图像的命令

1. **基本的深度到彩色对齐:**

要简单地将深度图像对齐到彩色图像,使用以下命令:

```bash
ros2 launch orbbec_camera gemini_330_series.launch.py depth_registration:=true
```

此命令激活深度注册功能,但不打开查看器。

2. **查看深度到彩色叠加:**

如果您希望查看深度到彩色叠加,您需要通过使用以下命令来启用查看器:

```bash
ros2 launch orbbec_camera gemini_330_series.launch.py depth_registration:=true enable_d2c_viewer:=true
```

这将启动具有深度到彩色注册的相机节点,并打开一个查看器以显示叠加图像。

### 在RViz2中选择主题

要在RViz2中可视化对齐的图像:

1. 在运行上述命令之一后启动RViz2。
2. 选择深度到彩色叠加图像的主题。这里显示了一个示例主题选择:

![深度到彩色叠加主题选择](./images/image3.png)

### 深度到彩色叠加示例

在RViz2中选择合适的主题后,您将能够看到深度到彩色叠加图像。这是它可能看起来的样子:

![深度到彩色叠加图像](./images/image4.jpg)
172 changes: 0 additions & 172 deletions docs/autobuild.sh

This file was deleted.

Loading

0 comments on commit 829f1d2

Please sign in to comment.