docs(vision): document the local reference-image test-data convention

Mirko captured real OMNY sample-transfer reference images locally
(images_sample_transfer/, 7 HDF5 files from _otransfer_save_reference_images(),
~43MB) and asked where to put them. They match this repo's own .gitignore
rule for file-writer data (**.h5) -- packaged and sent to him directly
instead of committing; this just documents and reserves the conventional
drop-in location (csaxs_bec/devices/vision/reference_images/) so the
directory and its purpose exist in git even though real captures placed
there won't be tracked.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018Mupip8x7Hean6E3FFvpbj
This commit is contained in:
x01dcandClaude Sonnet 5 authored and Mirko Holler committed 2026-10-26 14:16:01 +01:00
1 parent 872a312cef
commit f728944258
1 file changed
+20
@@ -0,0 +1,20 @@
# Reference-image test data (local only, not tracked by git)
This directory is the conventional local drop-in location for real-camera reference-image
captures used to test the vision pipeline (`AI_docs/MACHINE_VISION_AUTOCONFIRM_PLAN.md`) --
e.g. OMNY's `_otransfer_save_reference_images()` output
(`sample_transfer_reference_image_<step>_<timestamp>.h5`, one HDF5 file per confirm gate, one
dataset per camera in the active pair).
**Not committed to git.** This repo's `.gitignore` excludes `**.h5` ("file writer data"), and a
real capture set is tens of megabytes -- exactly the kind of binary data that rule is for. Only
this `README.md` is tracked, so the directory (and the convention) exists in git even though its
actual contents don't.
To populate it locally: drop `.h5` capture files here directly (from a real OMNY session, or
transferred another way -- e.g. as a packaged archive from a remote session). See
`../../bec_ipython_client/plugins/omny/AI_docs/VISION_PIPELINE_TESTING_HOWTO.md` for how to use
real images (there, `DummyVisionCamera.load_image_file()`) against the vision pipeline; loading
straight from this HDF5 multi-camera-pair format specifically isn't wired up yet as of this
writing (`load_image_file()` reads a single plain image file via `cv2.imread`, not this format) --
check the plan doc's implementation-status section for the current state before assuming otherwise.