AI 更新文档

2026-07-09 14:03:45 +08:00
parent c77a64ffe7
commit c2fb0b12b5
3 changed files with 308 additions and 2 deletions
@@ -112,7 +112,13 @@ print(orisys.__version__)

 # 使用方法
 ## 运行示例程序
-套件里面包含了例子展示用法，运行步骤如下：
+套件里面包含了多个例子，建议都在仓库根目录运行（即 `config/`、`examples/`、`assets/` 同级目录）。常见入口分为两类：
+
+1. `examples/basic_pipeline.py`：复眼/拼接传感器基础 OpenCV 示例
+2. `examples/finger_pipeline.py`：指纹传感器 UV 展开最小流程示例
+3. `examples/finger_pipeline_3dview.py`：指纹传感器 Qt 3D 可视化界面
+
+下面先介绍最基础的 `basic_pipeline.py` 运行方式。

 ### Windows:
 1.	检查是否有其他正在连接的USB摄像头设备：打开powershell, 运行命令`Get-PnpDevice -PresentOnly | Where-Object { $_.Class -match '^Camera' }`，如果没有的话不会有输出。
@@ -134,5 +140,54 @@ print(orisys.__version__)
    ```
 5.	程序会运行，并自动打开可视化窗口和打印资料，在窗口上按键盘”q”键可以停止运行，按”r”键可以重设数据

+### 指纹传感器 UV 示例
+
+如果您使用的是指纹/单相机 UV 展开流程，可运行：
+
+``` bash
+python examples/finger_pipeline.py --camera_id 0 --config ./config/dd02-ov.json
+```
+
+如果输入来自视频文件，也可以改用：
+
+``` bash
+python examples/finger_pipeline.py --video ./data/sample.mp4 --config ./config/dd02-ov.json
+```
+
+该示例会：
+
+- 读取相机或视频源
+- 将图像展开到 UV 平面
+- 计算光流、法向/切向力和接触区域
+- 在 OpenCV 窗口中显示展开后的光流箭头图
+
+常用参数：
+
+- `--verbose`：输出更详细的初始化日志
+- `--profile`：打印每个阶段的耗时统计
+- `--profile-every N`：每 N 帧输出一次平均耗时
+
+例如：
+
+``` bash
+python examples/finger_pipeline.py --camera_id 0 --config ./config/dd02-ov.json --profile --profile-every 30
+```
+
+### 指纹 3D 可视化界面
+
+如果已经安装 GUI 依赖，还可以运行：
+
+``` bash
+pip install -e ".[gui]"
+python examples/finger_pipeline_3dview.py --video 0 --config ./config/dd02-ov.json
+```
+
+该界面会提供：
+
+- 指纹 UV 展开图
+- 力曲线
+- 3D mesh 视图
+- 录制与重置等交互控件
+
 ## 开发套件使用方法
 参考开发套件附带的开发文档。