strasbourg-basel: sync data card and figures with GitHub
#25
by tristan-deep - opened
strasbourg-basel/README.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
| 1 |
---
|
| 2 |
-
|
|
|
|
| 3 |
license: cc-by-4.0
|
| 4 |
task_categories:
|
| 5 |
- other
|
|
@@ -22,257 +23,116 @@ size_categories:
|
|
| 22 |
- n<1K
|
| 23 |
---
|
| 24 |
|
| 25 |
-
# BoneSRF
|
| 26 |
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
contributes three 3D-printed, fractured femur phantoms — scanned, beamformed-RF-
|
| 31 |
-
inverted, and packaged in the OpenH-RF `zea` format — to the OpenH-RF initiative.
|
| 32 |
|
| 33 |
-
|
| 34 |
-
`proximal`, `wholebone`), giving nine `zea` HDF5 files in [`data/`](data/). Every
|
| 35 |
-
scan is **robot-tracked** — the probe was mounted on a robotic arm and its pose
|
| 36 |
-
independently recorded — and every file also carries that phantom's **CT scan and
|
| 37 |
-
multi-label segmentation** inside it.
|
| 38 |
|
| 39 |
## Dataset Description
|
| 40 |
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
numerical estimate: the per-element channel data consistent with the probe's known
|
| 45 |
-
per-scanline focused acquisition geometry (transmit delays, apodization, walking
|
| 46 |
-
sub-aperture) that, if beamformed the same way, would reproduce the real Clarius
|
| 47 |
-
output. This estimate is recovered by solving a conjugate-gradient least-squares
|
| 48 |
-
(CGLS) inversion of a zea `DASOperator` built from that acquisition geometry,
|
| 49 |
-
against the real beamformed phantom scans as the inversion target.
|
| 50 |
-
|
| 51 |
-
This is phantom data — not simulated, clinical, or in-vivo — intended for
|
| 52 |
-
full-matrix-capture-style beamforming and image-reconstruction research at a
|
| 53 |
-
bone-tissue interface, and as a worked example of recovering pre-beamformed data
|
| 54 |
-
from beamformed-only ultrasound exports.
|
| 55 |
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
1. **Real acquisition.** A Clarius handheld-probe-class linear array (L20HD3) was
|
| 59 |
-
used to scan each phantom, producing the probe's own beamformed RF output — this
|
| 60 |
-
is the *real*, physically acquired data, not simulated.
|
| 61 |
-
2. **Inversion.** The beamformed RF is inverted back into pre-beamformed,
|
| 62 |
-
per-element channel data using
|
| 63 |
-
[`das-inverse` (`clarius` branch)](https://github.com/sankethvedula/das-inverse/tree/clarius)
|
| 64 |
-
— a CGLS solver over a `zea.inverse.DASOperator` forward model of the probe's
|
| 65 |
-
focused, walking-sub-aperture transmit sequence (`invert_clarius_beamformed.py`).
|
| 66 |
-
The result is what this dataset calls "simulated" channel data: not
|
| 67 |
-
sensor-captured, but numerically consistent with the real beamformed acquisition
|
| 68 |
-
it was inverted from.
|
| 69 |
-
3. **Packaging.** The inverted channel data, transmit-sequence metadata, probe
|
| 70 |
-
geometry, per-frame probe pose, and the phantom's CT + segmentation are written
|
| 71 |
-
out as one `zea` HDF5 file per scan, matching the OpenH-RF format spec.
|
| 72 |
-
|
| 73 |
-
### Probe tracking
|
| 74 |
-
|
| 75 |
-
Every scan is **tracked**: the probe was mounted on a robotic arm, and its pose was
|
| 76 |
-
independently recorded via a trakSTAR electromagnetic tracking system with a fixed
|
| 77 |
-
fCal image-to-probe calibration. The tracking stream is packaged **per-frame
|
| 78 |
-
indexed** inside each file's metadata (`metadata/probe_pose`: translation, rotation,
|
| 79 |
-
timestamps) — `metadata/probe_pose[i]` corresponds directly to `raw_data[i]`, index
|
| 80 |
-
for index. It does not need a separate sidecar file, and the raw tracking capture is
|
| 81 |
-
not shipped — only the recovered, aligned pose stream.
|
| 82 |
-
|
| 83 |
-
### The three phantoms
|
| 84 |
|
| 85 |
-
Each phantom
|
| 86 |
-
dataset, with a fracture pattern simulated differently for each of the three. Each
|
| 87 |
-
printed femur is immersed in ultrasound-coupling gel and scanned by a robotic arm,
|
| 88 |
-
which gives repeatable, controlled probe trajectories instead of a freehand scan.
|
| 89 |
-
Each phantom is scanned three times, at three positions along the bone:
|
| 90 |
|
| 91 |
-
-
|
| 92 |
-
- **`proximal`** — a sweep over the proximal region of the femur
|
| 93 |
-
- **`wholebone`** — a sweep covering the full length of the femur
|
| 94 |
|
| 95 |
-
|
| 96 |
-
simulated in each phantom (location; type: transverse / oblique / comminuted /
|
| 97 |
-
hairline; displacement) has not yet been documented. The CT segmentation carried in
|
| 98 |
-
each file is ground truth for the physical phantom geometry in the meantime.
|
| 99 |
|
| 100 |
-
##
|
| 101 |
-
|
| 102 |
-
```
|
| 103 |
-
BoneSRF/
|
| 104 |
-
├── README.md ← this file (dataset overview + data card for all nine scans)
|
| 105 |
-
├── LICENCE (CC BY 4.0)
|
| 106 |
-
├── pipeline.yaml (saved zea.Pipeline — one pipeline, shared by all nine scans)
|
| 107 |
-
├── reconstruct.py (runs pipeline.yaml on any scan → reference_bmodes/<scan>.png)
|
| 108 |
-
├── data/
|
| 109 |
-
│ ├── phantom1_distal.hdf5 (zea channel data + per-frame probe pose + CT)
|
| 110 |
-
│ ├── phantom1_proximal.hdf5
|
| 111 |
-
│ ├── phantom1_wholebone.hdf5
|
| 112 |
-
│ ├── phantom2_*.hdf5 (same three sweeps)
|
| 113 |
-
│ └── phantom3_*.hdf5 (same three sweeps)
|
| 114 |
-
└── reference_bmodes/
|
| 115 |
-
└── <scan>.png (one reference reconstruction per scan)
|
| 116 |
-
```
|
| 117 |
|
| 118 |
-
|
| 119 |
-
channel data, the
|
| 120 |
-
|
| 121 |
-
depicts.
|
| 122 |
|
| 123 |
-
##
|
| 124 |
|
| 125 |
-
|
| 126 |
-
one frame of one scan:
|
| 127 |
|
| 128 |
-
|
| 129 |
-
python reconstruct.py # all nine, at their reference frames
|
| 130 |
-
python reconstruct.py phantom1_distal # one scan, at its reference frame
|
| 131 |
-
python reconstruct.py phantom1_distal --frame 40 --device cpu
|
| 132 |
-
```
|
| 133 |
|
| 134 |
-
|
| 135 |
-
physically-motivated per-transmit `pfield` weighting, since this is a per-scanline
|
| 136 |
-
focused walking-sub-aperture acquisition rather than full synthetic aperture) →
|
| 137 |
-
`keras.ops.abs` → axial-only Gaussian blur → `normalize` → `log_compress`, with
|
| 138 |
-
display parameters (dynamic range, p-field settings) also read from `pipeline.yaml`.
|
| 139 |
-
Acquisition geometry comes from each file's own `scan`/`probe` groups.
|
| 140 |
|
| 141 |
-
|
| 142 |
-
*
|
| 143 |
-
|
| 144 |
-
frame is read.
|
| 145 |
|
| 146 |
## Dataset Contributor(s)
|
| 147 |
|
| 148 |
-
Sidaty El Hadramy
|
| 149 |
-
Department of Biomedical Engineering, University of Basel
|
|
|
|
| 150 |
|
| 151 |
## Dataset Creation Date
|
| 152 |
|
| 153 |
-
|
| 154 |
-
(`phantom1_proximal`, acquisition ID `20260625-ihu-04_BoneSRF-01_proximal_robot_r3`).
|
| 155 |
-
The acquisition date of the other seven sweeps was not separately recorded — see
|
| 156 |
-
[Known Issues](#known-issues). Converted to `zea` format 21/07/2026–05/08/2026 and
|
| 157 |
-
re-converted 13/08/2026–14/08/2026 to align probe tracking to `raw_data`
|
| 158 |
-
frame-by-frame. CT and segmentation embedded into the files 09/09/2026.
|
| 159 |
|
| 160 |
## License / Terms of Use
|
| 161 |
|
| 162 |
-
|
| 163 |
-
CC BY 4.0 release (phantom data; no patient consent or third-party IP encumbrance
|
| 164 |
-
applies). The CT and segmentation data carried inside the files is released under
|
| 165 |
-
the same terms. The femur geometry underlying the 3D-printed phantoms is itself
|
| 166 |
-
sourced from a CC BY 4.0–licensed bone model dataset.
|
| 167 |
|
| 168 |
## Intended Usage
|
| 169 |
|
| 170 |
-
Full-matrix-capture-style beamforming research on recovered (not directly sensed)
|
| 171 |
-
channel data at a bone-tissue interface: delay-and-sum reconstruction, adaptive or
|
| 172 |
-
aberration-correction beamforming benchmarking, robot/EM-tracked probe-pose fusion
|
| 173 |
-
research, and as a reference example for recovering pre-beamformed data from
|
| 174 |
-
beamformed-only ultrasound exports (e.g. other handheld/point-of-care scanners with
|
| 175 |
-
the same limitation).
|
| 176 |
|
| 177 |
## Dataset Characterization
|
| 178 |
|
| 179 |
-
- **Data Collection Method:** phantom (3D-printed, bone-mimicking femur, immersed in
|
| 180 |
-
|
| 181 |
-
|
| 182 |
-
inversion of the probe's beamformed RF output (not a direct per-element
|
| 183 |
-
recording); probe pose independently tracked via a trakSTAR EM tracking system,
|
| 184 |
-
fCal-calibrated.
|
| 185 |
-
- **Labeling Method:** a CT scan of each 3D-printed phantom and a multi-label
|
| 186 |
-
segmentation of it (authored in 3D Slicer) are carried **inside each of that
|
| 187 |
-
phantom's three files**, under `custom/ct/` and `custom/ct_segmentation/` — see
|
| 188 |
-
[CT reference imaging](#ct-reference-imaging). There are no annotations on the RF
|
| 189 |
-
data itself.
|
| 190 |
-
- **Acquisition system:** Clarius L20HD3, 192-element linear array, 0.130 mm pitch
|
| 191 |
-
(24.8 mm aperture), 10 MHz center frequency, 30 MHz sampling frequency, 1540 m/s
|
| 192 |
-
sound speed, ~5.1 cm imaging depth (1984–2016 axial samples depending on scan),
|
| 193 |
-
single fixed transmit focus at 25.3–25.8 mm (verified: `focus_distances` is
|
| 194 |
-
constant across all 192 transmits within each scan), 192 focused transmits per
|
| 195 |
-
frame (one per lateral scanline, no steering), walking sub-aperture per scanline —
|
| 196 |
-
Hanning-windowed, 47–97 of 192 elements active per transmit (mean ~84, i.e.
|
| 197 |
-
roughly a quarter to a half of the array, narrowest at the array edges).
|
| 198 |
|
| 199 |
-
|
| 200 |
|
| 201 |
-
|
| 202 |
-
**every one** of that phantom's three `zea` files, under `custom/ct/` and
|
| 203 |
-
`custom/ct_segmentation/`. They are not shipped as separate `.nrrd` sidecars, so no
|
| 204 |
-
file depends on another.
|
| 205 |
|
| 206 |
-
|
| 207 |
-
|---|---|
|
| 208 |
-
| `custom/ct/volume` | CT volume, `int16`, stored `(k, j, i)` (slice, row, column) |
|
| 209 |
-
| `custom/ct/spacing`, `origin`, `direction`, `affine` | Grid geometry in SI metres; `affine` maps voxel index `(i, j, k, 1)` to an LPS position |
|
| 210 |
-
| `custom/ct/nrrd_header` | Verbatim header of the source NRRD (distances in millimetres) |
|
| 211 |
-
| `custom/ct_segmentation/labelmap` | Layered binary labelmap on the same grid, `uint8` |
|
| 212 |
-
| `custom/ct_segmentation/segment_*` | Per-segment name, label value, layer, colour, bounding box and 3D Slicer ID |
|
| 213 |
|
| 214 |
-
|
| 215 |
|
| 216 |
-
|
| 217 |
-
|---|---|---|---|
|
| 218 |
-
| phantom1 | `512 × 512 × 594` | `(594, 512, 512)` | `0.546875 × 0.546875 × 0.6` |
|
| 219 |
-
| phantom2 | `512 × 512 × 574` | `(574, 512, 512)` | `0.50390625 × 0.50390625 × 0.6` |
|
| 220 |
-
| phantom3 | `512 × 512 × 594` | `(594, 512, 512)` | `0.5625 × 0.5625 × 0.6` |
|
| 221 |
|
| 222 |
-
|
| 223 |
-
|
| 224 |
-
|
| 225 |
-
`
|
| 226 |
-
the array as one flat labelmap:
|
| 227 |
|
| 228 |
-
|
| 229 |
-
|
| 230 |
-
|
| 231 |
-
|
| 232 |
-
|
| 233 |
-
|
| 234 |
-
|
| 235 |
-
|
| 236 |
-
|
| 237 |
-
|
| 238 |
-
|
| 239 |
|
| 240 |
-
The
|
| 241 |
-
**not spatially registered** to the RF frames or to the tracked probe poses; no
|
| 242 |
-
CT↔ultrasound registration is provided with this submission.
|
| 243 |
|
| 244 |
## Dataset Format
|
| 245 |
|
| 246 |
-
|
| 247 |
-
as nine HDF5 files in [`data/`](data/), blosc-compressed.
|
| 248 |
|
| 249 |
-
|
| 250 |
-
CGLS-inverting a `zea.inverse.DASOperator` built from the known acquisition
|
| 251 |
-
geometry. `t0_delays`, `tx_apodizations`, `focus_distances`, `transmit_origins`,
|
| 252 |
-
`polar_angles`, and `waveforms_two_way` are copied directly from the values that
|
| 253 |
-
inversion's DAS operator was built with — not re-derived or guessed. The source
|
| 254 |
-
`.npz` had no explicit `demodulation_frequency`; it was substituted with
|
| 255 |
-
`center_frequency` per the standard convention for RF (non-IQ) sources (verified:
|
| 256 |
-
`demodulation_frequency` = `center_frequency` = 10 MHz in every file).
|
| 257 |
|
| 258 |
-
|
| 259 |
-
from the trakSTAR tracking capture via a fixed fCal image-to-probe calibration,
|
| 260 |
-
resampled onto each `raw_data` frame's own acquisition time before conversion, and
|
| 261 |
-
packaged as a **per-frame indexed signal** (`metadata/probe_pose[i]` ↔
|
| 262 |
-
`raw_data[i]`).
|
| 263 |
|
| 264 |
-
|
| 265 |
-
out of the `.nrrd` files that previously shipped alongside the RF data, so that
|
| 266 |
-
every file is self-contained; the verbatim source NRRD headers are preserved with
|
| 267 |
-
them. Grid geometry is converted from the NRRD's millimetres to zea's SI metres.
|
| 268 |
|
| 269 |
-
|
| 270 |
-
|
|
|
|
| 271 |
|
| 272 |
### Fields
|
| 273 |
|
| 274 |
-
Every file has the same field structure; `n_frames` and `n_ax` vary per scan (see
|
| 275 |
-
[the nine scans](#the-nine-scans)).
|
| 276 |
|
| 277 |
| Field | Shape | dtype | Units | Description |
|
| 278 |
|---|---|---|---|---|
|
|
@@ -299,48 +159,102 @@ Every file has the same field structure; `n_frames` and `n_ax` vary per scan (se
|
|
| 299 |
| `custom.ct_segmentation.segment_label_values` | `(3,)` | uint8 | — | Label value of each segment within its own layer |
|
| 300 |
| `custom.ct_segmentation.segment_layers` | `(3,)` | uint8 | — | Index into the last axis of `labelmap` holding each segment |
|
| 301 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 302 |
## Dataset Quantification
|
| 303 |
|
| 304 |
**Current OpenH-RF release:** 9 HDF5 files; 200.75 GB (200,745,025,536 bytes) stored; root `zea_version` **0.1.6**. Sizes include all HDF5 contents and use decimal units (MB = 10^6 bytes, GB = 10^9 bytes, TB = 10^12 bytes), not decoded-array memory or original-source download sizes.
|
| 305 |
|
| 306 |
-
Nine acquisitions, one continuous sweep each;
|
| 307 |
-
|
| 308 |
-
|
| 309 |
-
|
|
| 310 |
-
|
|
| 311 |
-
| `
|
| 312 |
-
| `
|
| 313 |
-
| `
|
| 314 |
-
| `
|
| 315 |
-
| `
|
| 316 |
-
| `
|
| 317 |
-
| `
|
| 318 |
-
| `
|
| 319 |
-
| `phantom3_wholebone` | 159 | 159 | 1984 | 25.35 mm | 100 | 22,083,076,096 B (22.08 GB) |
|
| 320 |
|
| 321 |
## Subject Metadata
|
| 322 |
|
| 323 |
-
3D-printed, bone-mimicking musculoskeletal phantoms (
|
| 324 |
-
reflection targets); no human or animal subject. Scanned with a robot-mounted
|
| 325 |
-
Clarius L20HD3 linear array at 10 MHz / ~5.1 cm depth / single transmit focus.
|
| 326 |
|
| 327 |
## Data Validation
|
| 328 |
|
| 329 |
-
|
| 330 |
-
(structural) and `File.validate_spec()` (full dtype / shape / dimension consistency)
|
| 331 |
-
— and all nine report compliant, with `/data/raw_data` present and non-empty.
|
| 332 |
-
`reconstruct.py` runs end-to-end on every scan and is deterministic across runs; the
|
| 333 |
-
images in [`reference_bmodes/`](reference_bmodes/) are its output.
|
| 334 |
|
| 335 |
## Known Issues
|
| 336 |
-
- **
|
| 337 |
-
|
| 338 |
-
|
| 339 |
-
- **
|
| 340 |
-
poses in trakSTAR tracker space. Nothing in this submission relates the two.
|
| 341 |
-
- **CT intensity units are unverified.** The source NRRD headers record no unit. The
|
| 342 |
-
value range (−1024 … ~500) is consistent with Hounsfield units, but this has not
|
| 343 |
-
been confirmed by the contributor.
|
| 344 |
|
| 345 |
## Ethical Considerations
|
| 346 |
|
|
|
|
| 1 |
---
|
| 2 |
+
name: strasbourg-basel
|
| 3 |
+
pretty_name: "BoneSRF Robot-Tracked Fractured-Femur Phantom Dataset"
|
| 4 |
license: cc-by-4.0
|
| 5 |
task_categories:
|
| 6 |
- other
|
|
|
|
| 23 |
- n<1K
|
| 24 |
---
|
| 25 |
|
| 26 |
+
# BoneSRF
|
| 27 |
|
| 28 |
+
<p align="center">
|
| 29 |
+
<img src="assets/reference_bmode.png" alt="BoneSRF B-mode of phantom 2, whole-bone sweep" width="200">
|
| 30 |
+
</p>
|
|
|
|
|
|
|
| 31 |
|
| 32 |
+
*B-mode of a fractured-femur phantom, frame 45 of [`data/phantom2_wholebone.hdf5`](https://huggingface.co/datasets/nvidia/OpenH-RF/blob/main/strasbourg-basel/BoneSRF/data/phantom2_wholebone.hdf5), beamformed from the recovered channel data.*
|
|
|
|
|
|
|
|
|
|
|
|
|
| 33 |
|
| 34 |
## Dataset Description
|
| 35 |
|
| 36 |
+
<p align="center">
|
| 37 |
+
<img src="assets/bonesrf_logo.png" alt="BoneSRF" width="200">
|
| 38 |
+
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 39 |
|
| 40 |
+
**BoneSRF** (Bone Surface Reflection) is an ultrasound channel-data dataset for bone-surface and fracture-reflection research. It contains three 3D-printed, fractured femur phantoms, scanned with a handheld point-of-care probe, inverted back to pre-beamformed RF and packaged in the OpenH-RF `zea` format.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 41 |
|
| 42 |
+
Each phantom was swept three times (`distal`, `proximal`, `wholebone`), giving nine `zea` HDF5 files. Every scan is robot-tracked: the probe was mounted on a robotic arm and its pose recorded separately. Each file also carries that phantom's CT scan and multi-label segmentation.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 43 |
|
| 44 |
+
The channel data here is not a direct per-element sensor recording. A Clarius handheld probe does not expose its raw per-element channel data, only its own internally beamformed RF output. Every `raw_data` array is therefore a numerical estimate: the per-element channel data consistent with the probe's known per-scanline focused acquisition geometry (transmit delays, apodization, walking sub-aperture) that would reproduce the real Clarius output if beamformed the same way. It is recovered by a conjugate-gradient least-squares (CGLS) inversion of a zea `DASOperator` built from that geometry, using the real beamformed phantom scans as the inversion target.
|
|
|
|
|
|
|
| 45 |
|
| 46 |
+
This is phantom data, not simulated, clinical or in-vivo. It is intended for full-matrix-capture-style beamforming and image-reconstruction research at a bone-tissue interface, and as an example of recovering pre-beamformed data from beamformed-only ultrasound exports.
|
|
|
|
|
|
|
|
|
|
| 47 |
|
| 48 |
+
### How the data was generated
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 49 |
|
| 50 |
+
1. **Acquisition.** Each phantom was scanned with a Clarius L20HD3 linear array, producing the probe's own beamformed RF output. This is the physically acquired data, not simulated.
|
| 51 |
+
2. **Inversion.** The beamformed RF is inverted back into pre-beamformed, per-element channel data with [`das-inverse` (`clarius` branch)](https://github.com/sankethvedula/das-inverse/tree/clarius), a CGLS solver over a `zea.inverse.DASOperator` forward model of the probe's focused, walking-sub-aperture transmit sequence (`invert_clarius_beamformed.py`). The result is not sensor-captured, but numerically consistent with the real beamformed acquisition it was inverted from.
|
| 52 |
+
3. **Packaging.** The inverted channel data, transmit-sequence metadata, probe geometry, per-frame probe pose, and the phantom's CT + segmentation are written out as one `zea` HDF5 file per scan, matching the OpenH-RF format spec.
|
|
|
|
| 53 |
|
| 54 |
+
### Probe tracking
|
| 55 |
|
| 56 |
+
The probe was mounted on a robotic arm and its pose recorded separately by a trakSTAR electromagnetic tracking system with a fixed fCal image-to-probe calibration. The pose stream is stored per frame in each file's metadata (`metadata/probe_pose`: translation, rotation, timestamps), so `metadata/probe_pose[i]` corresponds to `raw_data[i]`. The raw tracking capture is not shipped, only the recovered, aligned pose stream.
|
|
|
|
| 57 |
|
| 58 |
+
### The three phantoms
|
|
|
|
|
|
|
|
|
|
|
|
|
| 59 |
|
| 60 |
+
Each phantom is a 3D-printed femur, modeled from a CC BY 4.0–licensed femur bone dataset, with a different simulated fracture pattern. Each printed femur is immersed in ultrasound-coupling gel and scanned by a robotic arm, which gives repeatable probe trajectories rather than a freehand scan. Each phantom is scanned three times, at three positions along the bone:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
|
| 62 |
+
- **`distal`**: a sweep over the distal region of the femur
|
| 63 |
+
- **`proximal`**: a sweep over the proximal region of the femur
|
| 64 |
+
- **`wholebone`**: a sweep covering the full length of the femur
|
|
|
|
| 65 |
|
| 66 |
## Dataset Contributor(s)
|
| 67 |
|
| 68 |
+
- Sidaty El Hadramy (IHU Strasbourg; Department of Biomedical Engineering, University of Basel)
|
| 69 |
+
- Philippe C. Cattin (IHU Strasbourg; Department of Biomedical Engineering, University of Basel)
|
| 70 |
+
- Juan Verde (IHU Strasbourg; Department of Biomedical Engineering, University of Basel)
|
| 71 |
|
| 72 |
## Dataset Creation Date
|
| 73 |
|
| 74 |
+
Clarius acquisitions: 19/06/2026 (`phantom1_distal`) and 25/06/2026 (`phantom1_proximal`). The other seven sweeps carry no recorded acquisition date, see [Known Issues](#known-issues). Converted to the `zea` format in 2026.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 75 |
|
| 76 |
## License / Terms of Use
|
| 77 |
|
| 78 |
+
[Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode.en). Retain attribution and identify modifications when reusing the data.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 79 |
|
| 80 |
## Intended Usage
|
| 81 |
|
| 82 |
+
Full-matrix-capture-style beamforming research on recovered (not directly sensed) channel data at a bone-tissue interface: delay-and-sum reconstruction, adaptive and aberration-correction beamforming benchmarks, and robot/EM-tracked probe-pose fusion. It also serves as a reference for recovering pre-beamformed data from other beamformed-only scanners.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 83 |
|
| 84 |
## Dataset Characterization
|
| 85 |
|
| 86 |
+
- **Data Collection Method:** phantom (3D-printed, bone-mimicking femur, immersed in ultrasound-coupling gel); scanned with a Clarius handheld-probe-class linear array mounted on and moved by a robotic arm; raw channel data recovered via CGLS inversion of the probe's beamformed RF output (not a direct per-element recording); probe pose independently tracked via a trakSTAR EM tracking system, fCal-calibrated.
|
| 87 |
+
- **Labeling Method:** a CT scan of each 3D-printed phantom and a multi-label segmentation of it (authored in 3D Slicer) are stored inside each of that phantom's three files, under `custom/ct/` and `custom/ct_segmentation/`. See [CT reference imaging](#ct-reference-imaging). There are no annotations on the RF data itself.
|
| 88 |
+
- **Acquisition system:** Clarius L20HD3, 192-element linear array, 0.130 mm pitch (24.8 mm aperture), 10 MHz center frequency, 30 MHz sampling frequency, 1540 m/s sound speed, ~5.1 cm imaging depth (1984–2016 axial samples depending on scan), single fixed transmit focus at 25.3–25.8 mm (`focus_distances` is constant across all 192 transmits within a scan), 192 focused transmits per frame (one per lateral scanline, no steering), Hanning-windowed walking sub-aperture per scanline with 47 to 97 of 192 elements active per transmit (mean 84, narrowest at the array edges).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 89 |
|
| 90 |
+
The CT and segmentation data inside the files are released under the same CC BY 4.0 terms as the channel data. The femur geometry behind the 3D-printed phantoms comes from a CC BY 4.0–licensed bone model dataset.
|
| 91 |
|
| 92 |
+
## Processing the Dataset
|
|
|
|
|
|
|
|
|
|
| 93 |
|
| 94 |
+
The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/strasbourg-basel/reconstruct.py) as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), together with the `pipeline.yaml` definition in this folder and the [zea library](https://github.com/tue-bmd/zea). The script streams the data from the Hugging Face Hub.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 95 |
|
| 96 |
+
The script loads the saved `zea.Pipeline` from `pipeline.yaml`, runs it on one frame of one scan, and writes `assets/<scan>.png`.
|
| 97 |
|
| 98 |
+
The constants at the top of the script select what is reconstructed:
|
|
|
|
|
|
|
|
|
|
|
|
|
| 99 |
|
| 100 |
+
- `SCAN`: the scan to reconstruct, as a local path or an `hf://` URI.
|
| 101 |
+
- `FRAME`: the frame to beamform. `None` uses that scan's reference frame, the one its reference image was rendered from.
|
| 102 |
+
- `DEVICE`: where to run, e.g. `"cpu"`, `"cuda:0"` or `"auto:1"`.
|
| 103 |
+
- `CT`: also plot the CT carried in the file, to `assets/ct_<scan>.png`.
|
|
|
|
| 104 |
|
| 105 |
+
These values reconstruct `phantom2_wholebone` at its reference frame (45) on the CPU:
|
| 106 |
+
|
| 107 |
+
```python
|
| 108 |
+
SCAN = "hf://nvidia/OpenH-RF/strasbourg-basel/BoneSRF/data/phantom2_wholebone.hdf5"
|
| 109 |
+
FRAME = None
|
| 110 |
+
DEVICE = "cpu"
|
| 111 |
+
```
|
| 112 |
+
|
| 113 |
+
and produce the B-mode image shown at the top of this card.
|
| 114 |
+
|
| 115 |
+
The pipeline is `cast` → `apply_window` → `beamform` (delay-and-sum with a per-transmit `pfield` weighting, since this is a per-scanline focused walking-sub-aperture acquisition rather than full synthetic aperture) → `keras.ops.abs` → axial-only Gaussian blur → `normalize` → `log_compress`. Display parameters (dynamic range, p-field settings) also come from `pipeline.yaml`; acquisition geometry comes from each file's own `scan` and `probe` groups.
|
| 116 |
|
| 117 |
+
The reconstruction does not use `zea.inverse`. That module is for the CGLS inversion that produced these files, not for reading them back. Runtime is about 30 s per frame on CPU. Each file is a full sweep of 20 to 25 GB, but only the requested frame is read.
|
|
|
|
|
|
|
| 118 |
|
| 119 |
## Dataset Format
|
| 120 |
|
| 121 |
+
[zea v0.1.6](https://github.com/tue-bmd/zea)
|
|
|
|
| 122 |
|
| 123 |
+
Submitted in the [`zea` file format](https://zea.readthedocs.io/en/openh-rf-latest/) as nine HDF5 files.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 124 |
|
| 125 |
+
The channel data was recovered from the probe's real, beamformed RF output by CGLS-inverting a `zea.inverse.DASOperator` built from the known acquisition geometry. `t0_delays`, `tx_apodizations`, `focus_distances`, `transmit_origins`, `polar_angles`, and `waveforms_two_way` are copied directly from the values that inversion's DAS operator was built with, not re-derived. The source `.npz` had no explicit `demodulation_frequency`; it was substituted with `center_frequency` per the standard convention for RF (non-IQ) sources.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 126 |
|
| 127 |
+
Probe pose (`metadata/probe_pose`: translation, rotation, timestamps) was recovered from the trakSTAR tracking capture via a fixed fCal image-to-probe calibration, resampled onto each `raw_data` frame's own acquisition time before conversion, and stored per frame, so `metadata/probe_pose[i]` corresponds to `raw_data[i]`.
|
|
|
|
|
|
|
|
|
|
| 128 |
|
| 129 |
+
CT and segmentation were copied verbatim out of the `.nrrd` files that previously shipped alongside the RF data, so that every file is self-contained; the source NRRD headers are preserved with them. Grid geometry is converted from the NRRD's millimetres to zea's SI metres.
|
| 130 |
+
|
| 131 |
+
Reading these files requires `h5py` built against HDF5 ≥ 2.0 (e.g. `h5py` ≥ 3.16), see [Known Issues](#known-issues).
|
| 132 |
|
| 133 |
### Fields
|
| 134 |
|
| 135 |
+
Every file has the same field structure; `n_frames` and `n_ax` vary per scan (see [Dataset Quantification](#dataset-quantification)).
|
|
|
|
| 136 |
|
| 137 |
| Field | Shape | dtype | Units | Description |
|
| 138 |
|---|---|---|---|---|
|
|
|
|
| 159 |
| `custom.ct_segmentation.segment_label_values` | `(3,)` | uint8 | — | Label value of each segment within its own layer |
|
| 160 |
| `custom.ct_segmentation.segment_layers` | `(3,)` | uint8 | — | Index into the last axis of `labelmap` holding each segment |
|
| 161 |
|
| 162 |
+
## Folder structure
|
| 163 |
+
|
| 164 |
+
```
|
| 165 |
+
BoneSRF/
|
| 166 |
+
├── README.md ← this file (dataset overview + data card for all nine scans)
|
| 167 |
+
├── LICENCE (CC BY 4.0)
|
| 168 |
+
├── pipeline.yaml (saved zea.Pipeline, shared by all nine scans)
|
| 169 |
+
├── reconstruct.py (runs pipeline.yaml on any scan, and plots its CT)
|
| 170 |
+
├── assets/
|
| 171 |
+
│ ├── reference_bmode.png (the B-mode shown below)
|
| 172 |
+
│ └── ct_<scan>.png (CT slices of the scan's phantom)
|
| 173 |
+
├── data/
|
| 174 |
+
│ ├── phantom1_distal.hdf5 (zea channel data + per-frame probe pose + CT)
|
| 175 |
+
│ ├── phantom1_proximal.hdf5
|
| 176 |
+
│ ├── phantom1_wholebone.hdf5
|
| 177 |
+
│ ├── phantom2_*.hdf5 (same three sweeps)
|
| 178 |
+
│ └── phantom3_*.hdf5 (same three sweeps)
|
| 179 |
+
└── reference_bmodes/
|
| 180 |
+
└── <scan>.png (one reference reconstruction per scan)
|
| 181 |
+
```
|
| 182 |
+
|
| 183 |
+
Every file in `data/` is self-contained: it holds the CGLS-recovered pre-beamformed channel data, the transmit-sequence and probe metadata needed to beamform it, the per-frame probe pose, and the CT and segmentation of the phantom it shows.
|
| 184 |
+
|
| 185 |
+
## CT reference imaging
|
| 186 |
+
|
| 187 |
+
Each phantom's CT scan and its multi-label 3D Slicer segmentation are stored inside all three of that phantom's `zea` files, under `custom/ct/` and `custom/ct_segmentation/`. They are not shipped as separate `.nrrd` sidecars, so no file depends on another.
|
| 188 |
+
|
| 189 |
+
<p align="center">
|
| 190 |
+
<img src="assets/ct_phantom2_wholebone.png" alt="CT slices of phantom2" width="800">
|
| 191 |
+
</p>
|
| 192 |
+
|
| 193 |
+
Three slices of phantom2's CT, written by `reconstruct.py` with `CT = True`, with the `BoneSRF-2_Complete` segment outlined in red. The printed femur is hollow, so it reads dark against the bright coupling gel, and the coronal view shows the fracture: the bone is in separate, displaced pieces.
|
| 194 |
+
|
| 195 |
+
| Dataset | Contents |
|
| 196 |
+
|---|---|
|
| 197 |
+
| `custom/ct/volume` | CT volume, `int16`, stored `(k, j, i)` (slice, row, column) |
|
| 198 |
+
| `custom/ct/spacing`, `origin`, `direction`, `affine` | Grid geometry in SI metres; `affine` maps voxel index `(i, j, k, 1)` to an LPS position |
|
| 199 |
+
| `custom/ct/nrrd_header` | Verbatim header of the source NRRD (distances in millimetres) |
|
| 200 |
+
| `custom/ct_segmentation/labelmap` | Layered binary labelmap on the same grid, `uint8` |
|
| 201 |
+
| `custom/ct_segmentation/segment_*` | Per-segment name, label value, layer, colour, bounding box and 3D Slicer ID |
|
| 202 |
+
|
| 203 |
+
Grid geometry differs per phantom:
|
| 204 |
+
|
| 205 |
+
| Phantom | CT grid | Stored array | Source spacing (mm) |
|
| 206 |
+
|---|---|---|---|
|
| 207 |
+
| phantom1 | `512 × 512 × 594` | `(594, 512, 512)` | `0.546875 × 0.546875 × 0.6` |
|
| 208 |
+
| phantom2 | `512 × 512 × 574` | `(574, 512, 512)` | `0.50390625 × 0.50390625 × 0.6` |
|
| 209 |
+
| phantom3 | `512 × 512 × 594` | `(594, 512, 512)` | `0.5625 × 0.5625 × 0.6` |
|
| 210 |
+
|
| 211 |
+
Each segmentation has three segments, one per RF sweep of that phantom. Label values repeat across layers, because 3D Slicer keeps segments on separate internal labelmap layers, so read a segment's mask as `labelmap[..., segment_layers[s]] == segment_label_values[s]` rather than treating the array as one flat labelmap:
|
| 212 |
+
|
| 213 |
+
| Segment | `segment_label_values` | `segment_layers` | Corresponds to |
|
| 214 |
+
|---|---|---|---|
|
| 215 |
+
| `BoneSRF-1_Proximal` | 1 | 0 | `phantom1_proximal` |
|
| 216 |
+
| `BoneSRF-1_Distal` | 2 | 0 | `phantom1_distal` |
|
| 217 |
+
| `BoneSRF-1_Complete` | 1 | 1 | `phantom1_wholebone` |
|
| 218 |
+
| `BoneSRF-2_Complete` | 1 | 0 | `phantom2_wholebone` |
|
| 219 |
+
| `BoneSRF-2_Distal` | 1 | 1 | `phantom2_distal` |
|
| 220 |
+
| `BoneSRF-2_Proximal` | 2 | 1 | `phantom2_proximal` |
|
| 221 |
+
| `BoneSRF-3_Proximal` | 2 | 0 | `phantom3_proximal` |
|
| 222 |
+
| `BoneSRF-3_Distal` | 3 | 0 | `phantom3_distal` |
|
| 223 |
+
| `BoneSRF-3_Complete` | 1 | 1 | `phantom3_wholebone` |
|
| 224 |
+
|
| 225 |
+
The CT is reference imaging of the physical phantom in scanner (LPS) space. It is not spatially registered to the RF frames or to the tracked probe poses; no CT-to-ultrasound registration is provided.
|
| 226 |
+
|
| 227 |
## Dataset Quantification
|
| 228 |
|
| 229 |
**Current OpenH-RF release:** 9 HDF5 files; 200.75 GB (200,745,025,536 bytes) stored; root `zea_version` **0.1.6**. Sizes include all HDF5 contents and use decimal units (MB = 10^6 bytes, GB = 10^9 bytes, TB = 10^12 bytes), not decoded-array memory or original-source download sizes.
|
| 230 |
|
| 231 |
+
Nine acquisitions, one continuous sweep each; 1,427 frames in total. No train / val / test split (each file is a single reference acquisition). Every scan has one tracked probe pose per frame.
|
| 232 |
+
|
| 233 |
+
| Scan | Frames | `n_ax` | Focus | Reference frame | Size on disk |
|
| 234 |
+
|---|---|---|---|---|---|
|
| 235 |
+
| `phantom1_distal` | 144 | 2016 | 25.70 mm | 130 | 20.53 GB |
|
| 236 |
+
| `phantom1_proximal` | 174 | 2000 | 25.55 mm | 100 | 24.49 GB |
|
| 237 |
+
| `phantom1_wholebone` | 158 | 1984 | 25.30 mm | 150 | 21.93 GB |
|
| 238 |
+
| `phantom2_distal` | 162 | 2000 | 25.65 mm | 40 | 22.80 GB |
|
| 239 |
+
| `phantom2_proximal` | 142 | 2016 | 25.75 mm | 40 | 20.24 GB |
|
| 240 |
+
| `phantom2_wholebone` | 155 | 2016 | 25.80 mm | 45 | 21.95 GB |
|
| 241 |
+
| `phantom3_distal` | 166 | 1984 | 25.30 mm | 100 | 23.04 GB |
|
| 242 |
+
| `phantom3_proximal` | 167 | 2016 | 25.80 mm | 0 | 23.67 GB |
|
| 243 |
+
| `phantom3_wholebone` | 159 | 1984 | 25.35 mm | 100 | 22.08 GB |
|
|
|
|
| 244 |
|
| 245 |
## Subject Metadata
|
| 246 |
|
| 247 |
+
3D-printed, bone-mimicking musculoskeletal phantoms (bone surface reflection targets); no human or animal subject. Scanned with a robot-mounted Clarius L20HD3 linear array at 10 MHz / ~5.1 cm depth / single transmit focus.
|
|
|
|
|
|
|
| 248 |
|
| 249 |
## Data Validation
|
| 250 |
|
| 251 |
+
All nine files pass the `zea` data spec, both `File.validate()` (structural) and `File.validate_spec()` (dtype, shape and dimension consistency). `reconstruct.py` runs end-to-end on every scan; the images in `reference_bmodes/` are its output.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 252 |
|
| 253 |
## Known Issues
|
| 254 |
+
- **Fracture patterns are not documented per phantom.** The location, type (transverse / oblique / comminuted / hairline) and displacement of each phantom's fracture are not recorded. The CT segmentation in each file is ground truth for the physical phantom geometry.
|
| 255 |
+
- **Acquisition dates are incomplete.** Only `phantom1_distal` (19/06/2026) and `phantom1_proximal` (25/06/2026) have a recorded original Clarius acquisition date; the other seven sweeps do not carry one in the file or in the source capture.
|
| 256 |
+
- **No CT-to-ultrasound registration.** The CT is in scanner LPS space and the probe poses in trakSTAR tracker space. Nothing here relates the two.
|
| 257 |
+
- **CT intensity units are unverified.** The source NRRD headers record no unit. The value range (−1024 to about 500) is consistent with Hounsfield units, but this has not been confirmed.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 258 |
|
| 259 |
## Ethical Considerations
|
| 260 |
|
strasbourg-basel/assets/bonesrf_logo.png
ADDED
|
Git LFS Details
|
strasbourg-basel/assets/ct_phantom2_proximal.png
ADDED
|
Git LFS Details
|
strasbourg-basel/assets/ct_phantom2_wholebone.png
ADDED
|
Git LFS Details
|
strasbourg-basel/assets/phantom2_proximal.png
ADDED
|
Git LFS Details
|
strasbourg-basel/assets/reference_bmode.png
ADDED
|
Git LFS Details
|