split example visualizaiton pipeline

2026-06-18 13:47:16 +08:00
parent fbee1c37ed
commit f19f092b64
42 changed files with 3067 additions and 702 deletions
@@ -1,50 +1,41 @@
-# Examples
-
-This folder contains user-facing example scripts for the Orisys SDK.
-
-## Files
-
- `basic_pipeline.py`: single-sensor basic processing and visualization flow
- `two_sensor_pipeline.py`: dual-sensor multiprocessing example
- `plot_data.py`: real-time plotting example with PyQtGraph
-
-## Typical usage
-
-Run examples from the repository root so relative paths such as `./config/ddjx01.json`
-resolve correctly.
-
-### Basic pipeline
-
-```bash
-python examples/basic_pipeline.py -v 0 -c ./config/ddjx01.json
-```
-
-### Two-sensor pipeline
-
-```bash
-python examples/two_sensor_pipeline.py
-```
-
-### Real-time plotting
-
-```bash
-python examples/plot_data.py -v 0 -c ./config/ddjx01.json
-```
-
-## Requirements
-
- Python environment with the SDK dependencies installed
- a supported camera or test video
- valid JSON config in `./config/`
-
-Some examples also require:
-
- `pyqtgraph`
- `PyQt5`
- multiple cameras for multi-sensor demos
-
-## Notes
-
- Most examples assume a tactile sensor camera is connected.
- Press `q` in the display window to quit where applicable.
- If your camera index is not `0`, change `-v` accordingly.
+# Examples
+
+User-facing demo scripts for the Orisys SDK. Run from the repository root.
+
+## Layout
+
+- `basic_pipeline.py` — compound-eye sensor, OpenCV visualization
+- `plot_data.py` — compound-eye sensor, force charts (PyQtGraph)
+- `two_sensor_pipeline.py` — dual-sensor multiprocessing demo
+- `finger_pipeline.py` — finger UV minimal pipeline
+- `finger_pipeline_3dview.py` — finger UV + Open3D mesh viewer
+- `finger_plot_data.py` — finger UV + force charts
+- `viz/` — shared visualization helpers used by plot and finger examples
+  - `mesh_viewer.py` — re-exports `UVMeshViewer` / `build_uv_surface_mesh` from `orisys.finger`
+  - `finger_panels.py` — 2D OpenCV panels for finger demos
+
+## Typical usage
+
+```bash
+python examples/basic_pipeline.py -v 0 -c ./config/ddjx01.json
+python examples/plot_data.py -v 0 -c ./config/ddjx01.json
+python examples/finger_plot_data.py -v 0 -c ./config/dd02-ov.json
+```
+
+## Requirements
+
+- SDK installed (`pip install -e .`)
+- camera or test video
+- JSON config under `./config/`
+
+Plot examples additionally require:
+
+```bash
+pip install pyqt5 pyqtgraph
+```
+
+## Notes
+
+- Press `q` to quit OpenCV windows where applicable.
+- Plot examples: `s` starts recording, `e` stops recording.
+