wpi: sync data card and figures with GitHub

#63
wpi/README.md CHANGED
@@ -1,5 +1,6 @@
1
  ---
2
- pretty_name: "OpenH-RF — eSAF Rotational 3D US Raw Channel Data (Medical FUSION Lab, WPI)"
 
3
  license: cc-by-4.0
4
  task_categories:
5
  - image-to-image
@@ -16,111 +17,50 @@ size_categories:
16
  - n<1K
17
  ---
18
 
19
- # OpenH-RF Sub-Dataset — Rotational 3D US Raw Channel Data for Elevational SAF (Simulated + Measured Phantom)
 
 
 
 
20
 
21
  ## Dataset Description
22
- Synthetic rotational 3D ultrasound acquisitions of point, pair, and off-axis targets, captured
23
- with an **elevation-focused 1D linear array** that is rotated 180° about its axial
24
- axis (1° steps, 180 frames). Each acquisition stores the **raw per-element channel
25
- RF** for a single normal plane-wave transmit at every rotation angle — i.e. the data
26
- *before* in-plane beamforming — which is what enables flexible offline beamforming and
27
- the **elevational Synthetic Aperture Focusing (eSAF)** method. The targets span a wide
28
- depth range to capture the depth-dependent elevational beam thickness (the artifact
29
- eSAF corrects). The release is **mostly simulated (Field II)**, complemented by a
30
- small set of **real measured phantom** rotational scans acquired with the physical
31
- Japan Probe 68-element array (same geometry as the simulation) over a shallow-to-focal
32
- depth series (10–45 mm). **Simulated + measured phantom** data (no in-vivo / subjects).
33
 
34
  ## Dataset Contributor(s)
35
- Medical FUSION Laboratory, Worcester Polytechnic Institute. Contact: Ryo Murakami.
 
 
36
 
37
  ## Dataset Creation Date
38
- 06/15/2026.
 
39
 
40
  ## License / Terms of Use
41
- CC BY 4.0 (full text in `LICENSE`). The release contains **simulated (Field II) and
42
- real measured phantom** rotational scans — inanimate phantom only, so there are no
43
- IP, subject-consent, or IRB constraints.
44
 
45
- **Citation.** When using this dataset, please cite:
46
- > R. Murakami et al., "Elevational Synthetic Aperture Focusing for Rotated
47
- > Array-Based Three-Dimensional Ultrasound Imaging," IEEE Access, 2025.
48
 
49
  ## Intended Usage
50
- Advanced beamforming and **elevational resolution recovery** for rotational 3D US
51
- (eSAF), elevation-PSF / aperture-growth studies, and as a reproducible raw-channel-data
52
- benchmark for rotational synthetic-aperture reconstruction.
53
 
54
  ## Dataset Characterization
55
- - **Data Collection Method:** synthetic, generated with **Field II** (Jensen) run in
56
- **MATLAB**. The main release is a **probe × target grid** produced by
57
- `sim/batch_sim_probe_target.m` (source) (with `sim/sim_probe_catalog.m` /
58
- `sim/sim_target_catalog.m`, source): for each (probe type, target) it uses `xdc_focused_array`
59
- + `calc_scat_multi` to produce the raw per-element channel RF at every rotation angle
60
- (scatterer rotated about the axial axis, transducer fixed), then `sim/sim_dataset_to_zea.py`
61
- (source) repackages every case into the zea format here. **10 probe types** span lateral aperture
62
- (`n_el` 32/68/128, pitch 0.1/0.2/0.3 mm), elevation height `H` (4/8/12 mm), and elevation
63
- focal depth `R` (25/45/90 mm + unfocused) — see the probe table in `data/manifest.json`.
64
- (The earlier 18-acquisition set generated by `sim/batch_generate_fieldii.m` +
65
- `sim/mat_to_zea.py` (source) remains available as a compatible alternative with the
66
- identical schema.)
67
- **Measured phantom acquisitions (5):** real rotational scans of the physical Japan
68
- Probe 68-element array on a wire/point phantom, acquired with CPWC channel-RF capture
69
- (`experiment/Ryo_SetUp_JP68_PWCompound_3D_ChannelRF.m`, source) and a Galil-controlled 180°
70
- rotation. Each scan is time-tag-synced (frames → motor angles) and reduced to the
71
- **single centre (normal) plane wave per angle** by `experiment/sync_channel_rf.m` (source)
72
- (so the schema matches the simulation, n_tx = 1), then converted with the same
73
- `sim/sim_dataset_to_zea.py` (source). They span a shallow-to-focal depth series (10, 20, 30,
74
- 40, 45 mm nominal target depth).
75
- - **Labeling Method:** synthetic ground truth (exact target positions known; in
76
- `data/manifest.json`).
77
- - **Acquisition system (simulated):** Japan Probe JP_Linear_68 — 68-element linear
78
- array, pitch 0.2 mm, element width 0.15 mm, element height 8 mm, **elevational lens
79
- focus 45 mm** (Field II `xdc_focused_array` with 500 elevation math sub-elements);
80
- center frequency 10 MHz; sampling 40 MHz (NS200BW, 4 samples/wavelength); speed of
81
- sound 1490 m/s; single normal plane-wave transmit per rotation angle; 180° rotation,
82
- 1° step (180 frames). Parameters match the paper simulation.
83
 
