Files
orisys-sdk/examples/README.md
T
2026-06-18 13:47:16 +08:00

41 lines
1.2 KiB
Markdown

# 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.