scripts

Validation scripts

Tools for validating the OpenKSpace reconstruction against reference implementations. These are developer aids; they are not part of the published crate.

validate.py

Runs openkspace recon on an ISMRMRD file, computes a numpy reference reconstruction on the same file, applies identical percentile windowing to both, and reports the structural similarity index (SSIM).

Requirements

Dependencies are declared in scripts/pyproject.toml and managed by uv. The first run creates scripts/.venv automatically - no manual install step needed.

If you do not have uv: pip install h5py numpy pillow scikit-image

Usage

# via the wrapper (builds the release binary if missing, handles venv)
./scripts/validate.sh path/to/file.h5 --slice 15

# directly with uv (from repo root)
uv run --project scripts scripts/validate.py path/to/file.h5 --slice 15

# all slices, save images
uv run --project scripts scripts/validate.py path/to/file.h5 \
    --all-slices --save-images recon_out/images/

Exit codes:

• 0 - PASS (SSIM >= threshold)
• 1 - FAIL (SSIM < threshold)
• 2 - error (missing file, missing binary, etc.)

validate_all.sh

Batch wrapper for CI. validate.py also accepts directories and multiple files directly; this wrapper just sets --binary from the BINARY environment variable (default ./target/release/openkspace) and forwards the rest.

Usage

cargo build --release

# every .h5 under a directory (recursive)
./scripts/validate_all.sh corpus/MRIData-org/knee/siemens/fully_sampled \
    --slice 15 --threshold 0.95 --report report.json

# or an explicit list
./scripts/validate_all.sh a.h5 b.h5 c.h5 --slice 0

Behaviour:

• Batch mode prints a per-file progress line, then a summary table with SSIM, status, and wall-clock time.
• --report path.json optionally emits a machine-readable report.
• Exit code is 1 if any file is FAIL or ERROR; 0 if all pass.