tristan-deep commited on
Commit
1ec09ff
·
verified ·
1 Parent(s): acf3947

strasbourg-basel: sync data card and figures with GitHub

Browse files

Syncs the strasbourg-basel card and figures on the Hub with the reviewed state on GitHub (open-h/OpenH-RF).

Adds the three figures the card shows: the BoneSRF logo, a reference B-mode, and the CT slices with the phantom segment outlined.

The card also had links that only worked in the GitHub checkout: `data/` now points at `BoneSRF/data/`, which is where the files live here; `LICENCE` was not a file in either repo, so the text links the CC BY 4.0 deed instead; and `reference_bmodes/` is generated output that is not checked in, so it is no longer a link.

Files changed: 4.

```
+ strasbourg-basel/assets/bonesrf_logo.png
+ strasbourg-basel/assets/ct_phantom2_wholebone.png
+ strasbourg-basel/assets/reference_bmode.png
~ strasbourg-basel/README.md
```

strasbourg-basel/README.md CHANGED
@@ -22,80 +22,75 @@ size_categories:
22
  - n<1K
23
  ---
24
 
25
- # BoneSRF — Robot-Tracked Fractured-Femur Phantom Channel Data
 
 
26
 
27
- **BoneSRF** (Bone Surface Reflection) is an ultrasound channel-data dataset built
28
- around a simple question: can pre-beamformed RF data recovered from a handheld,
29
- point-of-care scanner support bone-surface / fracture-reflection research? It
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
- Nine scans in total: each of the three phantoms was swept three times (`distal`,
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
- The channel data in this dataset is **not a direct per-element sensor recording**.
42
- A Clarius handheld probe does not expose its raw per-element channel data, only its
43
- own internally beamformed RF output. Every `raw_data` array here is therefore a
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
  ### How the data was generated
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 is a 3D-printed femur, modeled from a CC BY 4.0–licensed femur bone
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
- - **`distal`** — a sweep over the distal region of the femur
92
- - **`proximal`** — a sweep over the proximal region of the femur
93
- - **`wholebone`** — a sweep covering the full length of the femur
94
 
95
- **Fracture design:** `REQUIRES_CONTRIBUTOR` — the specific fracture pattern
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
  ## Folder structure
101
 
@@ -103,8 +98,11 @@ each file is ground truth for the physical phantom geometry in the meantime.
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
@@ -115,64 +113,77 @@ BoneSRF/
115
  └── <scan>.png (one reference reconstruction per scan)
116
  ```
117
 
118
- Every file in `data/` stands alone: it holds the (CGLS-recovered) pre-beamformed
119
- channel data, the full transmit-sequence and probe metadata needed to beamform it,
120
- the per-frame tracked probe pose, and the CT + segmentation of the phantom it
121
- depicts.
122
 
123
  ## Reconstructing a B-mode
124
 
125
- `reconstruct.py` loads the saved `zea.Pipeline` from `pipeline.yaml` and runs it on
126
- one frame of one scan:
127
 
128
  ```bash
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
  The pipeline is `cast` → `apply_window` → `beamform` (delay-and-sum with a
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
- This intentionally avoids `zea.inverse`: that module is for the CGLS inversion that
142
- *produced* these files, not for reconstructing from them. Runtime is ~30 s per frame
143
- on CPU. Each file is a full multi-frame sweep of 20.24 GB to 24.49 GB, but only the requested
144
- frame is read.
145
 
146
  ## Dataset Contributor(s)
147
 
148
- Sidaty El Hadramy, Philippe C. Cattin, Juan Verde — IHU Strasbourg and the
149
  Department of Biomedical Engineering, University of Basel.
150
 
151
  ## Dataset Creation Date
152
 
153
- Original Clarius acquisitions: 19/06/2026 (`phantom1_distal`) and 25/06/2026
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
- CC BY 4.0 — see [`LICENCE`](LICENCE). Confirmed by the contributor as cleared for
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
 
@@ -183,26 +194,35 @@ the same limitation).
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
  ## CT reference imaging
200
 
201
- Each phantom's CT scan and its multi-label 3D Slicer segmentation are carried inside
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
  | Dataset | Contents |
207
  |---|---|
208
  | `custom/ct/volume` | CT volume, `int16`, stored `(k, j, i)` (slice, row, column) |
@@ -219,9 +239,9 @@ Grid geometry differs per phantom:
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
- Each segmentation has three segments, corresponding directly to the three RF sweeps
223
- of that phantom. **Label values repeat across layers** — 3D Slicer keeps segments on
224
- separate internal labelmap layers — so read a segment's mask as
225
  `labelmap[..., segment_layers[s]] == segment_label_values[s]` rather than treating
226
  the array as one flat labelmap:
227
 
@@ -238,36 +258,34 @@ the array as one flat labelmap:
238
  | `BoneSRF-3_Complete` | 1 | 1 | `phantom3_wholebone` |
239
 
240
  The CT is reference imaging of the physical phantom in scanner (LPS) space. It is
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
  Submitted in the [`zea` file format](https://zea.readthedocs.io/en/openh-rf-latest/)
247
- as nine HDF5 files in [`data/`](data/), blosc-compressed.
248
 
249
  The channel data was recovered from the probe's real, beamformed RF output by
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
  Probe pose (`metadata/probe_pose`: translation, rotation, timestamps) was recovered
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
- CT and segmentation (an addition beyond the original proposal) were copied verbatim
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
- **Reading these files requires `h5py` built against HDF5 ≥ 2.0** (e.g. `h5py` ≥
270
- 3.16) — see [Known Issues](#known-issues).
271
 
272
  ### Fields
273
 
@@ -303,44 +321,48 @@ Every file has the same field structure; `n_frames` and `n_ax` vary per scan (se
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; 1428 frames in total, 200.75 GB of stored HDF5 data. No train / val / test split (each file is a single reference acquisition).
307
- Every value below was read back from the files themselves.
308
-
309
- | Scan | Frames | Poses | `n_ax` | Focus | Reference frame | Size on disk |
310
- |---|---|---|---|---|---|---|
311
- | `phantom1_distal` | 144 | 144 | 2016 | 25.70 mm | 130 | 20,534,067,200 B (20.53 GB) |
312
- | `phantom1_proximal` | 174 | 174 | 2000 | 25.55 mm | 100 | 24,492,900,352 B (24.49 GB) |
313
- | `phantom1_wholebone` | 158 | 158 | 1984 | 25.30 mm | 150 | 21,930,508,288 B (21.93 GB) |
314
- | `phantom2_distal` | 162 | 162 | 2000 | 25.65 mm | 40 | 22,799,908,864 B (22.80 GB) |
315
- | `phantom2_proximal` | 142 | 142 | 2016 | 25.75 mm | 40 | 20,236,337,152 B (20.24 GB) |
316
- | `phantom2_wholebone` | 155 | 155 | 2016 | 25.80 mm | 45 | 21,953,183,744 B (21.95 GB) |
317
- | `phantom3_distal` | 166 | 166 | 1984 | 25.30 mm | 100 | 23,042,916,352 B (23.04 GB) |
318
- | `phantom3_proximal` | 167 | 167 | 2016 | 25.80 mm | 0 | 23,672,127,488 B (23.67 GB) |
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 ("BoneSRF" — bone surface
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
- Every file was validated against the installed `zea` data spec — `File.validate()`
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
  - **Acquisition dates are incomplete.** Only `phantom1_distal` (19/06/2026) and
337
  `phantom1_proximal` (25/06/2026) have a recorded original Clarius acquisition date;
338
  the other seven sweeps do not carry one in the file or in the source capture.
339
- - **No CT↔ultrasound registration.** The CT lives in scanner LPS space and the probe
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
 
 
22
  - n<1K
23
  ---
24
 
25
+ <p align="center">
26
+ <img src="assets/bonesrf_logo.png" alt="BoneSRF" width="200">
27
+ </p>
28
 
29
+ # BoneSRF
 
 
 
 
30
 
31
+ **BoneSRF** (Bone Surface Reflection) is an ultrasound channel-data dataset for
32
+ bone-surface and fracture-reflection research. It contains three 3D-printed,
33
+ fractured femur phantoms, scanned with a handheld point-of-care probe, inverted back
34
+ to pre-beamformed RF and packaged in the OpenH-RF `zea` format.
35
+
36
+ Each phantom was swept three times (`distal`, `proximal`, `wholebone`), giving nine
37
+ `zea` HDF5 files in [`data/`](BoneSRF/data/). Every scan is robot-tracked: the probe was
38
+ mounted on a robotic arm and its pose recorded separately. Each file also carries
39
+ that phantom's CT scan and multi-label segmentation.
40
 
41
  ## Dataset Description
42
 
43
+ The channel data here is not a direct per-element sensor recording. A Clarius
44
+ handheld probe does not expose its raw per-element channel data, only its own
45
+ internally beamformed RF output. Every `raw_data` array is therefore a numerical
46
+ estimate: the per-element channel data consistent with the probe's known
47
  per-scanline focused acquisition geometry (transmit delays, apodization, walking
48
+ sub-aperture) that would reproduce the real Clarius output if beamformed the same
49
+ way. It is recovered by a conjugate-gradient least-squares (CGLS) inversion of a zea
50
+ `DASOperator` built from that geometry, using the real beamformed phantom scans as
51
+ the inversion target.
52
 
53
+ This is phantom data, not simulated, clinical or in-vivo. It is intended for
54
  full-matrix-capture-style beamforming and image-reconstruction research at a
55
+ bone-tissue interface, and as an example of recovering pre-beamformed data from
56
+ beamformed-only ultrasound exports.
57
 
58
  ### How the data was generated
59
 
60
+ 1. **Acquisition.** Each phantom was scanned with a Clarius L20HD3 linear array,
61
+ producing the probe's own beamformed RF output. This is the physically acquired
62
+ data, not simulated.
63
  2. **Inversion.** The beamformed RF is inverted back into pre-beamformed,
64
+ per-element channel data with
65
+ [`das-inverse` (`clarius` branch)](https://github.com/sankethvedula/das-inverse/tree/clarius),
66
+ a CGLS solver over a `zea.inverse.DASOperator` forward model of the probe's
67
  focused, walking-sub-aperture transmit sequence (`invert_clarius_beamformed.py`).
68
+ The result is not sensor-captured, but numerically consistent with the real
69
+ beamformed acquisition it was inverted from.
 
70
  3. **Packaging.** The inverted channel data, transmit-sequence metadata, probe
71
  geometry, per-frame probe pose, and the phantom's CT + segmentation are written
72
  out as one `zea` HDF5 file per scan, matching the OpenH-RF format spec.
73
 
74
  ### Probe tracking
75
 
76
+ The probe was mounted on a robotic arm and its pose recorded separately by a
77
+ trakSTAR electromagnetic tracking system with a fixed fCal image-to-probe
78
+ calibration. The pose stream is stored per frame in each file's metadata
79
+ (`metadata/probe_pose`: translation, rotation, timestamps), so
80
+ `metadata/probe_pose[i]` corresponds to `raw_data[i]`. The raw tracking capture is
81
+ not shipped, only the recovered, aligned pose stream.
 
82
 
83
  ### The three phantoms
84
 
85
  Each phantom is a 3D-printed femur, modeled from a CC BY 4.0–licensed femur bone
86
+ dataset, with a different simulated fracture pattern. Each printed femur is immersed
87
+ in ultrasound-coupling gel and scanned by a robotic arm, which gives repeatable
88
+ probe trajectories rather than a freehand scan. Each phantom is scanned three times,
89
+ at three positions along the bone:
 
 
 
 
90
 
91
+ - **`distal`**: a sweep over the distal region of the femur
92
+ - **`proximal`**: a sweep over the proximal region of the femur
93
+ - **`wholebone`**: a sweep covering the full length of the femur
 
94
 
95
  ## Folder structure
96
 
 
98
  BoneSRF/
99
  ├── README.md ← this file (dataset overview + data card for all nine scans)
100
  ├── LICENCE (CC BY 4.0)
101
+ ├── pipeline.yaml (saved zea.Pipeline, shared by all nine scans)
102
+ ├── reconstruct.py (runs pipeline.yaml on any scan, and plots its CT)
103
+ ├── assets/
104
+ │ ├── reference_bmode.png (the B-mode shown below)
105
+ │ └── ct_<scan>.png (CT slices of the scan's phantom)
106
  ├── data/
107
  │ ├── phantom1_distal.hdf5 (zea channel data + per-frame probe pose + CT)
108
  │ ├── phantom1_proximal.hdf5
 
113
  └── <scan>.png (one reference reconstruction per scan)
114
  ```
115
 
116
+ Every file in `data/` is self-contained: it holds the CGLS-recovered pre-beamformed
117
+ channel data, the transmit-sequence and probe metadata needed to beamform it, the
118
+ per-frame probe pose, and the CT and segmentation of the phantom it shows.
 
119
 
120
  ## Reconstructing a B-mode
121
 
122
+ `reconstruct.py` loads the saved `zea.Pipeline` from `pipeline.yaml`, runs it on one
123
+ frame of one scan, and writes `reference_bmodes/<scan>.png`:
124
 
125
  ```bash
126
+ python reconstruct.py
 
 
127
  ```
128
 
129
+ The constants at the top of the script select what is reconstructed:
130
+
131
+ - `SCAN`: the scan to reconstruct, as a local path or an `hf://` URI.
132
+ - `FRAME`: the frame to beamform. `None` uses that scan's reference frame, the one
133
+ its `reference_bmodes/<scan>.png` was rendered from.
134
+ - `DEVICE`: where to run, e.g. `"cpu"`, `"cuda:0"` or `"auto:1"`.
135
+ - `CT`: also plot the CT carried in the file, to `assets/ct_<scan>.png`.
136
+
137
+ These values reconstruct `phantom2_wholebone` at its reference frame (45) on the CPU:
138
+
139
+ ```python
140
+ SCAN = "hf://nvidia/OpenH-RF/strasbourg-basel/BoneSRF/data/phantom2_wholebone.hdf5"
141
+ FRAME = None
142
+ DEVICE = "cpu"
143
+ ```
144
+
145
+ and produce the following B-mode image:
146
+
147
+ <p align="center">
148
+ <img src="assets/reference_bmode.png" alt="BoneSRF" width="200">
149
+ </p>
150
+
151
  The pipeline is `cast` → `apply_window` → `beamform` (delay-and-sum with a
152
+ per-transmit `pfield` weighting, since this is a per-scanline focused
153
+ walking-sub-aperture acquisition rather than full synthetic aperture) →
154
+ `keras.ops.abs` → axial-only Gaussian blur → `normalize` → `log_compress`. Display
155
+ parameters (dynamic range, p-field settings) also come from `pipeline.yaml`;
156
+ acquisition geometry comes from each file's own `scan` and `probe` groups.
157
 
158
+ The reconstruction does not use `zea.inverse`. That module is for the CGLS inversion
159
+ that produced these files, not for reading them back. Runtime is about 30 s per
160
+ frame on CPU. Each file is a full sweep of 20 to 25 GB, but only the requested frame
161
+ is read.
162
 
163
  ## Dataset Contributor(s)
164
 
165
+ Sidaty El Hadramy, Philippe C. Cattin, Juan Verde. IHU Strasbourg and the
166
  Department of Biomedical Engineering, University of Basel.
167
 
168
  ## Dataset Creation Date
169
 
170
+ Clarius acquisitions: 19/06/2026 (`phantom1_distal`) and 25/06/2026
171
+ (`phantom1_proximal`). The other seven sweeps carry no recorded acquisition date,
172
+ see [Known Issues](#known-issues). Converted to the `zea` format in 2026.
 
 
 
173
 
174
  ## License / Terms of Use
175
 
176
+ CC BY 4.0, see [the licence deed](https://creativecommons.org/licenses/by/4.0/). The CT and segmentation data inside the files
177
+ is released under the same terms. The femur geometry behind the 3D-printed phantoms
178
+ comes from a CC BY 4.0–licensed bone model dataset.
 
 
179
 
180
  ## Intended Usage
181
 
182
  Full-matrix-capture-style beamforming research on recovered (not directly sensed)
183
+ channel data at a bone-tissue interface: delay-and-sum reconstruction, adaptive and
184
+ aberration-correction beamforming benchmarks, and robot/EM-tracked probe-pose fusion.
185
+ It also serves as a reference for recovering pre-beamformed data from other
186
+ beamformed-only scanners.
 
187
 
188
  ## Dataset Characterization
189
 
 
194
  recording); probe pose independently tracked via a trakSTAR EM tracking system,
195
  fCal-calibrated.
196
  - **Labeling Method:** a CT scan of each 3D-printed phantom and a multi-label
197
+ segmentation of it (authored in 3D Slicer) are stored inside each of that
198
+ phantom's three files, under `custom/ct/` and `custom/ct_segmentation/`. See
199
  [CT reference imaging](#ct-reference-imaging). There are no annotations on the RF
200
  data itself.
201
  - **Acquisition system:** Clarius L20HD3, 192-element linear array, 0.130 mm pitch
202
  (24.8 mm aperture), 10 MHz center frequency, 30 MHz sampling frequency, 1540 m/s
203
  sound speed, ~5.1 cm imaging depth (1984–2016 axial samples depending on scan),
204
+ single fixed transmit focus at 25.3–25.8 mm (`focus_distances` is constant across
205
+ all 192 transmits within a scan), 192 focused transmits per frame (one per lateral
206
+ scanline, no steering), Hanning-windowed walking sub-aperture per scanline with
207
+ 47 to 97 of 192 elements active per transmit (mean 84, narrowest at the array
208
+ edges).
209
 
210
  ## CT reference imaging
211
 
212
+ Each phantom's CT scan and its multi-label 3D Slicer segmentation are stored inside
213
+ all three of that phantom's `zea` files, under `custom/ct/` and
214
  `custom/ct_segmentation/`. They are not shipped as separate `.nrrd` sidecars, so no
215
  file depends on another.
216
 
217
+ <p align="center">
218
+ <img src="assets/ct_phantom2_wholebone.png" alt="CT slices of phantom2" width="800">
219
+ </p>
220
+
221
+ Three slices of phantom2's CT, written by `reconstruct.py` with `CT = True`, with
222
+ the `BoneSRF-2_Complete` segment outlined in red. The printed femur is hollow, so it
223
+ reads dark against the bright coupling gel, and the coronal view shows the fracture:
224
+ the bone is in separate, displaced pieces.
225
+
226
  | Dataset | Contents |
227
  |---|---|
228
  | `custom/ct/volume` | CT volume, `int16`, stored `(k, j, i)` (slice, row, column) |
 
239
  | phantom2 | `512 × 512 × 574` | `(574, 512, 512)` | `0.50390625 × 0.50390625 × 0.6` |
240
  | phantom3 | `512 × 512 × 594` | `(594, 512, 512)` | `0.5625 × 0.5625 × 0.6` |
241
 
242
+ Each segmentation has three segments, one per RF sweep of that phantom. Label values
243
+ repeat across layers, because 3D Slicer keeps segments on separate internal labelmap
244
+ layers, so read a segment's mask as
245
  `labelmap[..., segment_layers[s]] == segment_label_values[s]` rather than treating
246
  the array as one flat labelmap:
247
 
 
258
  | `BoneSRF-3_Complete` | 1 | 1 | `phantom3_wholebone` |
259
 
260
  The CT is reference imaging of the physical phantom in scanner (LPS) space. It is
261
+ not spatially registered to the RF frames or to the tracked probe poses; no
262
+ CT-to-ultrasound registration is provided.
263
 
264
  ## Dataset Format
265
 
266
  Submitted in the [`zea` file format](https://zea.readthedocs.io/en/openh-rf-latest/)
267
+ as nine HDF5 files in [`data/`](BoneSRF/data/), blosc-compressed.
268
 
269
  The channel data was recovered from the probe's real, beamformed RF output by
270
  CGLS-inverting a `zea.inverse.DASOperator` built from the known acquisition
271
  geometry. `t0_delays`, `tx_apodizations`, `focus_distances`, `transmit_origins`,
272
  `polar_angles`, and `waveforms_two_way` are copied directly from the values that
273
+ inversion's DAS operator was built with, not re-derived. The source
274
  `.npz` had no explicit `demodulation_frequency`; it was substituted with
275
+ `center_frequency` per the standard convention for RF (non-IQ) sources.
 
276
 
277
  Probe pose (`metadata/probe_pose`: translation, rotation, timestamps) was recovered
278
  from the trakSTAR tracking capture via a fixed fCal image-to-probe calibration,
279
  resampled onto each `raw_data` frame's own acquisition time before conversion, and
280
+ stored per frame, so `metadata/probe_pose[i]` corresponds to `raw_data[i]`.
 
281
 
282
+ CT and segmentation were copied verbatim out of the `.nrrd` files that previously
283
+ shipped alongside the RF data, so that every file is self-contained; the source NRRD
284
+ headers are preserved with them. Grid geometry is converted from the NRRD's
285
+ millimetres to zea's SI metres.
286
 
287
+ Reading these files requires `h5py` built against HDF5 ≥ 2.0 (e.g. `h5py` ≥ 3.16),
288
+ see [Known Issues](#known-issues).
289
 
290
  ### Fields
291
 
 
321
 
322
  **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.
323
 
324
+ Nine acquisitions, one continuous sweep each; 1,427 frames in total. No train / val /
325
+ test split (each file is a single reference acquisition). Every scan has one tracked
326
+ probe pose per frame.
327
+
328
+ | Scan | Frames | `n_ax` | Focus | Reference frame | Size on disk |
329
+ |---|---|---|---|---|---|
330
+ | `phantom1_distal` | 144 | 2016 | 25.70 mm | 130 | 20.53 GB |
331
+ | `phantom1_proximal` | 174 | 2000 | 25.55 mm | 100 | 24.49 GB |
332
+ | `phantom1_wholebone` | 158 | 1984 | 25.30 mm | 150 | 21.93 GB |
333
+ | `phantom2_distal` | 162 | 2000 | 25.65 mm | 40 | 22.80 GB |
334
+ | `phantom2_proximal` | 142 | 2016 | 25.75 mm | 40 | 20.24 GB |
335
+ | `phantom2_wholebone` | 155 | 2016 | 25.80 mm | 45 | 21.95 GB |
336
+ | `phantom3_distal` | 166 | 1984 | 25.30 mm | 100 | 23.04 GB |
337
+ | `phantom3_proximal` | 167 | 2016 | 25.80 mm | 0 | 23.67 GB |
338
+ | `phantom3_wholebone` | 159 | 1984 | 25.35 mm | 100 | 22.08 GB |
339
 
340
  ## Subject Metadata
341
 
342
+ 3D-printed, bone-mimicking musculoskeletal phantoms (bone surface reflection
343
+ targets); no human or animal subject. Scanned with a robot-mounted
344
  Clarius L20HD3 linear array at 10 MHz / ~5.1 cm depth / single transmit focus.
345
 
346
  ## Data Validation
347
 
348
+ All nine files pass the `zea` data spec, both `File.validate()` (structural) and
349
+ `File.validate_spec()` (dtype, shape and dimension consistency). `reconstruct.py`
350
+ runs end-to-end on every scan; the images in
351
+ `reference_bmodes/` are its output.
 
352
 
353
  ## Known Issues
354
+ - **Fracture patterns are not documented per phantom.** The location, type
355
+ (transverse / oblique / comminuted / hairline) and displacement of each phantom's
356
+ fracture are not recorded. The CT segmentation in each file is ground truth for
357
+ the physical phantom geometry.
358
  - **Acquisition dates are incomplete.** Only `phantom1_distal` (19/06/2026) and
359
  `phantom1_proximal` (25/06/2026) have a recorded original Clarius acquisition date;
360
  the other seven sweeps do not carry one in the file or in the source capture.
361
+ - **No CT-to-ultrasound registration.** The CT is in scanner LPS space and the probe
362
+ poses in trakSTAR tracker space. Nothing here relates the two.
363
  - **CT intensity units are unverified.** The source NRRD headers record no unit. The
364
+ value range (−1024 to about 500) is consistent with Hounsfield units, but this has
365
+ not been confirmed.
366
 
367
  ## Ethical Considerations
368
 
strasbourg-basel/assets/bonesrf_logo.png ADDED

Git LFS Details

  • SHA256: 65b2a65877c1d698142f8d3f4c025026c188ae91875b18ae68e2f91be312c3d5
  • Pointer size: 132 Bytes
  • Size of remote file: 1.47 MB
strasbourg-basel/assets/ct_phantom2_wholebone.png ADDED

Git LFS Details

  • SHA256: d10a71a80294d20f9deb3f85a6cdfa172dd9c95f6f3446c4f895f29f78186081
  • Pointer size: 131 Bytes
  • Size of remote file: 419 kB
strasbourg-basel/assets/reference_bmode.png ADDED

Git LFS Details

  • SHA256: f6f8c5cdab6581e66c465cf2cc99afc95168c9de42c303bf455e03f82e843a90
  • Pointer size: 130 Bytes
  • Size of remote file: 33.3 kB