Files

T

ykcheungab d5b938738e docs: point perf references at the workspace docs tree; ignore .scratch/

orisys-sdk-perf-plan.md moved to D:\orisys_ws\docs\performance\ as part of the
2026-09-27 workspace cleanup. docs/filters.md and examples/filters/README.md now
name the new location; the _perf/ measurement scripts they also cited are deleted
(the document keeps every measured number).

Also ignore .scratch/, the new per-task scratch directory (see
D:\orisys_ws\AGENTS.md).

2026-09-27 21:14:20 +08:00

filters

docs: point perf references at the workspace docs tree; ignore .scratch/

2026-09-27 21:14:20 +08:00

gui

added ruff code reivew

2026-09-27 19:21:55 +08:00

pipeline

added ruff code reivew

2026-09-27 19:21:55 +08:00

viz

added ruff code reivew

2026-09-27 19:21:55 +08:00

basic_pipeline.py

added ruff code reivew

2026-09-27 19:21:55 +08:00

finger_pipeline_3dview.py

included low pass filter in package and add to plot_data example

2026-08-17 22:11:17 +08:00

finger_pipeline.py

added ruff code reivew

2026-09-27 19:21:55 +08:00

mini_pipeline.py

added ruff code reivew

2026-09-27 19:21:55 +08:00

multi_stream.py

added ruff code reivew

2026-09-27 19:21:55 +08:00

plot_data.py

added ruff code reivew

2026-09-27 19:21:55 +08:00

README.md

included low pass filter in package and add to plot_data example

2026-08-17 22:11:17 +08:00

two_sensor_pipeline.py

added ruff code reivew

2026-09-27 19:21:55 +08:00

README.md

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.