Files
orisys-sdk/examples
ykcheungab 73b1fa7fa4 docs: correct the _perf path references after the bench moved
The `_perf/` measurement bench was gitignored and had never been committed, so
23 of the 27 scripts cited by the perf documents were already lost. The 11
surviving files (4 scripts, cfg_dm1.json, 5 result JSONs, the 53 MB MJPG clip)
have been moved to D:\orisys_ws\docs\performance\perf-measurements\ and the
scripts patched to resolve their defaults next to themselves. The directory has
been removed from this repo.

These three files said the scripts were deleted, which was only half true:
they are moved, and the four surviving ones still run. Repointed:

- src/orisys/sensor.py: the FILTER_PRESETS comment now names the real location
  (comment only; FILTER_PRESETS itself is unchanged).
- docs/filters.md and examples/filters/README.md: the same correction for the
  latency/noise measurement provenance.

No behaviour change.
2026-09-27 21:49:26 +08:00
..
2026-09-27 19:21:55 +08:00
2026-09-27 19:21:55 +08:00
2026-09-27 19:21:55 +08:00
2026-09-27 19:21:55 +08:00
2026-09-27 19:21:55 +08:00
2026-09-27 19:21:55 +08:00
2026-09-27 19:21:55 +08:00
2026-09-27 19:21:55 +08:00
2026-09-27 19:21:55 +08:00

Examples

Runnable demos live at the examples/ root. Shared helpers stay in pipeline/, viz/, and gui/. Run commands from the repository root.

Product Entry Points

Product Entry Default config
ORY-BOX basic_pipeline.py box
ORY-MINI mini_pipeline.py mini
ORY-FINGER (2D) finger_pipeline.py finger
ORY-FINGER (3D Qt) finger_pipeline_3dview.py finger

finger is the public ORY-FINGER config stem. dd02 remains a compatibility alias for dd02-ov.

Typical Usage

ORY-BOX:

python examples/basic_pipeline.py -v 0 -c box

ORY-MINI:

python examples/mini_pipeline.py -v 0 -c mini

ORY-FINGER 2D:

python examples/finger_pipeline.py --camera_id 0 --config finger

ORY-FINGER video file:

python examples/finger_pipeline.py --video ./data/sample.mp4 --config finger

ORY-FINGER 3D Qt dashboard:

pip install -e ".[gui]"
python examples/finger_pipeline_3dview.py --video 0 --config finger

Other Root Examples

  • plot_data.py — single-sensor OpenCV views plus PyQtGraph force charts
  • two_sensor_pipeline.py — two-sensor multiprocessing demo

Requirements

  • SDK installed from the repository root, for example pip install -e .
  • camera index or test video path
  • matching config names under ./config/ (or packaged orisys/configs/)

Qt / PyQtGraph examples additionally require:

pip install -e ".[gui]"

Notes

  • finger_pipeline_3dview.py is the main interactive finger demo. It uses gui/app_paths.py so the same entry works in editable and packaged runs.
  • Dashboard controls: click 启动 to start acquisition; use Record CSV / Stop CSV and the CSV save-directory browser to log contact/force data; Q quits, R resets, S starts video recording, E stops video recording, and Esc toggles fullscreen.
  • finger_pipeline.py is the leanest finger example if you want to validate UV unroll + force/contact processing without the full dashboard.