84
- ## Dataset Format
85
- zea file format (HDF5), one file per acquisition, **single track**: the raw
86
- channel RF + scan parameters live in the standard data/scan groups
87
- (`tracks/track_0` on disk), and the paired eSAF label volume is stored as a
88
- **zea custom field** in the `custom` group (`custom/saf_bmode`, read via
89
- `zea.File.custom` — see below). The fused SAF volume is a single frame, so it
90
- cannot share the data group with the ~180-frame `raw_data` (zea validates
91
- `n_frames` across all fields of a data group); the `custom` group is the zea
92
- mechanism for exactly such data, and keeping the file single-track avoids the
93
- `track_schedule` warning a multi-track file would print on every load.
94
- Pre-processing — *simulated:* none
95
- beyond the forward model (raw RF, not demodulated/decimated); *measured:* time-tag
96
- frame→angle synchronisation, per-angle dwell averaging, and centre-plane-wave selection
97
- (still raw per-element RF, not demodulated/decimated; `scan/demodulation_frequency`
98
- records the 10 MHz demodulation applied by the reference pipeline). The probe
99
- rotation per frame is stored as the zea **`metadata/probe_pose`** trajectory
100
- (`rotation_representation="euler_xyz"`, **radians**; the array rotates about its
101
- axial axis, so the angle is the z Euler component and the translation is zero).
102
- Note `probe_pose/sampling_frequency = 1.0 Hz` is a **nominal** one-pose-per-frame
103
- value, not a physical acquisition rate. Every file is
104
- written with `zea.File.create()` (`sim/sim_dataset_to_zea.py` +
105
- `sim/pack_saf_labels.py`, source) and carries a
106
- `zea_version` stamp, so zea loads it natively (not as a legacy file).
107
-
108
- **Paired pre-/post-SAF labels (the dataset's target output).** Each file also carries
109
- the **elevational-SAF reconstructed 3D B-mode volume** as the custom field
110
- **`custom/saf_bmode`**: `values` is `(1, z, x, y)` float32 in **dB** (log-compressed
111
- normalized envelope, 0 dB = volume max, empty pixels −inf) and `coordinates` holds
112
- the per-pixel `[x, y, z]` positions in **meters**, shape `(z, x, y, 3)`; both carry
113
- `description`/`unit` attributes. This is
114
- the *post*-SAF **output/label** paired with the *pre*-beamformed **input**
115
- (`data/raw_data`):
116
- the raw channel RF is back-projected through the published eSAF algorithm
117
- (`matlab/saf/safrot_backproj.m`, source: in-plane DAS → `recon_3d` → `safrot_backproj`,
118
- elevational focus 45 mm, f-number 45/8) into a 3D volume `B_SAF(x,y,z)`, generated by
119
- `sim/make_saf_all.m` → `experiment/run_esaf_synced.m` (source) and written into the zea
120
- file by `sim/pack_saf_labels.py` (source). The stored volume covers
121
- a thin depth window (±2 mm) about the target; per-case arc-FWHM before/after and gain
122
- are in `data/manifest.json` and in the `description` attribute of
123
- `custom/saf_bmode/values`. Read it with `zea.File`:
124
 
125
  ```python
126
  with zea.File("data/baseline_R45_H8__point_z080_r4.hdf5") as f:
@@ -130,46 +70,31 @@ with zea.File("data/baseline_R45_H8__point_z080_r4.hdf5") as f:
130
  print(saf["values"].description) # axes + eSAF parameters + arc-FWHM
131
  ```
132
 
133
- A **MATLAB `.mat` version** of the same raw channel data + metadata, plus a
134
- **reference eSAF-beamformed** result and a `_ref.png` figure, is provided **per
135
- acquisition** alongside the source grid as `sim_dataset_out/<probe>/<target>.mat`
136
- and `..._ref.png` (each `.mat` holds the raw RF, the in-plane DAS, the metadata and
137
- the eSAF output produced with the published algorithm `matlab/saf/safrot_backproj.m`
138
- (source): in-plane DAS → `recon_3d` → `safrot_backproj`, f-number 45/8). A FWHM-vs-depth
139
- overview across probes is `sim_dataset_out/dataset_overview_r4.png`
140
- (`sim/dataset_overview.m`, source). The zea `.hdf5` acquisitions are **hosted on Hugging
141
- Face** at <https://huggingface.co/datasets/RyoMurakami/OpenH-RF-eSAF> (git-LFS).
142
- The MATLAB `.mat`/`_ref.png` intermediates are
143
- reproducible from source and kept on lab storage.
144
 
145
  ## Dataset Quantification
146
 
147
  **Current OpenH-RF release:** 195 HDF5 files; 1.87 GB (1,870,462,976 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.
148
 
149
  - **Acquisitions:** **195** = **190 simulated** + **5 measured phantom**.
150
- - *Simulated (190):* **10 probe types × 19 targets** (16 single points over depth
151
- {20,45,80,130} mm × radial offset from the rotation centre {0,2,4,6} mm, plus 3
152
- pair/oblique cases). The probe and target axes are listed in `data/manifest.json`. (The
153
- earlier compatible set has 18 acquisitions.)
154
- - *Measured (5):* real rotational phantom scans at nominal depths {10,20,30,40,45} mm
155
- (`experiment__acq_exp_*.hdf5`), centre plane wave, ~182 measured rotation angles
156
- over ~180°.
157
- - **Frames per acquisition:** simulated 180 (one per 1° step); measured ~182 (the
158
- actual encoder angles are stored in `metadata/probe_pose` — z Euler component,
159
- radians — not necessarily uniform).
160
  - **Stored HDF5 size:** 1.87 GB (1,870,462,976 bytes), including the paired `saf_bmode` label volumes.
161
- - **Train/val/test split:** N/A (benchmark / characterization set; the probe × depth ×
162
- radius axes are the intended study dimensions).
163
 
164
  ### Per-sample feature table
165
- Shapes use placeholders because dimensions vary across the probe grid and between
166
- simulated and measured scans: **`n_frames`** = 180 (simulated, one per 1° step) or
167
- ~182 (measured encoder angles); **`n_el`** ∈ {32, 68, 128} (probe grid; 68 for the
168
- baseline and all measured scans); **`n_ax`** = axial sample count (per case);
169
- **`n_z`** = depth samples of the label volume (target ± ~2 mm window).
170
 
171
- Paths below are inside each `.hdf5`; with `zea.File` use `f.data` / `f.scan` /
172
- `f.metadata.probe_pose`, and `f.custom` for the SAF label volume.
173
 
174
  | field (HDF5 path) | shape | dtype | units | description |
175
  |-----------------------------------|--------------------------------|---------|-------|-------------|
@@ -191,74 +116,38 @@ Paths below are inside each `.hdf5`; with `zea.File` use `f.data` / `f.scan` /
191
  | `custom/saf_bmode/coordinates` | (n_z, n_el, n_el, 3) | float32 | m | per-pixel `[x, y, z]` positions of the label volume (target ± ~2 mm depth window) |
192
 
193
  ## Subject Metadata
194
- No human or animal subjects / no PHI. Each file stores `metadata/subject/type`:
195
- `simulated phantom` for the Field II simulations, `phantom` for the measured
196
- `experiment__*` scans. Creator attribution is stored per file in `metadata/credit`.
197
 
198
  ## Data Validation
199
- `reconstruct.py` (**runnable, verified** — official `zea` API, no fallback code)
200
- loads one zea acquisition, reads its acquisition parameters via
201
- `zea.Config.from_path('pipeline.yaml')` + `File.load_parameters`, beamforms the
202
- rotation frame closest to ±90° rotation magnitude (the frame where an off-axis target
203
- lies in-plane; this handles signed encoder angles too — measured scans run 0 → ~−180°)
204
- with the native `zea.Pipeline` op chain **Cast → Demodulate → Beamform(delay_and_sum) →
205
- EnvelopeDetect → Normalize → LogCompress** defined in `pipeline.yaml`, and writes a
206
- two-panel PNG: the B-mode image, and the per-frame probe **rotation angle**
207
- (from `metadata/probe_pose`, plotted in degrees) so downstream users know how to
208
- interpret the frame axis — the special data this dataset adds:
209
- ```
210
- python reconstruct.py --input data/baseline_R45_H8__point_z080_r4.hdf5 --output out.png
211
- ```
212
- The rotational **eSAF** across frames — the contribution of this dataset — is implemented in
213
- `matlab/saf` (source) (`recon_3d` → `safrot_backproj`); per-probe before/after eSAF reference
214
- images and a FWHM-vs-depth overview accompany the MATLAB `.mat` release
215
- (`sim/dataset_overview.m`, source), and the resulting paired SAF volume is stored as
216
- the `custom/saf_bmode` custom field of every `.hdf5` (see Dataset Format above).
217
 
218
  ## Known Issues
219
- - **Paired SAF label — on-axis targets (r0 = 0) do not narrow, by design.** eSAF
220
- refocuses the *rotational elevation smear*; a target sitting on the rotation axis has
221
- essentially no smear, so its `saf_bmode` label volume is not sharper than the input (arc-FWHM
222
- gain ≈ 1). This is expected physics, not a defect — the 40 on-axis cases (median gain
223
- 1.00×) are included so the pair covers the degenerate no-smear case. Off-axis targets
224
- (n=120, median gain 1.75×, up to ~12×) and paired/oblique targets (n=30, median 3.71×)
225
- improve clearly; targets at the focal depth (~45 mm) and weak-elevation-focus probes
226
- (`efocus_deep_90`, `elev_unfocused`) have less smear to recover. Across all 195 cases,
227
- median arc-FWHM gain is 1.36× (42 cases < 1×, mostly the on-axis/near-focus group above).
228
- Arc-FWHM is measured on a **centred** reconstruction: the smear circle passes through both
229
- the rotation axis and the target (not a circle centred on the rotation axis). The eSAF
230
- back-projection uses a fixed elevational focus of 45 mm; per-depth focus tuning (see
231
- `docs/eSAF_focus_depth_study_JP.md`, source) can further sharpen deep off-axis cases but was
232
- not applied here (single as-designed focus).
233
- - **Measured phantom depth window.** The real reflector bead sits **~4 mm off the rotation
234
- axis** (not on-axis) and, for each scan, slightly deeper than the folder's nominal depth
235
- label; labels are reconstructed over the interactively-identified reflector depth window
236
- (not a naive nominal-depth ± 2 mm window), which matters because a mis-centred window can
237
- pick up near-axis clutter instead of the actual bead.
238
- - **Simulated** data (Field II spatial-impulse-response model): realistic transducer
239
- field, but no tissue attenuation, aberration, multiple scattering, or electronic
240
- noise. Not a substitute for measured data.
241
  - Speed of sound is 1490 m/s, matching the paper Table 1 and the experiment.
242
- - A single normal plane-wave transmit per rotation angle is simulated (the dataset
243
- stores n_tx = 1); multi-angle compounding is left to downstream users.
244
- - **Measured scans:** acquired as 7-angle CPWC; only the **centre (0°) plane wave** is
245
- kept here to match the n_tx = 1 schema. The dwell frames per angle are averaged before
246
- storage (noise reduction). Real reflectors are not ideal point scatterers — expect
247
- reverberation/clutter near the surface and specular layering; rotation angles are the
248
- measured encoder values (slightly non-uniform, full span ≈ 180°, sign per encoder
249
- direction). The elevational lens focus is the nominal 45 mm, but the effective
250
- back-projection focus for eSAF is depth-dependent on real data (see
251
- `docs/eSAF_focus_depth_study_JP.md`, source).
252
 
253
  ## Raw Source Data
254
- The raw, pre-conversion acquisition/simulation outputs that were processed into the
255
- zea `.hdf5` files above are archived (same CC BY 4.0 license) at
256
- <https://huggingface.co/datasets/RyoMurakami/OpenH-RF-eSAF-raw>: the raw Verasonics
257
- per-line channel-RF captures (`RFdata_line*.mat` + encoder logs) for the 5 measured
258
- acquisitions, and the per-case MATLAB intermediates (raw RF, in-plane DAS, eSAF
259
- output) for the 190 simulated cases. See that repository's README for how each
260
- maps to `data/*.hdf5` here.
261
 
262
- ## Ethical Considerations
263
- None. The data is either fully synthetic (Field II) or measured on an **inanimate
264
- phantom** — no human or animal subjects, no PHI, no consent/IRB constraints.
 
 
 
 
 
 
 
1
  ---
2
+ name: wpi
3
+ pretty_name: "eSAF Rotational 3D US Raw Channel Data (Medical FUSION Lab, WPI)"
4
  license: cc-by-4.0
5
  task_categories:
6
  - image-to-image
 
17
  - n<1K
18
  ---
19
 
20
+ # Rotational 3D Ultrasound Raw Channel Data for Elevational SAF
21
+
22
+ <p align="center"><img src="assets/esaf_topview_sweep.gif" width="55%" alt="Top-view MIP: the naive reconstruction (magenta) accumulating into a smear arc as the probe sweeps 180 degrees about the rotation axis, against the eSAF label (cyan)"></p>
23
+
24
+ *Top view down the rotation axis of a point target at 20 mm depth, 6 mm off-axis, [`data/tall_elev_H12__point_z020_r6.hdf5`](https://huggingface.co/datasets/nvidia/OpenH-RF/blob/main/wpi/data/tall_elev_H12__point_z020_r6.hdf5). Magenta is the naive per-angle reconstruction, filling in as the array (white line) sweeps 180° about the rotation axis (small circle); cyan is the paired eSAF label shipped in the file; white is where both agree. eSAF collapses the rotational smear arc back onto the target (arc-FWHM 1.26 → 0.39 mm).*
25
 
26
  ## Dataset Description
27
+
28
+ Rotational 3D ultrasound acquisitions of point, pair and off-axis targets, captured with an **elevation-focused 1D linear array rotated 180° about its axial axis** (1° steps). Each acquisition stores the **raw per-element channel RF** of a single normal plane-wave transmit at every rotation angle, i.e. the data before in-plane beamforming, which enables flexible offline beamforming and **elevational Synthetic Aperture Focusing (eSAF)**. Every file also carries the eSAF-reconstructed 3D volume as a paired label.
29
+
30
+ The release is mostly **simulated (Field II)**: a grid of 10 probe types × 19 targets spanning depths where the elevational beam thickness (the artifact eSAF corrects) varies. It is complemented by 5 **measured phantom** rotational scans with the physical Japan Probe 68-element array (same geometry as the simulation) at 10–45 mm depth. No human or animal subjects.
 
 
 
 
 
 
 
31
 
32
  ## Dataset Contributor(s)
33
+
34
+ - Ryo Murakami (contact)
35
+ - Medical FUSION Laboratory, Worcester Polytechnic Institute
36
 
37
  ## Dataset Creation Date
38
+
39
+ 06/15/2026
40
 
41
  ## License / Terms of Use
 
 
 
42
 
43
+ [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.
 
 
44
 
45
  ## Intended Usage
46
+
47
+ Advanced beamforming and **elevational resolution recovery** for rotational 3D US (eSAF), elevation-PSF / aperture-growth studies, and a reproducible raw-channel-data benchmark for rotational synthetic-aperture reconstruction.
 
48
 
49
  ## Dataset Characterization
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
50
 
51
+ - **Data Collection Method:** synthetic and phantom.
52
+ - *Simulated (190):* Field II (MATLAB, `xdc_focused_array` + `calc_scat_multi`), scatterers rotated about the axial axis with the transducer fixed. **10 probe types** vary lateral aperture (`n_el` 32/68/128, pitch 0.1/0.2/0.3 mm), elevation height `H` (4/8/12 mm) and elevation focus `R` (25/45/90 mm or unfocused), encoded in the probe name (`tall_elev_H12` = `H` 12 mm; `baseline_R45_H8` = `R` 45 mm, `H` 8 mm) and in `probe/*`.
53
+ - *Measured (5):* rotational scans of the Japan Probe 68-element array on a wire/point phantom with a Galil-controlled 180° rotation, acquired as 7-angle CPWC, time-tag-synced to the motor angles and reduced to the centre (0°) plane wave per angle to match the simulation schema.
54
+ - **Labeling Method:** synthetic ground truth. Target positions are exact, and each file's `description` attribute records probe and target, e.g. `probe=tall_elev_H12 target=point_z020_r6 r0=6.0mm z=20.0mm`. The paired eSAF volume (`custom/saf_bmode`) is the label.
55
+ - **Acquisition system:** Japan Probe JP_Linear_68 (baseline): 68 elements, pitch 0.2 mm, element width 0.15 mm, element height 8 mm, elevational lens focus 45 mm; center frequency 10 MHz; sampling 40 MHz; sound speed 1490 m/s; one normal plane-wave transmit per rotation angle; 180° rotation in 1° steps. Parameters match the paper simulation.
56
+
57
+ ## Processing the Dataset
58
+
59
+ The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/wpi/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, beamforms the rotation frame closest to ±90° (where an off-axis target lies in-plane) and plots it beside the per-frame rotation angle from `metadata/probe_pose`. Set `ZEA_FILE` and `FRAME` at the top of the script to pick another acquisition or frame. The default, frame 90 (~−90°) of [`data/experiment__acq_exp_30mm.hdf5`](https://huggingface.co/datasets/nvidia/OpenH-RF/blob/main/wpi/data/experiment__acq_exp_30mm.hdf5), gives:
60
+
61
+ <p align="center"><img src="assets/bmode.png" width="70%" alt="B-mode frame of the measured phantom at -90 deg probe rotation, with the per-frame rotation-angle trajectory alongside it"></p>
62
+
63
+ The rotational eSAF itself (in-plane DAS → `recon_3d` → `safrot_backproj`) is the published MATLAB implementation; its output is shipped in every file as `custom/saf_bmode`:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
64
 
65
  ```python
66
  with zea.File("data/baseline_R45_H8__point_z080_r4.hdf5") as f:
 
70
  print(saf["values"].description) # axes + eSAF parameters + arc-FWHM
71
  ```
72
 
73
+ ## Dataset Format
74
+
75
+ [zea v0.1.6](https://github.com/tue-bmd/zea)
76
+
77
+ One zea HDF5 file per acquisition, single track. The raw channel RF and scan parameters are in the standard data/scan groups (`tracks/track_0`); the probe rotation per frame is the **`metadata/probe_pose`** trajectory (`euler_xyz`, radians, rotation in the z component, zero translation; `sampling_frequency = 1.0 Hz` is nominal, one pose per frame).
78
+
79
+ The paired eSAF label is the zea custom field **`custom/saf_bmode`**: `values` is `(1, z, x, y)` float32 in dB (0 dB = volume max, empty pixels −inf) over a ±2 mm depth window about the target, and `coordinates` holds the per-pixel `[x, y, z]` in metres. It lives in `custom` rather than the data group because it is a single frame, while `raw_data` has ~180. The per-case arc-FWHM before/after is in the `description` of `custom/saf_bmode/values`.
80
+
81
+ Pre-processing: none for the simulations beyond the forward model; for the measured scans, frame-to-angle synchronisation, per-angle dwell averaging and centre-plane-wave selection. Both remain raw per-element RF (not demodulated or decimated).
 
 
82
 
83
  ## Dataset Quantification
84
 
85
  **Current OpenH-RF release:** 195 HDF5 files; 1.87 GB (1,870,462,976 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.
86
 
87
  - **Acquisitions:** **195** = **190 simulated** + **5 measured phantom**.
88
+ - *Simulated (190):* **10 probe types × 19 targets** (16 single points over depth {20,45,80,130} mm × radial offset from the rotation centre {0,2,4,6} mm, plus 3 pair/oblique cases). The probe axis is listed above under Data Collection Method; each file's own `description` attribute gives its exact probe/target/r0/depth. (The earlier compatible set has 18 acquisitions.)
89
+ - *Measured (5):* real rotational phantom scans at nominal depths {10,20,30,40,45} mm (`experiment__acq_exp_*.hdf5`), centre plane wave, ~182 measured rotation angles over ~180°.
90
+ - **Frames per acquisition:** simulated 180 (one per 1° step); measured ~182 (the actual encoder angles are stored in `metadata/probe_pose` — z Euler component, radians — not necessarily uniform).
 
 
 
 
 
 
 
91
  - **Stored HDF5 size:** 1.87 GB (1,870,462,976 bytes), including the paired `saf_bmode` label volumes.
92
+ - **Train/val/test split:** N/A (benchmark / characterization set; the probe × depth × radius axes are the intended study dimensions).
 
93
 
94
  ### Per-sample feature table
95
+ Shapes use placeholders because dimensions vary across the probe grid and between simulated and measured scans: **`n_frames`** = 180 (simulated, one per 1° step) or ~182 (measured encoder angles); **`n_el`** ∈ {32, 68, 128} (probe grid; 68 for the baseline and all measured scans); **`n_ax`** = axial sample count (per case); **`n_z`** = depth samples of the label volume (target ± ~2 mm window).
 
 
 
 
96
 
97
+ Paths below are inside each `.hdf5`; with `zea.File` use `f.data` / `f.scan` / `f.metadata.probe_pose`, and `f.custom` for the SAF label volume.
 
98
 
99
  | field (HDF5 path) | shape | dtype | units | description |
100
  |-----------------------------------|--------------------------------|---------|-------|-------------|
 
116
  | `custom/saf_bmode/coordinates` | (n_z, n_el, n_el, 3) | float32 | m | per-pixel `[x, y, z]` positions of the label volume (target ± ~2 mm depth window) |
117
 
118
  ## Subject Metadata
119
+
120
+ No human or animal subjects / no PHI. Each file stores `metadata/subject/type`: `simulated phantom` for the Field II simulations, `phantom` for the measured `experiment__*` scans. Creator attribution is stored per file in `metadata/credit`.
 
121
 
122
  ## Data Validation
123
+
124
+ `reconstruct.py` beamforms a single rotation frame with the `pipeline.yaml` chain (Cast → Demodulate → Beamform(delay_and_sum) → EnvelopeDetect → Normalize → LogCompress) and plots the stored rotation trajectory beside it, as a check on the acquisition parameters and the frame-to-angle mapping.
125
+
126
+ The eSAF labels were checked per case with the arc-FWHM of the rotational smear before and after eSAF, shown here annotated for the case in the hero image:
127
+
128
+ <p align="center"><img src="assets/esaf_topview_before_after.png" width="60%" alt="Annotated top-view MIP: mm axes, the rotation axis and its 180 degree sweep, a color legend, and the arc-FWHM numbers"></p>
 
 
 
 
 
 
 
 
 
 
 
 
129
 
130
  ## Known Issues
131
+
132
+ - **Paired SAF label — on-axis targets (r0 = 0) do not narrow, by design.** eSAF refocuses the *rotational elevation smear*; a target sitting on the rotation axis has essentially no smear, so its `saf_bmode` label volume is not sharper than the input (arc-FWHM gain ≈ 1). This is expected physics, not a defect — the 40 on-axis cases (median gain 1.00×) are included so the pair covers the degenerate no-smear case. Off-axis targets (n=120, median gain 1.75×, up to ~12×) and paired/oblique targets (n=30, median 3.71×) improve clearly; targets at the focal depth (~45 mm) and weak-elevation-focus probes (`efocus_deep_90`, `elev_unfocused`) have less smear to recover. Across all 195 cases, median arc-FWHM gain is 1.36× (42 cases < 1×, mostly the on-axis/near-focus group above). Arc-FWHM is measured on a **centred** reconstruction: the smear circle passes through both the rotation axis and the target (not a circle centred on the rotation axis). The eSAF back-projection uses a fixed elevational focus of 45 mm; per-depth focus tuning (see `docs/eSAF_focus_depth_study_JP.md`, source) can further sharpen deep off-axis cases but was not applied here (single as-designed focus).
133
+ - **Measured phantom depth window.** The real reflector bead sits **~4 mm off the rotation axis** (not on-axis) and, for each scan, slightly deeper than the folder's nominal depth label; labels are reconstructed over the interactively-identified reflector depth window (not a naive nominal-depth ± 2 mm window), which matters because a mis-centred window can pick up near-axis clutter instead of the actual bead.
134
+ - **Simulated** data (Field II spatial-impulse-response model): realistic transducer field, but no tissue attenuation, aberration, multiple scattering, or electronic noise. Not a substitute for measured data.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
135
  - Speed of sound is 1490 m/s, matching the paper Table 1 and the experiment.
136
+ - A single normal plane-wave transmit per rotation angle is simulated (the dataset stores n_tx = 1); multi-angle compounding is left to downstream users.
137
+ - **Measured scans:** acquired as 7-angle CPWC; only the **centre (0°) plane wave** is kept here to match the n_tx = 1 schema. The dwell frames per angle are averaged before storage (noise reduction). Real reflectors are not ideal point scatterers — expect reverberation/clutter near the surface and specular layering; rotation angles are the measured encoder values (slightly non-uniform, full span ≈ 180°, sign per encoder direction). The elevational lens focus is the nominal 45 mm, but the effective back-projection focus for eSAF is depth-dependent on real data (see `docs/eSAF_focus_depth_study_JP.md`, source).
138
+
139
+ ## Ethical Considerations
140
+
141
+ None. The data is either fully synthetic (Field II) or measured on an inanimate phantom: no human or animal subjects, no PHI, no consent or IRB constraints.
 
 
 
 
142
 
143
  ## Raw Source Data
 
 
 
 
 
 
 
144
 
145
+ The raw pre-conversion outputs are archived under the same CC BY 4.0 license at
146
+ <https://huggingface.co/datasets/RyoMurakami/OpenH-RF-eSAF-raw>: the raw Verasonics per-line
147
+ channel-RF captures (with encoder logs) for the 5 measured acquisitions, and the per-case MATLAB intermediates (raw RF, in-plane DAS, eSAF output) for the 190 simulated cases.
148
+
149
+ ## Citation
150
+
151
+ When using this dataset, please cite:
152
+
153
+ > R. Murakami et al., "Elevational Synthetic Aperture Focusing for Rotated Array-Based Three-Dimensional Ultrasound Imaging," IEEE Access, 2025.
wpi/assets/bmode.png ADDED

Git LFS Details

  • SHA256: c11c93b506b60e4215a8e9d9a21dc0af69cde22db6db3ff747d666a74e6f5f36
  • Pointer size: 131 Bytes
  • Size of remote file: 114 kB
wpi/assets/esaf_topview_before_after.png ADDED

Git LFS Details

  • SHA256: 7405119ec22818557446e4600b9f4a672ad645631f36196553390a62f986c28f
  • Pointer size: 130 Bytes
  • Size of remote file: 69.5 kB
wpi/assets/esaf_topview_sweep.gif ADDED

Git LFS Details

  • SHA256: 812a48d9083c803d8eb9ece7bd0ce47f60245985a3c3d41bed0780136f1407d8
  • Pointer size: 131 Bytes
  • Size of remote file: 181 kB
wpi/assets/main.png ADDED

Git LFS Details

  • SHA256: 280396699bad99d62c83b1c4b4e5709b39d09bbd7bf8b75336cbb955dd73a8db
  • Pointer size: 130 Bytes
  • Size of remote file: 45.8 kB