Skip to content

Commit c1e7a6c

Browse files
authored
[COS-6869] Feat: add img panel doc (#145)
* feat: add img panel doc
1 parent 0f55817 commit c1e7a6c

22 files changed

+182
-4
lines changed

docs/4-recipes/6-viz/9-create-moment-viz.md renamed to docs/4-recipes/6-viz/10-create-moment-viz.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 9
2+
sidebar_position: 10
33
---
44

55
# 在可视化界面中的一刻

docs/4-recipes/6-viz/8-image-panel.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
sidebar_position: 8
3+
---
4+
5+
# 图像面板
6+
显示原始及压缩后的图像和视频,并附带二维注释,如文本标签、圆形和点。同时叠加三维标记,以提供额外的上下文信息。
7+
8+
![img-panel](../img/img-panel.png)
9+
10+
## 设置
11+
12+
### 一般设置
13+
14+
- 话题:「话题」指的是数据流的类别或频道。每个话题代表一种特定类型的数据源或传感器数据,例如摄像头图像、激光雷达数据、注释信息等。
15+
- 校准:用于失真和 3D 主题的校准
16+
- 同步注释:仅在图像和 2D 标注的时间戳匹配时才显示它们。新接收到的 2D 标注消息将被缓存,直到找到匹配的图像集可以显示。目前尚不支持压缩视频主题。
17+
- 水平翻转:沿垂直轴翻转图像
18+
- 垂直翻转:沿水平轴翻转图像
19+
- 旋转: 图像旋转的角度(0°、90°、180° 或 270°)
20+
- 颜色模式:
21+
- 色彩映射 - 预定义的颜色调色板
22+
- 渐变 - 两种自定义颜色之间的平滑过渡
23+
- 颜色映射:仅在"颜色模式"设置为"颜色映射"时显示。用于将 mono16 和 16UC1 图像值映射到颜色:
24+
- Turbo(谷歌)
25+
- Rainbow(RViz)
26+
- 梯度: 仅当"颜色模式"设置为"渐变"时显示。为单色 16 位和 16 位无符号单通道图像指定渐变色值。
27+
- 最小值:单通道 16 位和 16 位无符号单通道深度图像的最小缩放值(默认值:0)。
28+
- 最大值:单通道 16 位和 16 位无符号单通道深度图像的最大缩放值(默认值:10000)。
29+
30+
### 场景
31+
- 渲染统计:在面板角落显示渲染性能统计信息
32+
- 背景:图像背后的背景颜色
33+
- 标签比例:文字标签的大小
34+
- 忽略 COLLADA 的 \<up_axis\>:在 COLLADA 文件中忽略 \<up_axis\> 标签
35+
- 网格上轴:加载没有方向信息的网格模型(STL、OBJ 格式)时"向上"的方向("Y 向上"、"Z 向上")
36+
37+
### 图像注释
38+
2D 图像标注标记显示的主题。
39+
40+
> 其他设置详见 [3d 面板](./5-3d-panel.md)
41+
42+
## 用户交互
43+
右键点击图片以将其下载为 PNG 文件格式。
44+
45+
![download-image](../img/download-image.png)
46+
47+
点击任何显示的图像标记以查看其详细信息
48+
49+
![image-detail](../img/image-detail.png)
50+
51+
滚动鼠标滚轮来缩放,拖动来平移。缩放时注释会重新渲染以保持清晰。
52+
53+
## 画面撕裂及卡顿
54+
当画面呈现撕裂和卡顿时,可能的原因是视频解码导致的延迟, 当浏览器无法使用硬件加速解码时会使用系统 CPU 解码,CPU 解码性能会显著低于硬件解码并且此时系统 CPU 负载和功耗也会影响到解码效率。硬件加速解码通常更快且性能开销更少, 请确认已启用该功能。
55+
56+
## 检查硬件加速:
57+
您可以通过打开 Google Chrome 并在地址栏中输入 <code>chrome://gpu</code> 来检查您的平台是否支持硬件加速视频解码。如果在此页面上未看到 <code>Video Decode: Hardware accelerated</code> 或 <code>Video Acceleration</code> 部分为空,则代表当前未开启硬件加速解码。
58+
59+
<table>
60+
<tr>
61+
<td>
62+
![video-decode](../img/chrome-gpu-setting1.png)
63+
</td>
64+
<td>
65+
![video-acceleration](../img/chrome-gpu-setting2.png)
66+
</td>
67+
</tr>
68+
</table>
69+
70+
## 启用硬件加速:
71+
访问 <code>chrome://settings</code>,搜索 <code>acceleration</code>,确保 <code>Use graphics acceleration when available</code> 切换已启用。
72+
73+
![chrome-settings-acceleration](../img/chrome-settings-acceleration.png)
74+
75+
访问 <code>chrome://flags</code>,搜索 <code>video</code>,确保 <code>Hardware-accelerated video decode</code> 已启用。
76+
77+
![chrome-flags-video](../img/chrome-flags-video.png)
78+
79+
MacOS:
80+
81+
对于 MacOS,当在基于 Chromium 的浏览器中将图形后端(graphics backend) 更改为使用 <code>Metal</code> 时,观察到显著的性能提升。您可以在 <code>about://flags</code> 中进行更改。
82+
83+
![chrome-flags-graphics-backend](../img/chrome-flags-graphics-backend.png)
84+
85+
86+
Linux:
87+
88+
- 请注意,Chrome/Chromium 默认不支持 Linux 上的视频加速,可能需要使用自定义 Chrome/Chromium 标记来启用 GPU。
89+
- 确保您的图形驱动程序已更新并正确安装。

docs/4-recipes/6-viz/8-layout.md renamed to docs/4-recipes/6-viz/9-layout.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 8
2+
sidebar_position: 9
33
---
44

55
# 布局
Loading
133 KB
Loading
201 KB
Loading
506 KB
Loading
Loading

docs/4-recipes/img/download-image.png

1.05 MB
Loading

docs/4-recipes/img/image-detail.png

897 KB
Loading

docs/4-recipes/img/img-panel.png

614 KB
Loading

i18n/en/docusaurus-plugin-content-docs/current/4-recipes/6-viz/9-moments.md renamed to i18n/en/docusaurus-plugin-content-docs/current/4-recipes/6-viz/10-moments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 9
2+
sidebar_position: 10
33
---
44
# Moments
55

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
sidebar_position: 8
3+
---
4+
5+
# Image
6+
Display raw and compressed images, as well as compressed videos, with 2D annotations like text labels, circles, and points. Superimpose 3D markers for additional context.
7+
8+
![img-panel](../img/img-panel.png)
9+
10+
## Settings
11+
12+
### General Settings
13+
14+
- Topic: "Topic" refers to the category or channel of data streams. Each topic represents a specific type of data source or sensor data, such as camera images, LiDAR data, annotation information, etc.
15+
- Calibration: Calibration topic to use for distortion and 3D markers
16+
- Synchronize annotations: Display images and 2D annotations only when their messages' timestamps match. Newly received 2D annotation messages will be buffered until a matching set can be displayed. Not yet supported for CompressedVideo topics.
17+
- Horizontal flip: Flip the image along the vertical axis
18+
- Vertical flip: Flip the image along the horizontal axis
19+
- Rotation: The angle of rotation of the image (0°, 90°, 180°, or 270°)
20+
- Color mode:
21+
- Color mapping - A predefined color palette
22+
- Gradient - A smooth transition between two custom colors
23+
- Color mapping: Displayed only when "Color mode" is set to "Color mapping". Used to map mono16 and 16UC1 image values to colors:
24+
- Turbo (Google)
25+
- Rainbow (RViz)
26+
- Gradient: Displayed only when "Color mode" is set to "Gradient". Specifies the gradient color values for monochrome 16-bit and 16-bit unsigned single-channel images.
27+
- Minimum value: The minimum scaling value for monochrome 16-bit and 16-bit unsigned single-channel depth images (default: 0).
28+
- Maximum value: The maximum scaling value for monochrome 16-bit and 16-bit unsigned single-channel depth images (default: 10000).
29+
30+
### Scene
31+
- Render stats: Display rendering performance statistics in the panel corner
32+
- Background: The background color behind the image
33+
- Label scale: The size of text labels
34+
- Ignore COLLADA's \<up_axis\>:Ignore the \<up_axis\> tag in COLLADA files
35+
- Mesh up axis: The "up" direction when loading a mesh model without orientation information (STL, OBJ format) ("Y up" or "Z up").
36+
37+
### Image Annotation
38+
2D image annotation markers displayed on the image.
39+
40+
> See more settings in [3d panel](./5-3d-panel.md)
41+
42+
## User Interaction
43+
Right-click on the image to download it as a PNG file format.
44+
45+
![download-image](../img/download-image.png)
46+
47+
Click any displayed image marker to view its details.
48+
49+
![image-detail](../img/image-detail.png)
50+
51+
Scroll the mouse wheel to zoom in and out, and drag to pan. The annotations are re-rendered to keep them clear when zooming.
52+
53+
## Screen tearing and stuttering
54+
When the screen appears to tear and stutter, it may be due to video decoding delays. When the browser cannot use hardware acceleration to decode, it uses the system CPU to decode. The CPU decoding performance is significantly lower than hardware decoding, and the system CPU load and power consumption also affect decoding efficiency. Hardware acceleration decoding is usually faster and has less performance overhead. Please confirm that this feature is enabled.
55+
56+
## Check hardware acceleration:
57+
You can check if your platform supports hardware acceleration video decoding by opening Google Chrome and entering <code>chrome://gpu</code> in the address bar. If you do not see <code>Video Decode: Hardware accelerated</code> or <code>Video Acceleration</code> section on this page, it means that hardware acceleration decoding is currently not enabled.
58+
59+
<table>
60+
<tr>
61+
<td>
62+
![video-decode](../img/chrome-gpu-setting1.png)
63+
</td>
64+
<td>
65+
![video-acceleration](../img/chrome-gpu-setting2.png)
66+
</td>
67+
</tr>
68+
</table>
69+
70+
## Enable hardware acceleration:
71+
Visit <code>chrome://settings</code>, search <code>acceleration</code>, ensure that <code>Use graphics acceleration when available</code> is enabled.
72+
73+
![chrome-settings-acceleration](../img/chrome-settings-acceleration.png)
74+
75+
Visit <code>chrome://flags</code>, search <code>video</code>, ensure that <code>Hardware-accelerated video decode</code> is enabled.
76+
77+
![chrome-flags-video](../img/chrome-flags-video.png)
78+
79+
MacOS:
80+
81+
For MacOS, when the graphics backend (graphics backend) is changed to use <code>Metal</code> in a Chromium-based browser, a significant performance improvement is observed. You can make the change in <code>about://flags</code>.
82+
83+
![chrome-flags-graphics-backend](../img/chrome-flags-graphics-backend.png)
84+
85+
86+
Linux:
87+
88+
- Note that Chrome/Chromium does not support video acceleration on Linux by default, and may require using custom Chrome/Chromium flags to enable GPU.
89+
- Ensure that your graphics driver is updated and correctly installed.

i18n/en/docusaurus-plugin-content-docs/current/4-recipes/6-viz/8-layout.md renamed to i18n/en/docusaurus-plugin-content-docs/current/4-recipes/6-viz/9-layout.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 8
2+
sidebar_position: 9
33
---
44

55
# Layout
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)