tristan-deep Claude Opus 5 commited on
Commit
cce1ebb
·
1 Parent(s): d330799

Normalize line endings to LF

Browse files

Fourteen files were stored with CRLF, so they showed up as wholly modified
against any LF copy and buried the real one-line changes underneath.

Adds a text=auto eol=lf rule, placed above the LFS rules because git applies
the last matching pattern and those set -text to keep binary payloads
untouched.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

.gitattributes CHANGED
@@ -1,3 +1,9 @@
 
 
 
 
 
 
1
  *.7z filter=lfs diff=lfs merge=lfs -text
2
  *.arrow filter=lfs diff=lfs merge=lfs -text
3
  *.avro filter=lfs diff=lfs merge=lfs -text
 
1
+ # Store text as LF in the index and check it out as LF everywhere, so a
2
+ # Windows-authored file does not show up as wholly modified downstream.
3
+ # Must stay ABOVE the LFS rules: git applies the last matching pattern, and
4
+ # those rules set -text to keep binary payloads untouched.
5
+ * text=auto eol=lf
6
+
7
  *.7z filter=lfs diff=lfs merge=lfs -text
8
  *.arrow filter=lfs diff=lfs merge=lfs -text
9
  *.avro filter=lfs diff=lfs merge=lfs -text
colorado-boulder/README.md CHANGED
@@ -1,174 +1,174 @@
1
- ---
2
- pretty_name: "OpenH-RF — Tracked Swept Synthetic Aperture 3D Phantom Dataset"
3
- license: cc-by-4.0
4
- task_categories:
5
- - generalized-reconstruction
6
- tags:
7
- - ultrasound
8
- - rf
9
- - openh-rf
10
- - 3d
11
- language:
12
- - en
13
- size_categories:
14
- - n<1K
15
- ---
16
-
17
- # Tracked Swept Synthetic Aperture 3D Phantom Ultrasound Dataset
18
-
19
- ## Dataset Description
20
-
21
- This dataset contains tracked swept synthetic aperture (SSA) ultrasound acquisitions of a 3D ultrasound imaging phantom. The data were acquired using a Verasonics Vantage research ultrasound system with a P4-2 phased array transducer.
22
-
23
- The dataset includes raw RF channel data, acquisition parameters, probe geometry, transmit information, and frame-wise tracked probe pose metadata. Its purpose is to provide a reproducible example of motion-compensated SSA reconstruction from raw channel data using the zea/OpenH-RF data format.
24
-
25
- This dataset contains phantom data only. It does not contain human subject data, animal data, or protected health information (PHI).
26
-
27
- ## Dataset Contributor(s)
28
-
29
- **Contributing organization:** University of Colorado Boulder, Bottenus Lab
30
-
31
- **Contributors:**
32
-
33
- - Anet Sanchez
34
- - Nick Bottenus
35
-
36
- ## Dataset Creation Date
37
-
38
- 06/24/2025
39
-
40
- ## License / Terms of Use
41
-
42
- This dataset is released under the Creative Commons Attribution 4.0 International License (CC BY 4.0).
43
-
44
- The contributed data consist exclusively of phantom ultrasound acquisitions and are cleared for release under CC BY 4.0. Patient consent, clinical data-use agreements, and PHI de-identification are not applicable because the dataset does not contain human subject data.
45
-
46
- ## Intended Usage
47
-
48
- This dataset is intended for research on generalized ultrasound reconstruction, with a particular focus on tracked swept synthetic aperture imaging, motion-compensated beamforming, coherent compounding, and ultrasound image-quality evaluation.
49
-
50
- For SSA reconstruction, each raw RF frame is beamformed using its corresponding tracked transducer pose. The resulting beamformed IQ frames are placed on a common reconstruction grid and coherently summed to synthesize a larger effective aperture. Because the reconstruction relies on coherent compounding, summation is performed before envelope detection, normalization, and log compression.
51
-
52
- ## Dataset Characterization
53
-
54
- - **Data Collection Method:** Phantom ultrasound acquisition
55
- - **Labeling Method:** N/A; no manual labels or segmentation masks are provided
56
- - **Acquisition System:** Verasonics Vantage research ultrasound scanner with a Verasonics P4-2 phased array transducer
57
-
58
- ### Acquisition Details
59
-
60
- The transducer was manually swept over the phantom field of view while diverging-wave transmissions were acquired at 400 Hz. All 64 array elements were used on receive.
61
-
62
- Diverging waves were generated using a negative virtual source with the 20 central array elements active on transmit.
63
-
64
- The transducer was optically tracked using an NDI Polaris Vega® XT optical tracking system manufactured by Northern Digital Inc., Ontario, Canada.
65
-
66
- ### Probe and Geometry
67
-
68
- The acquisition used a Verasonics P4-2 phased array transducer with 64 elements. The center frequency stored in the acquisition and used for reconstruction is 2.5 MHz.
69
-
70
- The probe geometry, transmit origins, transmit delays, transmit apodization, and other acquisition parameters are stored in the zea/OpenH-RF file. Frame-wise probe translations and rotations are stored using the native `metadata/probe_pose` structure.
71
-
72
- ## Dataset Format
73
-
74
- The dataset is distributed in the zea/OpenH-RF HDF5 format.
75
-
76
- Each file includes:
77
-
78
- - Raw RF channel data
79
- - Sampling and center frequencies
80
- - Transmit delays and apodization
81
- - Transmit origins
82
- - Probe geometry
83
- - Sound-speed information
84
- - Frame-wise tracked probe translations
85
- - Frame-wise tracked probe rotations
86
-
87
- The stored RF channel data have not been beamformed, envelope detected, normalized, or log compressed. The accompanying reconstruction pipeline performs these processing steps.
88
-
89
- ## Dataset Quantification
90
-
91
- **Current OpenH-RF release:** 62 HDF5 files; 16.04 GB (16,037,117,952 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.
92
-
93
- - **Number of phantom objects:** 1
94
- - **Number of acquisitions:** 10
95
- - **Number of RF frames per acquisition:** 1200
96
- - **Number of transmit events per frame:** 1
97
- - **Number of receive elements:** 64
98
- - **Number of active transmit elements:** 20
99
-
100
- ### Per-File Feature Summary
101
-
102
- | Feature | Shape | Data type | Units | Description |
103
- |---|---:|---|---|---|
104
- | Raw RF data | `n_frames × n_tx × n_ax × n_elements × n_channels` | `float32` | acquisition units | Raw RF channel measurements |
105
- | Probe translation | `n_frames × 3` | `float32` | m | Frame-wise tracked probe position |
106
- | Probe rotation | `n_frames × 4` | `float32` | unit quaternion | Frame-wise tracked probe orientation in `xyzw` order |
107
- | Probe geometry | `64 × 3` | `float32` | m | Array-element coordinates |
108
- | Transmit origins | `n_tx × 3` | `float32` | m | Diverging-wave virtual-source coordinates |
109
- | Transmit delays | `n_tx × 64` | `float32` | s | Per-element transmit delays |
110
- | Transmit apodization | `n_tx × 64` | `float32` | unitless | Per-element transmit activation and weighting |
111
-
112
- ## Subject Metadata
113
-
114
- ### Metadata Schema Migration
115
-
116
- The zea 0.1.6 migration uses these approved metadata locations:
117
-
118
- | Legacy location | Canonical location |
119
- |---|---|
120
- | Dataset `metadata/subject_id` | Dataset `metadata/subject/id` |
121
- | Dataset `metadata/subject_type` | Dataset `metadata/subject/type` |
122
- | Dataset `metadata/us_machine` | Root HDF5 attribute `us_machine` |
123
-
124
- Read the machine name with `f.attrs["us_machine"]`, not `f["us_machine"]`.
125
- Subject values and their existing attributes are preserved. The machine
126
- string is preserved; migration stops for review if its legacy dataset has
127
- attributes that cannot be represented without loss. No numerical arrays are
128
- rescaled or otherwise changed by these relocations.
129
-
130
- The three-field pilot passed full array and metadata parity checks with the
131
- approved description changes and `transmit_only=False` default. Full-release
132
- migration is still pending. Replacement files are uploaded only after
133
- per-file validation; readers supporting both revisions should check the
134
- canonical locations first, then the legacy locations.
135
-
136
-
137
- This dataset contains one 3D ultrasound imaging phantom.
138
-
139
- - **Subject type:** 3D phantom
140
- - **Anatomical region:** Not applicable
141
- - **Human participants:** None
142
- - **Animal subjects:** None
143
- - **Protected health information:** None
144
- - **Scanner:** Verasonics Vantage
145
- - **Probe:** Verasonics P4-2 phased array
146
-
147
- ## Data Validation
148
-
149
- The submission includes a `zea.Pipeline` that reconstructs a representative tracked SSA B-mode image from the raw RF channel data.
150
-
151
- The pipeline performs:
152
-
153
- 1. Frame-wise demodulation
154
- 2. Application of the tracked probe pose
155
- 3. Delay-and-sum beamforming onto a common reconstruction grid
156
- 4. Coherent summation of the beamformed IQ frames
157
- 5. Envelope detection
158
- 6. Normalization
159
- 7. Log compression
160
-
161
- The reconstruction is defined in `pipeline.yaml` and executed using `reconstruct.py`. A representative reconstructed B-mode image is included with the dataset.
162
-
163
- ## Known Issues
164
-
165
- - Optical tracking measurements may contain small position and orientation uncertainties.
166
- - Reconstruction quality depends on tracking calibration accuracy and coherent alignment between frames.
167
-
168
-
169
- ## Ethical Considerations
170
-
171
- This dataset contains phantom ultrasound data only. It does not contain human participants, animal subjects, personal identifiers, clinical records, or protected health information.
172
-
173
- Human-subject consent and institutional review board approval are therefore not applicable.
174
-
 
1
+ ---
2
+ pretty_name: "OpenH-RF — Tracked Swept Synthetic Aperture 3D Phantom Dataset"
3
+ license: cc-by-4.0
4
+ task_categories:
5
+ - generalized-reconstruction
6
+ tags:
7
+ - ultrasound
8
+ - rf
9
+ - openh-rf
10
+ - 3d
11
+ language:
12
+ - en
13
+ size_categories:
14
+ - n<1K
15
+ ---
16
+
17
+ # Tracked Swept Synthetic Aperture 3D Phantom Ultrasound Dataset
18
+
19
+ ## Dataset Description
20
+
21
+ This dataset contains tracked swept synthetic aperture (SSA) ultrasound acquisitions of a 3D ultrasound imaging phantom. The data were acquired using a Verasonics Vantage research ultrasound system with a P4-2 phased array transducer.
22
+
23
+ The dataset includes raw RF channel data, acquisition parameters, probe geometry, transmit information, and frame-wise tracked probe pose metadata. Its purpose is to provide a reproducible example of motion-compensated SSA reconstruction from raw channel data using the zea/OpenH-RF data format.
24
+
25
+ This dataset contains phantom data only. It does not contain human subject data, animal data, or protected health information (PHI).
26
+
27
+ ## Dataset Contributor(s)
28
+
29
+ **Contributing organization:** University of Colorado Boulder, Bottenus Lab
30
+
31
+ **Contributors:**
32
+
33
+ - Anet Sanchez
34
+ - Nick Bottenus
35
+
36
+ ## Dataset Creation Date
37
+
38
+ 06/24/2025
39
+
40
+ ## License / Terms of Use
41
+
42
+ This dataset is released under the Creative Commons Attribution 4.0 International License (CC BY 4.0).
43
+
44
+ The contributed data consist exclusively of phantom ultrasound acquisitions and are cleared for release under CC BY 4.0. Patient consent, clinical data-use agreements, and PHI de-identification are not applicable because the dataset does not contain human subject data.
45
+
46
+ ## Intended Usage
47
+
48
+ This dataset is intended for research on generalized ultrasound reconstruction, with a particular focus on tracked swept synthetic aperture imaging, motion-compensated beamforming, coherent compounding, and ultrasound image-quality evaluation.
49
+
50
+ For SSA reconstruction, each raw RF frame is beamformed using its corresponding tracked transducer pose. The resulting beamformed IQ frames are placed on a common reconstruction grid and coherently summed to synthesize a larger effective aperture. Because the reconstruction relies on coherent compounding, summation is performed before envelope detection, normalization, and log compression.
51
+
52
+ ## Dataset Characterization
53
+
54
+ - **Data Collection Method:** Phantom ultrasound acquisition
55
+ - **Labeling Method:** N/A; no manual labels or segmentation masks are provided
56
+ - **Acquisition System:** Verasonics Vantage research ultrasound scanner with a Verasonics P4-2 phased array transducer
57
+
58
+ ### Acquisition Details
59
+
60
+ The transducer was manually swept over the phantom field of view while diverging-wave transmissions were acquired at 400 Hz. All 64 array elements were used on receive.
61
+
62
+ Diverging waves were generated using a negative virtual source with the 20 central array elements active on transmit.
63
+
64
+ The transducer was optically tracked using an NDI Polaris Vega® XT optical tracking system manufactured by Northern Digital Inc., Ontario, Canada.
65
+
66
+ ### Probe and Geometry
67
+
68
+ The acquisition used a Verasonics P4-2 phased array transducer with 64 elements. The center frequency stored in the acquisition and used for reconstruction is 2.5 MHz.
69
+
70
+ The probe geometry, transmit origins, transmit delays, transmit apodization, and other acquisition parameters are stored in the zea/OpenH-RF file. Frame-wise probe translations and rotations are stored using the native `metadata/probe_pose` structure.
71
+
72
+ ## Dataset Format
73
+
74
+ The dataset is distributed in the zea/OpenH-RF HDF5 format.
75
+
76
+ Each file includes:
77
+
78
+ - Raw RF channel data
79
+ - Sampling and center frequencies
80
+ - Transmit delays and apodization
81
+ - Transmit origins
82
+ - Probe geometry
83
+ - Sound-speed information
84
+ - Frame-wise tracked probe translations
85
+ - Frame-wise tracked probe rotations
86
+
87
+ The stored RF channel data have not been beamformed, envelope detected, normalized, or log compressed. The accompanying reconstruction pipeline performs these processing steps.
88
+
89
+ ## Dataset Quantification
90
+
91
+ **Current OpenH-RF release:** 62 HDF5 files; 16.04 GB (16,037,117,952 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.
92
+
93
+ - **Number of phantom objects:** 1
94
+ - **Number of acquisitions:** 10
95
+ - **Number of RF frames per acquisition:** 1200
96
+ - **Number of transmit events per frame:** 1
97
+ - **Number of receive elements:** 64
98
+ - **Number of active transmit elements:** 20
99
+
100
+ ### Per-File Feature Summary
101
+
102
+ | Feature | Shape | Data type | Units | Description |
103
+ |---|---:|---|---|---|
104
+ | Raw RF data | `n_frames × n_tx × n_ax × n_elements × n_channels` | `float32` | acquisition units | Raw RF channel measurements |
105
+ | Probe translation | `n_frames × 3` | `float32` | m | Frame-wise tracked probe position |
106
+ | Probe rotation | `n_frames × 4` | `float32` | unit quaternion | Frame-wise tracked probe orientation in `xyzw` order |
107
+ | Probe geometry | `64 × 3` | `float32` | m | Array-element coordinates |
108
+ | Transmit origins | `n_tx × 3` | `float32` | m | Diverging-wave virtual-source coordinates |
109
+ | Transmit delays | `n_tx × 64` | `float32` | s | Per-element transmit delays |
110
+ | Transmit apodization | `n_tx × 64` | `float32` | unitless | Per-element transmit activation and weighting |
111
+
112
+ ## Subject Metadata
113
+
114
+ ### Metadata Schema Migration
115
+
116
+ The zea 0.1.6 migration uses these approved metadata locations:
117
+
118
+ | Legacy location | Canonical location |
119
+ |---|---|
120
+ | Dataset `metadata/subject_id` | Dataset `metadata/subject/id` |
121
+ | Dataset `metadata/subject_type` | Dataset `metadata/subject/type` |
122
+ | Dataset `metadata/us_machine` | Root HDF5 attribute `us_machine` |
123
+
124
+ Read the machine name with `f.attrs["us_machine"]`, not `f["us_machine"]`.
125
+ Subject values and their existing attributes are preserved. The machine
126
+ string is preserved; migration stops for review if its legacy dataset has
127
+ attributes that cannot be represented without loss. No numerical arrays are
128
+ rescaled or otherwise changed by these relocations.
129
+
130
+ The three-field pilot passed full array and metadata parity checks with the
131
+ approved description changes and `transmit_only=False` default. Full-release
132
+ migration is still pending. Replacement files are uploaded only after
133
+ per-file validation; readers supporting both revisions should check the
134
+ canonical locations first, then the legacy locations.
135
+
136
+
137
+ This dataset contains one 3D ultrasound imaging phantom.
138
+
139
+ - **Subject type:** 3D phantom
140
+ - **Anatomical region:** Not applicable
141
+ - **Human participants:** None
142
+ - **Animal subjects:** None
143
+ - **Protected health information:** None
144
+ - **Scanner:** Verasonics Vantage
145
+ - **Probe:** Verasonics P4-2 phased array
146
+
147
+ ## Data Validation
148
+
149
+ The submission includes a `zea.Pipeline` that reconstructs a representative tracked SSA B-mode image from the raw RF channel data.
150
+
151
+ The pipeline performs:
152
+
153
+ 1. Frame-wise demodulation
154
+ 2. Application of the tracked probe pose
155
+ 3. Delay-and-sum beamforming onto a common reconstruction grid
156
+ 4. Coherent summation of the beamformed IQ frames
157
+ 5. Envelope detection
158
+ 6. Normalization
159
+ 7. Log compression
160
+
161
+ The reconstruction is defined in `pipeline.yaml` and executed using `reconstruct.py`. A representative reconstructed B-mode image is included with the dataset.
162
+
163
+ ## Known Issues
164
+
165
+ - Optical tracking measurements may contain small position and orientation uncertainties.
166
+ - Reconstruction quality depends on tracking calibration accuracy and coherent alignment between frames.
167
+
168
+
169
+ ## Ethical Considerations
170
+
171
+ This dataset contains phantom ultrasound data only. It does not contain human participants, animal subjects, personal identifiers, clinical records, or protected health information.
172
+
173
+ Human-subject consent and institutional review board approval are therefore not applicable.
174
+
colorado-boulder/pipeline.yaml CHANGED
@@ -1,44 +1,44 @@
1
- pipeline:
2
- operations:
3
- - name: map
4
- operations:
5
- - name: keras.ops.squeeze
6
- params:
7
- axis: 0
8
- jit_compile: false
9
- - name: keras.ops.cast
10
- params:
11
- dtype: float32
12
- jit_compile: false
13
- - name: demodulate
14
- params:
15
- jit_compile: false
16
- - name: apply_probe_pose
17
- params:
18
- jit_compile: false
19
- - name: beamform
20
- params:
21
- jit_options: null
22
- with_batch_dim: false
23
- - name: keras.ops.expand_dims
24
- params:
25
- axis: 0
26
- jit_compile: false
27
- params:
28
- argnames:
29
- - data
30
- - probe_translation
31
- - probe_rotation
32
- batch_size: 1
33
- with_batch_dim: false
34
- - name: keras.ops.sum
35
- params:
36
- axis: 0
37
- - envelope_detect
38
- - name: normalize
39
- params:
40
- output_range:
41
- - 0.0
42
- - 1.0
43
- - log_compress
44
- with_batch_dim: false
 
1
+ pipeline:
2
+ operations:
3
+ - name: map
4
+ operations:
5
+ - name: keras.ops.squeeze
6
+ params:
7
+ axis: 0
8
+ jit_compile: false
9
+ - name: keras.ops.cast
10
+ params:
11
+ dtype: float32
12
+ jit_compile: false
13
+ - name: demodulate
14
+ params:
15
+ jit_compile: false
16
+ - name: apply_probe_pose
17
+ params:
18
+ jit_compile: false
19
+ - name: beamform
20
+ params:
21
+ jit_options: null
22
+ with_batch_dim: false
23
+ - name: keras.ops.expand_dims
24
+ params:
25
+ axis: 0
26
+ jit_compile: false
27
+ params:
28
+ argnames:
29
+ - data
30
+ - probe_translation
31
+ - probe_rotation
32
+ batch_size: 1
33
+ with_batch_dim: false
34
+ - name: keras.ops.sum
35
+ params:
36
+ axis: 0
37
+ - envelope_detect
38
+ - name: normalize
39
+ params:
40
+ output_range:
41
+ - 0.0
42
+ - 1.0
43
+ - log_compress
44
+ with_batch_dim: false
concordia/wikimedia_commons_metadata.csv CHANGED
The diff for this file is too large to render. See raw diff
 
oslo/A_cardiac/README.md CHANGED
@@ -1,124 +1,124 @@
1
- ---
2
- pretty_name: "USTB - In-vivo Cardiac (Verasonics P4-2)"
3
- license: cc-by-4.0
4
- task_categories:
5
- - image-to-image
6
- language:
7
- - en
8
- tags:
9
- - ultrasound
10
- - rf
11
- - openh-rf
12
- - cardiac
13
- - in-vivo
14
- size_categories:
15
- - n<1K
16
- ---
17
-
18
- # USTB - In-vivo Cardiac (Verasonics P4-2)
19
-
20
- Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** contributed to the
21
- [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All acquisitions are stored in the
22
- *zea* HDF5 file format (zea_version 0.1.6) and contain raw pre-beamformed
23
- channel data (`/data/raw_data`).
24
-
25
- ## Dataset Description
26
-
27
- In-vivo human cardiac channel-capture data acquired with a Verasonics Vantage 256 research scanner and a P4-2 phased-array probe. The collection contains parasternal long-axis and apical four-chamber views recorded with focused transmit beams (sector scan). The data is pre-beamformed RF channel data intended for research into generalized beamforming, adaptive imaging and cardiac reconstruction.
28
-
29
- ## Dataset Contributors
30
-
31
- University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius Hoel Rindal (omrindal@ifi.uio.no). Team: Ole Marius Hoel Rindal, Yucel Karabiyik, Sven Peter Nasholm, Andreas Austeng.
32
-
33
- ## Dataset Creation Date
34
-
35
- 06/23/2026 (packaging date; original acquisitions/simulations were produced between 2016 and 2023).
36
-
37
- ## License / Terms of Use
38
-
39
- Released under **Creative Commons Attribution 4.0 International (CC BY 4.0)** — see the `LICENCE`
40
- file at the submission root (this license is also declared in the YAML frontmatter above). The
41
- contributed data is cleared for this license. The UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo. Contributed to OpenH-RF. Zenodo record 20261898.
42
-
43
- ## Intended Usage
44
-
45
- Generalized reconstruction and adaptive beamforming of cardiac ultrasound (RFP task 6.1). Suitable for B-mode reconstruction, aperture-domain processing, and deep-learning beamforming research on in-vivo cardiac data. (OpenH-RF RFP task 6.1 Generalized Reconstruction).
46
-
47
- ## Dataset Characterization
48
-
49
- - **Data Collection Method:** clinical
50
- - **Labeling Method:** N/A (raw channel data; no annotations).
51
- - **Acquisition system:** probe(s) P4-2;
52
- element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling
53
- frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
54
-
55
- ## Dataset Format
56
-
57
- All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single
58
- acquisition with raw channel data `/data/raw_data` of shape
59
- `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit
60
- sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1).
61
- No demodulation or decimation was applied during packaging beyond conversion from the USTB
62
- Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
63
-
64
- ## Dataset Quantification
65
-
66
- **Current OpenH-RF release:** 2 HDF5 files; 3.53 GB (3,533,897,728 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.
67
-
68
- - **Number of acquisitions:** 2
69
- - **Total channel-capture frames:** 75
70
- - **Train / validation / test split:** not predefined (research dataset).
71
- - **Stored HDF5 size:** 3.53 GB (3,533,897,728 bytes).
72
-
73
- Per-acquisition summary:
74
-
75
- | Acquisition | frames | transmits | samples | elements | n_ch | fs (MHz) | fc (MHz) | size (MB) |
76
- |---|---|---|---|---|---|---|---|---|
77
- | `Verasonics_P2-4_apical_four_chamber_subject_1` | 25 | 101 | 2176 | 64 | 1 | 11.9 | 2.98 | 1181.42 |
78
- | `Verasonics_P2-4_parasternal_long_subject_1` | 50 | 101 | 2176 | 64 | 1 | 11.9 | 2.98 | 2352.48 |
79
-
80
- Per-sample feature table:
81
-
82
- | Field | Shape | Dtype | Units | Description |
83
- |---|---|---|---|---|
84
- | `data/raw_data` | `(n_frames, n_tx, n_ax, n_el, n_ch)` | float32 | a.u. | Raw pre-beamformed RF channel data |
85
- | `scan/sampling_frequency` | `scalar` | float32 | Hz | A/D sampling frequency |
86
- | `scan/center_frequency` | `scalar` | float32 | Hz | Transmit pulse center frequency |
87
- | `scan/demodulation_frequency` | `scalar` | float32 | Hz | Demodulation (carrier) frequency |
88
- | `scan/sound_speed` | `scalar` | float32 | m/s | Assumed medium speed of sound |
89
- | `scan/initial_times` | `(n_tx,)` | float32 | s | A/D start time per transmit |
90
- | `scan/t0_delays` | `(n_tx, n_el)` | float32 | s | Per-element transmit fire times |
91
- | `scan/tx_apodizations` | `(n_tx, n_el)` | float32 | - | Per-element transmit apodization |
92
- | `scan/focus_distances` | `(n_tx,)` | float32 | m | Focus distance per transmit (0 = plane wave) |
93
- | `scan/polar_angles` | `(n_tx,)` | float32 | rad | Transmit steering (polar) angle |
94
- | `scan/transmit_origins` | `(n_tx, 3)` | float32 | m | Transmit beam origin (x, y, z) |
95
- | `probe/probe_geometry` | `(n_el, 3)` | float32 | m | Element positions (x, y, z) |
96
-
97
- ## Subject Metadata
98
-
99
- Healthy adult volunteer(s). Anatomy: heart (parasternal long-axis, apical four-chamber). Scanner: Verasonics Vantage 256. Probe: P4-2 phased array (64 elements). Aggregate only; no per-subject identifiers are stored.
100
-
101
- ## Data Validation
102
-
103
- A Delay-And-Sum `zea.Pipeline` is provided in the **`pipeline.yaml` at the submission root** and
104
- run by the single **`reconstruct.py` at the submission root**:
105
- `cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`
106
- (RF is demodulated in-pipeline; IQ uses a baseband pipeline). The script is geometry-driven and
107
- recurses into every sub-dataset folder; running `python reconstruct.py` from the root reconstructs
108
- every `.hdf5` in the collection (or pass a folder-qualified path for a single acquisition) and writes
109
- `<name>_zea_bmode.png` next to each file as a portable check that the recorded geometry and timing
110
- are correct.
111
-
112
- The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the
113
- UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction
114
- used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with
115
- scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry.
116
- These are the recommended reference reconstructions for visual verification.
117
-
118
- ## Known Issues
119
-
120
- Focused sector acquisition: lateral resolution and field of view follow the transmit geometry. Phased-array data is best reconstructed on a polar (sector) grid. Frame counts vary per acquisition.
121
-
122
- ## Ethical Considerations
123
-
124
- In-vivo data recorded from healthy adult volunteers at the University of Oslo with written informed consent for research use and data sharing, and approval from the Regional Committee for Medical and Health Research Ethics (REK), Norway. The files contain only backscattered RF channel data and acquisition parameters - no patient name, identifier, date of birth, acquisition date, facial image, or any other HHS Safe Harbor identifier is present (de-identified by construction).
 
1
+ ---
2
+ pretty_name: "USTB - In-vivo Cardiac (Verasonics P4-2)"
3
+ license: cc-by-4.0
4
+ task_categories:
5
+ - image-to-image
6
+ language:
7
+ - en
8
+ tags:
9
+ - ultrasound
10
+ - rf
11
+ - openh-rf
12
+ - cardiac
13
+ - in-vivo
14
+ size_categories:
15
+ - n<1K
16
+ ---
17
+
18
+ # USTB - In-vivo Cardiac (Verasonics P4-2)
19
+
20
+ Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** contributed to the
21
+ [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All acquisitions are stored in the
22
+ *zea* HDF5 file format (zea_version 0.1.6) and contain raw pre-beamformed
23
+ channel data (`/data/raw_data`).
24
+
25
+ ## Dataset Description
26
+
27
+ In-vivo human cardiac channel-capture data acquired with a Verasonics Vantage 256 research scanner and a P4-2 phased-array probe. The collection contains parasternal long-axis and apical four-chamber views recorded with focused transmit beams (sector scan). The data is pre-beamformed RF channel data intended for research into generalized beamforming, adaptive imaging and cardiac reconstruction.
28
+
29
+ ## Dataset Contributors
30
+
31
+ University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius Hoel Rindal (omrindal@ifi.uio.no). Team: Ole Marius Hoel Rindal, Yucel Karabiyik, Sven Peter Nasholm, Andreas Austeng.
32
+
33
+ ## Dataset Creation Date
34
+
35
+ 06/23/2026 (packaging date; original acquisitions/simulations were produced between 2016 and 2023).
36
+
37
+ ## License / Terms of Use
38
+
39
+ Released under **Creative Commons Attribution 4.0 International (CC BY 4.0)** — see the `LICENCE`
40
+ file at the submission root (this license is also declared in the YAML frontmatter above). The
41
+ contributed data is cleared for this license. The UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo. Contributed to OpenH-RF. Zenodo record 20261898.
42
+
43
+ ## Intended Usage
44
+
45
+ Generalized reconstruction and adaptive beamforming of cardiac ultrasound (RFP task 6.1). Suitable for B-mode reconstruction, aperture-domain processing, and deep-learning beamforming research on in-vivo cardiac data. (OpenH-RF RFP task 6.1 Generalized Reconstruction).
46
+
47
+ ## Dataset Characterization
48
+
49
+ - **Data Collection Method:** clinical
50
+ - **Labeling Method:** N/A (raw channel data; no annotations).
51
+ - **Acquisition system:** probe(s) P4-2;
52
+ element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling
53
+ frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
54
+
55
+ ## Dataset Format
56
+
57
+ All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single
58
+ acquisition with raw channel data `/data/raw_data` of shape
59
+ `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit
60
+ sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1).
61
+ No demodulation or decimation was applied during packaging beyond conversion from the USTB
62
+ Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
63
+
64
+ ## Dataset Quantification
65
+
66
+ **Current OpenH-RF release:** 2 HDF5 files; 3.53 GB (3,533,897,728 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.
67
+
68
+ - **Number of acquisitions:** 2
69
+ - **Total channel-capture frames:** 75
70
+ - **Train / validation / test split:** not predefined (research dataset).
71
+ - **Stored HDF5 size:** 3.53 GB (3,533,897,728 bytes).
72
+
73
+ Per-acquisition summary:
74
+
75
+ | Acquisition | frames | transmits | samples | elements | n_ch | fs (MHz) | fc (MHz) | size (MB) |
76
+ |---|---|---|---|---|---|---|---|---|
77
+ | `Verasonics_P2-4_apical_four_chamber_subject_1` | 25 | 101 | 2176 | 64 | 1 | 11.9 | 2.98 | 1181.42 |
78
+ | `Verasonics_P2-4_parasternal_long_subject_1` | 50 | 101 | 2176 | 64 | 1 | 11.9 | 2.98 | 2352.48 |
79
+
80
+ Per-sample feature table:
81
+
82
+ | Field | Shape | Dtype | Units | Description |
83
+ |---|---|---|---|---|
84
+ | `data/raw_data` | `(n_frames, n_tx, n_ax, n_el, n_ch)` | float32 | a.u. | Raw pre-beamformed RF channel data |
85
+ | `scan/sampling_frequency` | `scalar` | float32 | Hz | A/D sampling frequency |
86
+ | `scan/center_frequency` | `scalar` | float32 | Hz | Transmit pulse center frequency |
87
+ | `scan/demodulation_frequency` | `scalar` | float32 | Hz | Demodulation (carrier) frequency |
88
+ | `scan/sound_speed` | `scalar` | float32 | m/s | Assumed medium speed of sound |
89
+ | `scan/initial_times` | `(n_tx,)` | float32 | s | A/D start time per transmit |
90
+ | `scan/t0_delays` | `(n_tx, n_el)` | float32 | s | Per-element transmit fire times |
91
+ | `scan/tx_apodizations` | `(n_tx, n_el)` | float32 | - | Per-element transmit apodization |
92
+ | `scan/focus_distances` | `(n_tx,)` | float32 | m | Focus distance per transmit (0 = plane wave) |
93
+ | `scan/polar_angles` | `(n_tx,)` | float32 | rad | Transmit steering (polar) angle |
94
+ | `scan/transmit_origins` | `(n_tx, 3)` | float32 | m | Transmit beam origin (x, y, z) |
95
+ | `probe/probe_geometry` | `(n_el, 3)` | float32 | m | Element positions (x, y, z) |
96
+
97
+ ## Subject Metadata
98
+
99
+ Healthy adult volunteer(s). Anatomy: heart (parasternal long-axis, apical four-chamber). Scanner: Verasonics Vantage 256. Probe: P4-2 phased array (64 elements). Aggregate only; no per-subject identifiers are stored.
100
+
101
+ ## Data Validation
102
+
103
+ A Delay-And-Sum `zea.Pipeline` is provided in the **`pipeline.yaml` at the submission root** and
104
+ run by the single **`reconstruct.py` at the submission root**:
105
+ `cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`
106
+ (RF is demodulated in-pipeline; IQ uses a baseband pipeline). The script is geometry-driven and
107
+ recurses into every sub-dataset folder; running `python reconstruct.py` from the root reconstructs
108
+ every `.hdf5` in the collection (or pass a folder-qualified path for a single acquisition) and writes
109
+ `<name>_zea_bmode.png` next to each file as a portable check that the recorded geometry and timing
110
+ are correct.
111
+
112
+ The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the
113
+ UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction
114
+ used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with
115
+ scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry.
116
+ These are the recommended reference reconstructions for visual verification.
117
+
118
+ ## Known Issues
119
+
120
+ Focused sector acquisition: lateral resolution and field of view follow the transmit geometry. Phased-array data is best reconstructed on a polar (sector) grid. Frame counts vary per acquisition.
121
+
122
+ ## Ethical Considerations
123
+
124
+ In-vivo data recorded from healthy adult volunteers at the University of Oslo with written informed consent for research use and data sharing, and approval from the Regional Committee for Medical and Health Research Ethics (REK), Norway. The files contain only backscattered RF channel data and acquisition parameters - no patient name, identifier, date of birth, acquisition date, facial image, or any other HHS Safe Harbor identifier is present (de-identified by construction).
oslo/B_carotid/README.md CHANGED
@@ -1,126 +1,126 @@
1
- ---
2
- pretty_name: "USTB - In-vivo Carotid (Verasonics L7-4)"
3
- license: cc-by-4.0
4
- task_categories:
5
- - image-to-image
6
- language:
7
- - en
8
- tags:
9
- - ultrasound
10
- - rf
11
- - openh-rf
12
- - vascular
13
- - carotid
14
- - in-vivo
15
- size_categories:
16
- - n<1K
17
- ---
18
-
19
- # USTB - In-vivo Carotid (Verasonics L7-4)
20
-
21
- Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** contributed to the
22
- [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All acquisitions are stored in the
23
- *zea* HDF5 file format (zea_version 0.1.6) and contain raw pre-beamformed
24
- channel data (`/data/raw_data`).
25
-
26
- ## Dataset Description
27
-
28
- In-vivo human carotid-artery channel-capture data acquired with a Verasonics Vantage 256 and an L7-4 linear-array probe, cross-sectional views, focused transmit imaging. Pre-beamformed RF channel data for vascular imaging and beamforming research.
29
-
30
- ## Dataset Contributors
31
-
32
- University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius Hoel Rindal (omrindal@ifi.uio.no). Team: Ole Marius Hoel Rindal, Yucel Karabiyik, Sven Peter Nasholm, Andreas Austeng.
33
-
34
- ## Dataset Creation Date
35
-
36
- 06/23/2026 (packaging date; original acquisitions/simulations were produced between 2016 and 2023).
37
-
38
- ## License / Terms of Use
39
-
40
- Released under **Creative Commons Attribution 4.0 International (CC BY 4.0)** — see the `LICENCE`
41
- file at the submission root (this license is also declared in the YAML frontmatter above). The
42
- contributed data is cleared for this license. The UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo. Contributed to OpenH-RF. Zenodo record 20261898.
43
-
44
- ## Intended Usage
45
-
46
- Generalized reconstruction and adaptive beamforming of vascular ultrasound (RFP task 6.1). (OpenH-RF RFP task 6.1 Generalized Reconstruction).
47
-
48
- ## Dataset Characterization
49
-
50
- - **Data Collection Method:** clinical
51
- - **Labeling Method:** N/A (raw channel data; no annotations).
52
- - **Acquisition system:** probe(s) L7-4;
53
- element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling
54
- frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
55
-
56
- ## Dataset Format
57
-
58
- All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single
59
- acquisition with raw channel data `/data/raw_data` of shape
60
- `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit
61
- sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1).
62
- No demodulation or decimation was applied during packaging beyond conversion from the USTB
63
- Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
64
-
65
- ## Dataset Quantification
66
-
67
- **Current OpenH-RF release:** 3 HDF5 files; 219.48 MB (219,480,064 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.
68
-
69
- - **Number of acquisitions:** 3
70
- - **Total channel-capture frames:** 6
71
- - **Train / validation / test split:** not predefined (research dataset).
72
- - **Stored HDF5 size:** 219.48 MB (219,480,064 bytes).
73
-
74
- Per-acquisition summary:
75
-
76
- | Acquisition | frames | transmits | samples | elements | n_ch | fs (MHz) | fc (MHz) | size (MB) |
77
- |---|---|---|---|---|---|---|---|---|
78
- | `L7_FI_carotid_cross_1` | 2 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 82.84 |
79
- | `L7_FI_carotid_cross_2` | 2 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 66.98 |
80
- | `L7_FI_carotid_cross_sub_2` | 2 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 69.66 |
81
-
82
- Per-sample feature table:
83
-
84
- | Field | Shape | Dtype | Units | Description |
85
- |---|---|---|---|---|
86
- | `data/raw_data` | `(n_frames, n_tx, n_ax, n_el, n_ch)` | float32 | a.u. | Raw pre-beamformed RF channel data |
87
- | `scan/sampling_frequency` | `scalar` | float32 | Hz | A/D sampling frequency |
88
- | `scan/center_frequency` | `scalar` | float32 | Hz | Transmit pulse center frequency |
89
- | `scan/demodulation_frequency` | `scalar` | float32 | Hz | Demodulation (carrier) frequency |
90
- | `scan/sound_speed` | `scalar` | float32 | m/s | Assumed medium speed of sound |
91
- | `scan/initial_times` | `(n_tx,)` | float32 | s | A/D start time per transmit |
92
- | `scan/t0_delays` | `(n_tx, n_el)` | float32 | s | Per-element transmit fire times |
93
- | `scan/tx_apodizations` | `(n_tx, n_el)` | float32 | - | Per-element transmit apodization |
94
- | `scan/focus_distances` | `(n_tx,)` | float32 | m | Focus distance per transmit (0 = plane wave) |
95
- | `scan/polar_angles` | `(n_tx,)` | float32 | rad | Transmit steering (polar) angle |
96
- | `scan/transmit_origins` | `(n_tx, 3)` | float32 | m | Transmit beam origin (x, y, z) |
97
- | `probe/probe_geometry` | `(n_el, 3)` | float32 | m | Element positions (x, y, z) |
98
-
99
- ## Subject Metadata
100
-
101
- Healthy adult volunteer(s). Anatomy: carotid artery (cross-section). Scanner: Verasonics Vantage 256. Probe: L7-4 linear array (128 elements). Aggregate only; no per-subject identifiers.
102
-
103
- ## Data Validation
104
-
105
- A Delay-And-Sum `zea.Pipeline` is provided in the **`pipeline.yaml` at the submission root** and
106
- run by the single **`reconstruct.py` at the submission root**:
107
- `cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`
108
- (RF is demodulated in-pipeline; IQ uses a baseband pipeline). The script is geometry-driven and
109
- recurses into every sub-dataset folder; running `python reconstruct.py` from the root reconstructs
110
- every `.hdf5` in the collection (or pass a folder-qualified path for a single acquisition) and writes
111
- `<name>_zea_bmode.png` next to each file as a portable check that the recorded geometry and timing
112
- are correct.
113
-
114
- The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the
115
- UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction
116
- used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with
117
- scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry.
118
- These are the recommended reference reconstructions for visual verification.
119
-
120
- ## Known Issues
121
-
122
- Single/few-frame acquisitions; focused linear imaging.
123
-
124
- ## Ethical Considerations
125
-
126
- In-vivo data recorded from healthy adult volunteers at the University of Oslo with written informed consent for research use and data sharing, and approval from the Regional Committee for Medical and Health Research Ethics (REK), Norway. Files contain only RF channel data and acquisition parameters; no HHS Safe Harbor identifiers are present.
 
1
+ ---
2
+ pretty_name: "USTB - In-vivo Carotid (Verasonics L7-4)"
3
+ license: cc-by-4.0
4
+ task_categories:
5
+ - image-to-image
6
+ language:
7
+ - en
8
+ tags:
9
+ - ultrasound
10
+ - rf
11
+ - openh-rf
12
+ - vascular
13
+ - carotid
14
+ - in-vivo
15
+ size_categories:
16
+ - n<1K
17
+ ---
18
+
19
+ # USTB - In-vivo Carotid (Verasonics L7-4)
20
+
21
+ Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** contributed to the
22
+ [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All acquisitions are stored in the
23
+ *zea* HDF5 file format (zea_version 0.1.6) and contain raw pre-beamformed
24
+ channel data (`/data/raw_data`).
25
+
26
+ ## Dataset Description
27
+
28
+ In-vivo human carotid-artery channel-capture data acquired with a Verasonics Vantage 256 and an L7-4 linear-array probe, cross-sectional views, focused transmit imaging. Pre-beamformed RF channel data for vascular imaging and beamforming research.
29
+
30
+ ## Dataset Contributors
31
+
32
+ University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius Hoel Rindal (omrindal@ifi.uio.no). Team: Ole Marius Hoel Rindal, Yucel Karabiyik, Sven Peter Nasholm, Andreas Austeng.
33
+
34
+ ## Dataset Creation Date
35
+
36
+ 06/23/2026 (packaging date; original acquisitions/simulations were produced between 2016 and 2023).
37
+
38
+ ## License / Terms of Use
39
+
40
+ Released under **Creative Commons Attribution 4.0 International (CC BY 4.0)** — see the `LICENCE`
41
+ file at the submission root (this license is also declared in the YAML frontmatter above). The
42
+ contributed data is cleared for this license. The UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo. Contributed to OpenH-RF. Zenodo record 20261898.
43
+
44
+ ## Intended Usage
45
+
46
+ Generalized reconstruction and adaptive beamforming of vascular ultrasound (RFP task 6.1). (OpenH-RF RFP task 6.1 Generalized Reconstruction).
47
+
48
+ ## Dataset Characterization
49
+
50
+ - **Data Collection Method:** clinical
51
+ - **Labeling Method:** N/A (raw channel data; no annotations).
52
+ - **Acquisition system:** probe(s) L7-4;
53
+ element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling
54
+ frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
55
+
56
+ ## Dataset Format
57
+
58
+ All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single
59
+ acquisition with raw channel data `/data/raw_data` of shape
60
+ `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit
61
+ sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1).
62
+ No demodulation or decimation was applied during packaging beyond conversion from the USTB
63
+ Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
64
+
65
+ ## Dataset Quantification
66
+
67
+ **Current OpenH-RF release:** 3 HDF5 files; 219.48 MB (219,480,064 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.
68
+
69
+ - **Number of acquisitions:** 3
70
+ - **Total channel-capture frames:** 6
71
+ - **Train / validation / test split:** not predefined (research dataset).
72
+ - **Stored HDF5 size:** 219.48 MB (219,480,064 bytes).
73
+
74
+ Per-acquisition summary:
75
+
76
+ | Acquisition | frames | transmits | samples | elements | n_ch | fs (MHz) | fc (MHz) | size (MB) |
77
+ |---|---|---|---|---|---|---|---|---|
78
+ | `L7_FI_carotid_cross_1` | 2 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 82.84 |
79
+ | `L7_FI_carotid_cross_2` | 2 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 66.98 |
80
+ | `L7_FI_carotid_cross_sub_2` | 2 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 69.66 |
81
+
82
+ Per-sample feature table:
83
+
84
+ | Field | Shape | Dtype | Units | Description |
85
+ |---|---|---|---|---|
86
+ | `data/raw_data` | `(n_frames, n_tx, n_ax, n_el, n_ch)` | float32 | a.u. | Raw pre-beamformed RF channel data |
87
+ | `scan/sampling_frequency` | `scalar` | float32 | Hz | A/D sampling frequency |
88
+ | `scan/center_frequency` | `scalar` | float32 | Hz | Transmit pulse center frequency |
89
+ | `scan/demodulation_frequency` | `scalar` | float32 | Hz | Demodulation (carrier) frequency |
90
+ | `scan/sound_speed` | `scalar` | float32 | m/s | Assumed medium speed of sound |
91
+ | `scan/initial_times` | `(n_tx,)` | float32 | s | A/D start time per transmit |
92
+ | `scan/t0_delays` | `(n_tx, n_el)` | float32 | s | Per-element transmit fire times |
93
+ | `scan/tx_apodizations` | `(n_tx, n_el)` | float32 | - | Per-element transmit apodization |
94
+ | `scan/focus_distances` | `(n_tx,)` | float32 | m | Focus distance per transmit (0 = plane wave) |
95
+ | `scan/polar_angles` | `(n_tx,)` | float32 | rad | Transmit steering (polar) angle |
96
+ | `scan/transmit_origins` | `(n_tx, 3)` | float32 | m | Transmit beam origin (x, y, z) |
97
+ | `probe/probe_geometry` | `(n_el, 3)` | float32 | m | Element positions (x, y, z) |
98
+
99
+ ## Subject Metadata
100
+
101
+ Healthy adult volunteer(s). Anatomy: carotid artery (cross-section). Scanner: Verasonics Vantage 256. Probe: L7-4 linear array (128 elements). Aggregate only; no per-subject identifiers.
102
+
103
+ ## Data Validation
104
+
105
+ A Delay-And-Sum `zea.Pipeline` is provided in the **`pipeline.yaml` at the submission root** and
106
+ run by the single **`reconstruct.py` at the submission root**:
107
+ `cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`
108
+ (RF is demodulated in-pipeline; IQ uses a baseband pipeline). The script is geometry-driven and
109
+ recurses into every sub-dataset folder; running `python reconstruct.py` from the root reconstructs
110
+ every `.hdf5` in the collection (or pass a folder-qualified path for a single acquisition) and writes
111
+ `<name>_zea_bmode.png` next to each file as a portable check that the recorded geometry and timing
112
+ are correct.
113
+
114
+ The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the
115
+ UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction
116
+ used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with
117
+ scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry.
118
+ These are the recommended reference reconstructions for visual verification.
119
+
120
+ ## Known Issues
121
+
122
+ Single/few-frame acquisitions; focused linear imaging.
123
+
124
+ ## Ethical Considerations
125
+
126
+ In-vivo data recorded from healthy adult volunteers at the University of Oslo with written informed consent for research use and data sharing, and approval from the Regional Committee for Medical and Health Research Ethics (REK), Norway. Files contain only RF channel data and acquisition parameters; no HHS Safe Harbor identifiers are present.
oslo/C_verasonics_phantom/README.md CHANGED
@@ -1,137 +1,137 @@
1
- ---
2
- pretty_name: "USTB - Phantom (Verasonics L7-4 / P4)"
3
- license: cc-by-4.0
4
- task_categories:
5
- - image-to-image
6
- language:
7
- - en
8
- tags:
9
- - ultrasound
10
- - rf
11
- - openh-rf
12
- - phantom
13
- - cirs
14
- size_categories:
15
- - n<1K
16
- ---
17
-
18
- # USTB - Phantom (Verasonics L7-4 / P4)
19
-
20
- Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** contributed to the
21
- [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All acquisitions are stored in the
22
- *zea* HDF5 file format (zea_version 0.1.6) and contain raw pre-beamformed
23
- channel data (`/data/raw_data`).
24
-
25
- ## Dataset Description
26
-
27
- Tissue-mimicking and table-top phantom channel-capture data acquired on a Verasonics Vantage 256 with L7-4 linear and P4 phased-array probes. The collection spans coherent plane-wave compounding (CPWC), focused imaging (FI), synthetic transmit aperture (STA) and diverging-wave (DW) sequences for resolution, contrast, dynamic-range and point-spread-function evaluation, including CIRS tissue-mimicking phantom targets.
28
-
29
- ## Dataset Contributors
30
-
31
- University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius Hoel Rindal (omrindal@ifi.uio.no). Team: Ole Marius Hoel Rindal, Yucel Karabiyik, Sven Peter Nasholm, Andreas Austeng.
32
-
33
- ## Dataset Creation Date
34
-
35
- 06/23/2026 (packaging date; original acquisitions/simulations were produced between 2016 and 2023).
36
-
37
- ## License / Terms of Use
38
-
39
- Released under **Creative Commons Attribution 4.0 International (CC BY 4.0)** — see the `LICENCE`
40
- file at the submission root (this license is also declared in the YAML frontmatter above). The
41
- contributed data is cleared for this license. The UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo. Contributed to OpenH-RF. Zenodo record 20261898.
42
-
43
- ## Intended Usage
44
-
45
- Generalized reconstruction, image-quality assessment (resolution, contrast, dynamic range), and beamforming research (RFP task 6.1). Several acquisitions provide multiple transmit schemes on the same target for cross-method comparison. (OpenH-RF RFP task 6.1 Generalized Reconstruction).
46
-
47
- ## Dataset Characterization
48
-
49
- - **Data Collection Method:** phantom
50
- - **Labeling Method:** Derived (known phantom geometry, e.g. CIRS Model 040GSE where applicable).
51
- - **Acquisition system:** probe(s) L7-4, P4-1, P4-2;
52
- element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling
53
- frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
54
-
55
- ## Dataset Format
56
-
57
- All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single
58
- acquisition with raw channel data `/data/raw_data` of shape
59
- `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit
60
- sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1).
61
- No demodulation or decimation was applied during packaging beyond conversion from the USTB
62
- Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
63
-
64
- ## Dataset Quantification
65
-
66
- **Current OpenH-RF release:** 15 HDF5 files; 1.06 GB (1,058,734,080 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.
67
-
68
- - **Number of acquisitions:** 15
69
- - **Total channel-capture frames:** 27
70
- - **Train / validation / test split:** not predefined (research dataset).
71
- - **Stored HDF5 size:** 1.06 GB (1,058,734,080 bytes).
72
-
73
- Per-acquisition summary:
74
-
75
- | Acquisition | frames | transmits | samples | elements | n_ch | fs (MHz) | fc (MHz) | size (MB) |
76
- |---|---|---|---|---|---|---|---|---|
77
- | `experimental_dynamic_range_phantom` | 1 | 128 | 3840 | 128 | 1 | 40.8 | 5.00 | 218.23 |
78
- | `experimental_STAI_dynamic_range` | 1 | 128 | 1920 | 128 | 1 | 20.4 | 5.00 | 109.38 |
79
- | `FI_P4_cysts_center` | 1 | 128 | 2048 | 64 | 1 | 10.9 | 2.72 | 22.09 |
80
- | `FI_P4_point_scatterers` | 6 | 128 | 1792 | 64 | 1 | 10.9 | 2.72 | 115.74 |
81
- | `L7_CPWC_193328` | 3 | 15 | 1920 | 128 | 1 | 20.8 | 5.20 | 27.00 |
82
- | `L7_CPWC_TheGB` | 1 | 11 | 1920 | 128 | 1 | 20.8 | 5.00 | 4.39 |
83
- | `L7_DW_TheGB` | 1 | 25 | 1920 | 128 | 1 | 20.8 | 5.21 | 8.13 |
84
- | `L7_FI_IUS2018` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 32.44 |
85
- | `L7_FI_TheGB` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 30.34 |
86
- | `L7_FI_Verasonics` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 110.23 |
87
- | `L7_FI_Verasonics_CIRS` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 109.90 |
88
- | `L7_FI_Verasonics_CIRS_points` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 110.23 |
89
- | `L7_STA_TheGB` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.00 | 28.97 |
90
- | `P4_FI_121444_45mm_focus` | 6 | 128 | 1280 | 64 | 1 | 11.9 | 2.98 | 94.24 |
91
- | `STAI_UFF_CIRS_phantom` | 1 | 128 | 2688 | 128 | 1 | 20.8 | 5.00 | 37.42 |
92
-
93
- Per-sample feature table:
94
-
95
- | Field | Shape | Dtype | Units | Description |
96
- |---|---|---|---|---|
97
- | `data/raw_data` | `(n_frames, n_tx, n_ax, n_el, n_ch)` | float32 | a.u. | Raw pre-beamformed RF channel data |
98
- | `scan/sampling_frequency` | `scalar` | float32 | Hz | A/D sampling frequency |
99
- | `scan/center_frequency` | `scalar` | float32 | Hz | Transmit pulse center frequency |
100
- | `scan/demodulation_frequency` | `scalar` | float32 | Hz | Demodulation (carrier) frequency |
101
- | `scan/sound_speed` | `scalar` | float32 | m/s | Assumed medium speed of sound |
102
- | `scan/initial_times` | `(n_tx,)` | float32 | s | A/D start time per transmit |
103
- | `scan/t0_delays` | `(n_tx, n_el)` | float32 | s | Per-element transmit fire times |
104
- | `scan/tx_apodizations` | `(n_tx, n_el)` | float32 | - | Per-element transmit apodization |
105
- | `scan/focus_distances` | `(n_tx,)` | float32 | m | Focus distance per transmit (0 = plane wave) |
106
- | `scan/polar_angles` | `(n_tx,)` | float32 | rad | Transmit steering (polar) angle |
107
- | `scan/transmit_origins` | `(n_tx, 3)` | float32 | m | Transmit beam origin (x, y, z) |
108
- | `probe/probe_geometry` | `(n_el, 3)` | float32 | m | Element positions (x, y, z) |
109
-
110
- ## Subject Metadata
111
-
112
- No human or animal subjects. Targets: CIRS tissue-mimicking phantoms and lab phantoms (wire/point targets, hypo/hyperechoic inclusions, dynamic-range targets). Probes: L7-4 (128 el.), P4 phased array.
113
-
114
- ## Data Validation
115
-
116
- A Delay-And-Sum `zea.Pipeline` is provided in the **`pipeline.yaml` at the submission root** and
117
- run by the single **`reconstruct.py` at the submission root**:
118
- `cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`
119
- (RF is demodulated in-pipeline; IQ uses a baseband pipeline). The script is geometry-driven and
120
- recurses into every sub-dataset folder; running `python reconstruct.py` from the root reconstructs
121
- every `.hdf5` in the collection (or pass a folder-qualified path for a single acquisition) and writes
122
- `<name>_zea_bmode.png` next to each file as a portable check that the recorded geometry and timing
123
- are correct.
124
-
125
- The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the
126
- UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction
127
- used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with
128
- scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry.
129
- These are the recommended reference reconstructions for visual verification.
130
-
131
- ## Known Issues
132
-
133
- Mixed transmit schemes across files (CPWC / FI / STA / DW). Single-frame acquisitions for most phantoms. The reference reconstruction uses a single B-mode pipeline; per-scheme tuning may improve image quality.
134
-
135
- ## Ethical Considerations
136
-
137
- Phantom / table-top acquisitions; no human or animal subjects are involved. No ethical considerations beyond standard laboratory practice.
 
1
+ ---
2
+ pretty_name: "USTB - Phantom (Verasonics L7-4 / P4)"
3
+ license: cc-by-4.0
4
+ task_categories:
5
+ - image-to-image
6
+ language:
7
+ - en
8
+ tags:
9
+ - ultrasound
10
+ - rf
11
+ - openh-rf
12
+ - phantom
13
+ - cirs
14
+ size_categories:
15
+ - n<1K
16
+ ---
17
+
18
+ # USTB - Phantom (Verasonics L7-4 / P4)
19
+
20
+ Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** contributed to the
21
+ [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All acquisitions are stored in the
22
+ *zea* HDF5 file format (zea_version 0.1.6) and contain raw pre-beamformed
23
+ channel data (`/data/raw_data`).
24
+
25
+ ## Dataset Description
26
+
27
+ Tissue-mimicking and table-top phantom channel-capture data acquired on a Verasonics Vantage 256 with L7-4 linear and P4 phased-array probes. The collection spans coherent plane-wave compounding (CPWC), focused imaging (FI), synthetic transmit aperture (STA) and diverging-wave (DW) sequences for resolution, contrast, dynamic-range and point-spread-function evaluation, including CIRS tissue-mimicking phantom targets.
28
+
29
+ ## Dataset Contributors
30
+
31
+ University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius Hoel Rindal (omrindal@ifi.uio.no). Team: Ole Marius Hoel Rindal, Yucel Karabiyik, Sven Peter Nasholm, Andreas Austeng.
32
+
33
+ ## Dataset Creation Date
34
+
35
+ 06/23/2026 (packaging date; original acquisitions/simulations were produced between 2016 and 2023).
36
+
37
+ ## License / Terms of Use
38
+
39
+ Released under **Creative Commons Attribution 4.0 International (CC BY 4.0)** — see the `LICENCE`
40
+ file at the submission root (this license is also declared in the YAML frontmatter above). The
41
+ contributed data is cleared for this license. The UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo. Contributed to OpenH-RF. Zenodo record 20261898.
42
+
43
+ ## Intended Usage
44
+
45
+ Generalized reconstruction, image-quality assessment (resolution, contrast, dynamic range), and beamforming research (RFP task 6.1). Several acquisitions provide multiple transmit schemes on the same target for cross-method comparison. (OpenH-RF RFP task 6.1 Generalized Reconstruction).
46
+
47
+ ## Dataset Characterization
48
+
49
+ - **Data Collection Method:** phantom
50
+ - **Labeling Method:** Derived (known phantom geometry, e.g. CIRS Model 040GSE where applicable).
51
+ - **Acquisition system:** probe(s) L7-4, P4-1, P4-2;
52
+ element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling
53
+ frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
54
+
55
+ ## Dataset Format
56
+
57
+ All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single
58
+ acquisition with raw channel data `/data/raw_data` of shape
59
+ `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit
60
+ sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1).
61
+ No demodulation or decimation was applied during packaging beyond conversion from the USTB
62
+ Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
63
+
64
+ ## Dataset Quantification
65
+
66
+ **Current OpenH-RF release:** 15 HDF5 files; 1.06 GB (1,058,734,080 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.
67
+
68
+ - **Number of acquisitions:** 15
69
+ - **Total channel-capture frames:** 27
70
+ - **Train / validation / test split:** not predefined (research dataset).
71
+ - **Stored HDF5 size:** 1.06 GB (1,058,734,080 bytes).
72
+
73
+ Per-acquisition summary:
74
+
75
+ | Acquisition | frames | transmits | samples | elements | n_ch | fs (MHz) | fc (MHz) | size (MB) |
76
+ |---|---|---|---|---|---|---|---|---|
77
+ | `experimental_dynamic_range_phantom` | 1 | 128 | 3840 | 128 | 1 | 40.8 | 5.00 | 218.23 |
78
+ | `experimental_STAI_dynamic_range` | 1 | 128 | 1920 | 128 | 1 | 20.4 | 5.00 | 109.38 |
79
+ | `FI_P4_cysts_center` | 1 | 128 | 2048 | 64 | 1 | 10.9 | 2.72 | 22.09 |
80
+ | `FI_P4_point_scatterers` | 6 | 128 | 1792 | 64 | 1 | 10.9 | 2.72 | 115.74 |
81
+ | `L7_CPWC_193328` | 3 | 15 | 1920 | 128 | 1 | 20.8 | 5.20 | 27.00 |
82
+ | `L7_CPWC_TheGB` | 1 | 11 | 1920 | 128 | 1 | 20.8 | 5.00 | 4.39 |
83
+ | `L7_DW_TheGB` | 1 | 25 | 1920 | 128 | 1 | 20.8 | 5.21 | 8.13 |
84
+ | `L7_FI_IUS2018` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 32.44 |
85
+ | `L7_FI_TheGB` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 30.34 |
86
+ | `L7_FI_Verasonics` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 110.23 |
87
+ | `L7_FI_Verasonics_CIRS` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 109.90 |
88
+ | `L7_FI_Verasonics_CIRS_points` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.21 | 110.23 |
89
+ | `L7_STA_TheGB` | 1 | 128 | 1920 | 128 | 1 | 20.8 | 5.00 | 28.97 |
90
+ | `P4_FI_121444_45mm_focus` | 6 | 128 | 1280 | 64 | 1 | 11.9 | 2.98 | 94.24 |
91
+ | `STAI_UFF_CIRS_phantom` | 1 | 128 | 2688 | 128 | 1 | 20.8 | 5.00 | 37.42 |
92
+
93
+ Per-sample feature table:
94
+
95
+ | Field | Shape | Dtype | Units | Description |
96
+ |---|---|---|---|---|
97
+ | `data/raw_data` | `(n_frames, n_tx, n_ax, n_el, n_ch)` | float32 | a.u. | Raw pre-beamformed RF channel data |
98
+ | `scan/sampling_frequency` | `scalar` | float32 | Hz | A/D sampling frequency |
99
+ | `scan/center_frequency` | `scalar` | float32 | Hz | Transmit pulse center frequency |
100
+ | `scan/demodulation_frequency` | `scalar` | float32 | Hz | Demodulation (carrier) frequency |
101
+ | `scan/sound_speed` | `scalar` | float32 | m/s | Assumed medium speed of sound |
102
+ | `scan/initial_times` | `(n_tx,)` | float32 | s | A/D start time per transmit |
103
+ | `scan/t0_delays` | `(n_tx, n_el)` | float32 | s | Per-element transmit fire times |
104
+ | `scan/tx_apodizations` | `(n_tx, n_el)` | float32 | - | Per-element transmit apodization |
105
+ | `scan/focus_distances` | `(n_tx,)` | float32 | m | Focus distance per transmit (0 = plane wave) |
106
+ | `scan/polar_angles` | `(n_tx,)` | float32 | rad | Transmit steering (polar) angle |
107
+ | `scan/transmit_origins` | `(n_tx, 3)` | float32 | m | Transmit beam origin (x, y, z) |
108
+ | `probe/probe_geometry` | `(n_el, 3)` | float32 | m | Element positions (x, y, z) |
109
+
110
+ ## Subject Metadata
111
+
112
+ No human or animal subjects. Targets: CIRS tissue-mimicking phantoms and lab phantoms (wire/point targets, hypo/hyperechoic inclusions, dynamic-range targets). Probes: L7-4 (128 el.), P4 phased array.
113
+
114
+ ## Data Validation
115
+
116
+ A Delay-And-Sum `zea.Pipeline` is provided in the **`pipeline.yaml` at the submission root** and
117
+ run by the single **`reconstruct.py` at the submission root**:
118
+ `cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`
119
+ (RF is demodulated in-pipeline; IQ uses a baseband pipeline). The script is geometry-driven and
120
+ recurses into every sub-dataset folder; running `python reconstruct.py` from the root reconstructs
121
+ every `.hdf5` in the collection (or pass a folder-qualified path for a single acquisition) and writes
122
+ `<name>_zea_bmode.png` next to each file as a portable check that the recorded geometry and timing
123
+ are correct.
124
+
125
+ The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the
126
+ UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction
127
+ used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with
128
+ scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry.
129
+ These are the recommended reference reconstructions for visual verification.
130
+
131
+ ## Known Issues
132
+
133
+ Mixed transmit schemes across files (CPWC / FI / STA / DW). Single-frame acquisitions for most phantoms. The reference reconstruction uses a single B-mode pipeline; per-scheme tuning may improve image quality.
134
+
135
+ ## Ethical Considerations
136
+
137
+ Phantom / table-top acquisitions; no human or animal subjects are involved. No ethical considerations beyond standard laboratory practice.
oslo/D_alpinion_phantom/README.md CHANGED
@@ -1,126 +1,126 @@
1
- ---
2
- pretty_name: "USTB - Phantom (Alpinion L3-8)"
3
- license: cc-by-4.0
4
- task_categories:
5
- - image-to-image
6
- language:
7
- - en
8
- tags:
9
- - ultrasound
10
- - rf
11
- - openh-rf
12
- - phantom
13
- - alpinion
14
- size_categories:
15
- - n<1K
16
- ---
17
-
18
- # USTB - Phantom (Alpinion L3-8)
19
-
20
- Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** contributed to the
21
- [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All acquisitions are stored in the
22
- *zea* HDF5 file format (zea_version 0.1.6) and contain raw pre-beamformed
23
- channel data (`/data/raw_data`).
24
-
25
- ## Dataset Description
26
-
27
- Phantom channel-capture data acquired on an Alpinion E-Cube 12R research scanner with an L3-8 linear-array probe. Hypoechoic and hyperechoic targets imaged with focused (FI) and coherent plane-wave compounding (CPWC) sequences.
28
-
29
- ## Dataset Contributors
30
-
31
- University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius Hoel Rindal (omrindal@ifi.uio.no). Team: Ole Marius Hoel Rindal, Yucel Karabiyik, Sven Peter Nasholm, Andreas Austeng.
32
-
33
- ## Dataset Creation Date
34
-
35
- 06/23/2026 (packaging date; original acquisitions/simulations were produced between 2016 and 2023).
36
-
37
- ## License / Terms of Use
38
-
39
- Released under **Creative Commons Attribution 4.0 International (CC BY 4.0)** — see the `LICENCE`
40
- file at the submission root (this license is also declared in the YAML frontmatter above). The
41
- contributed data is cleared for this license. The UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo. Contributed to OpenH-RF. Zenodo record 20261898.
42
-
43
- ## Intended Usage
44
-
45
- Generalized reconstruction and image-quality assessment on a second hardware platform (RFP task 6.1); cross-vendor robustness studies. (OpenH-RF RFP task 6.1 Generalized Reconstruction).
46
-
47
- ## Dataset Characterization
48
-
49
- - **Data Collection Method:** phantom
50
- - **Labeling Method:** Derived (known phantom target types).
51
- - **Acquisition system:** probe(s) L3-8;
52
- element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling
53
- frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
54
-
55
- ## Dataset Format
56
-
57
- All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single
58
- acquisition with raw channel data `/data/raw_data` of shape
59
- `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit
60
- sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1).
61
- No demodulation or decimation was applied during packaging beyond conversion from the USTB
62
- Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
63
-
64
- ## Dataset Quantification
65
-
66
- **Current OpenH-RF release:** 4 HDF5 files; 466.42 MB (466,419,712 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.
67
-
68
- - **Number of acquisitions:** 4
69
- - **Total channel-capture frames:** 4
70
- - **Train / validation / test split:** not predefined (research dataset).
71
- - **Stored HDF5 size:** 466.42 MB (466,419,712 bytes).
72
-
73
- Per-acquisition summary:
74
-
75
- | Acquisition | frames | transmits | samples | elements | n_ch | fs (MHz) | fc (MHz) | size (MB) |
76
- |---|---|---|---|---|---|---|---|---|
77
- | `Alpinion_L3-8_CPWC_hyperechoic_scatterers` | 1 | 21 | 4352 | 128 | 1 | 40.0 | 6.00 | 40.89 |
78
- | `Alpinion_L3-8_CPWC_hypoechoic` | 1 | 21 | 4352 | 128 | 1 | 40.0 | 6.00 | 40.96 |
79
- | `Alpinion_L3-8_FI_hyperechoic_scatterers` | 1 | 256 | 3474 | 128 | 1 | 40.0 | 6.00 | 192.35 |
80
- | `Alpinion_L3-8_FI_hypoechoic` | 1 | 256 | 3474 | 128 | 1 | 40.0 | 6.00 | 192.22 |
81
-
82
- Per-sample feature table:
83
-
84
- | Field | Shape | Dtype | Units | Description |
85
- |---|---|---|---|---|
86
- | `data/raw_data` | `(n_frames, n_tx, n_ax, n_el, n_ch)` | float32 | a.u. | Raw pre-beamformed RF channel data |
87
- | `scan/sampling_frequency` | `scalar` | float32 | Hz | A/D sampling frequency |
88
- | `scan/center_frequency` | `scalar` | float32 | Hz | Transmit pulse center frequency |
89
- | `scan/demodulation_frequency` | `scalar` | float32 | Hz | Demodulation (carrier) frequency |
90
- | `scan/sound_speed` | `scalar` | float32 | m/s | Assumed medium speed of sound |
91
- | `scan/initial_times` | `(n_tx,)` | float32 | s | A/D start time per transmit |
92
- | `scan/t0_delays` | `(n_tx, n_el)` | float32 | s | Per-element transmit fire times |
93
- | `scan/tx_apodizations` | `(n_tx, n_el)` | float32 | - | Per-element transmit apodization |
94
- | `scan/focus_distances` | `(n_tx,)` | float32 | m | Focus distance per transmit (0 = plane wave) |
95
- | `scan/polar_angles` | `(n_tx,)` | float32 | rad | Transmit steering (polar) angle |
96
- | `scan/transmit_origins` | `(n_tx, 3)` | float32 | m | Transmit beam origin (x, y, z) |
97
- | `probe/probe_geometry` | `(n_el, 3)` | float32 | m | Element positions (x, y, z) |
98
-
99
- ## Subject Metadata
100
-
101
- No human or animal subjects. Targets: hypoechoic/hyperechoic phantom inclusions. Scanner: Alpinion E-Cube 12R. Probe: L3-8 linear array (128 elements).
102
-
103
- ## Data Validation
104
-
105
- A Delay-And-Sum `zea.Pipeline` is provided in the **`pipeline.yaml` at the submission root** and
106
- run by the single **`reconstruct.py` at the submission root**:
107
- `cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`
108
- (RF is demodulated in-pipeline; IQ uses a baseband pipeline). The script is geometry-driven and
109
- recurses into every sub-dataset folder; running `python reconstruct.py` from the root reconstructs
110
- every `.hdf5` in the collection (or pass a folder-qualified path for a single acquisition) and writes
111
- `<name>_zea_bmode.png` next to each file as a portable check that the recorded geometry and timing
112
- are correct.
113
-
114
- The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the
115
- UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction
116
- used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with
117
- scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry.
118
- These are the recommended reference reconstructions for visual verification.
119
-
120
- ## Known Issues
121
-
122
- Single-frame acquisitions; two transmit schemes (FI, CPWC).
123
-
124
- ## Ethical Considerations
125
-
126
- Phantom acquisitions; no human or animal subjects. No ethical considerations beyond standard laboratory practice.
 
1
+ ---
2
+ pretty_name: "USTB - Phantom (Alpinion L3-8)"
3
+ license: cc-by-4.0
4
+ task_categories:
5
+ - image-to-image
6
+ language:
7
+ - en
8
+ tags:
9
+ - ultrasound
10
+ - rf
11
+ - openh-rf
12
+ - phantom
13
+ - alpinion
14
+ size_categories:
15
+ - n<1K
16
+ ---
17
+
18
+ # USTB - Phantom (Alpinion L3-8)
19
+
20
+ Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** contributed to the
21
+ [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All acquisitions are stored in the
22
+ *zea* HDF5 file format (zea_version 0.1.6) and contain raw pre-beamformed
23
+ channel data (`/data/raw_data`).
24
+
25
+ ## Dataset Description
26
+
27
+ Phantom channel-capture data acquired on an Alpinion E-Cube 12R research scanner with an L3-8 linear-array probe. Hypoechoic and hyperechoic targets imaged with focused (FI) and coherent plane-wave compounding (CPWC) sequences.
28
+
29
+ ## Dataset Contributors
30
+
31
+ University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius Hoel Rindal (omrindal@ifi.uio.no). Team: Ole Marius Hoel Rindal, Yucel Karabiyik, Sven Peter Nasholm, Andreas Austeng.
32
+
33
+ ## Dataset Creation Date
34
+
35
+ 06/23/2026 (packaging date; original acquisitions/simulations were produced between 2016 and 2023).
36
+
37
+ ## License / Terms of Use
38
+
39
+ Released under **Creative Commons Attribution 4.0 International (CC BY 4.0)** — see the `LICENCE`
40
+ file at the submission root (this license is also declared in the YAML frontmatter above). The
41
+ contributed data is cleared for this license. The UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo. Contributed to OpenH-RF. Zenodo record 20261898.
42
+
43
+ ## Intended Usage
44
+
45
+ Generalized reconstruction and image-quality assessment on a second hardware platform (RFP task 6.1); cross-vendor robustness studies. (OpenH-RF RFP task 6.1 Generalized Reconstruction).
46
+
47
+ ## Dataset Characterization
48
+
49
+ - **Data Collection Method:** phantom
50
+ - **Labeling Method:** Derived (known phantom target types).
51
+ - **Acquisition system:** probe(s) L3-8;
52
+ element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling
53
+ frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
54
+
55
+ ## Dataset Format
56
+
57
+ All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single
58
+ acquisition with raw channel data `/data/raw_data` of shape
59
+ `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit
60
+ sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1).
61
+ No demodulation or decimation was applied during packaging beyond conversion from the USTB
62
+ Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
63
+
64
+ ## Dataset Quantification
65
+
66
+ **Current OpenH-RF release:** 4 HDF5 files; 466.42 MB (466,419,712 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.
67
+
68
+ - **Number of acquisitions:** 4
69
+ - **Total channel-capture frames:** 4
70
+ - **Train / validation / test split:** not predefined (research dataset).
71
+ - **Stored HDF5 size:** 466.42 MB (466,419,712 bytes).
72
+
73
+ Per-acquisition summary:
74
+
75
+ | Acquisition | frames | transmits | samples | elements | n_ch | fs (MHz) | fc (MHz) | size (MB) |
76
+ |---|---|---|---|---|---|---|---|---|
77
+ | `Alpinion_L3-8_CPWC_hyperechoic_scatterers` | 1 | 21 | 4352 | 128 | 1 | 40.0 | 6.00 | 40.89 |
78
+ | `Alpinion_L3-8_CPWC_hypoechoic` | 1 | 21 | 4352 | 128 | 1 | 40.0 | 6.00 | 40.96 |
79
+ | `Alpinion_L3-8_FI_hyperechoic_scatterers` | 1 | 256 | 3474 | 128 | 1 | 40.0 | 6.00 | 192.35 |
80
+ | `Alpinion_L3-8_FI_hypoechoic` | 1 | 256 | 3474 | 128 | 1 | 40.0 | 6.00 | 192.22 |
81
+
82
+ Per-sample feature table:
83
+
84
+ | Field | Shape | Dtype | Units | Description |
85
+ |---|---|---|---|---|
86
+ | `data/raw_data` | `(n_frames, n_tx, n_ax, n_el, n_ch)` | float32 | a.u. | Raw pre-beamformed RF channel data |
87
+ | `scan/sampling_frequency` | `scalar` | float32 | Hz | A/D sampling frequency |
88
+ | `scan/center_frequency` | `scalar` | float32 | Hz | Transmit pulse center frequency |
89
+ | `scan/demodulation_frequency` | `scalar` | float32 | Hz | Demodulation (carrier) frequency |
90
+ | `scan/sound_speed` | `scalar` | float32 | m/s | Assumed medium speed of sound |
91
+ | `scan/initial_times` | `(n_tx,)` | float32 | s | A/D start time per transmit |
92
+ | `scan/t0_delays` | `(n_tx, n_el)` | float32 | s | Per-element transmit fire times |
93
+ | `scan/tx_apodizations` | `(n_tx, n_el)` | float32 | - | Per-element transmit apodization |
94
+ | `scan/focus_distances` | `(n_tx,)` | float32 | m | Focus distance per transmit (0 = plane wave) |
95
+ | `scan/polar_angles` | `(n_tx,)` | float32 | rad | Transmit steering (polar) angle |
96
+ | `scan/transmit_origins` | `(n_tx, 3)` | float32 | m | Transmit beam origin (x, y, z) |
97
+ | `probe/probe_geometry` | `(n_el, 3)` | float32 | m | Element positions (x, y, z) |
98
+
99
+ ## Subject Metadata
100
+
101
+ No human or animal subjects. Targets: hypoechoic/hyperechoic phantom inclusions. Scanner: Alpinion E-Cube 12R. Probe: L3-8 linear array (128 elements).
102
+
103
+ ## Data Validation
104
+
105
+ A Delay-And-Sum `zea.Pipeline` is provided in the **`pipeline.yaml` at the submission root** and
106
+ run by the single **`reconstruct.py` at the submission root**:
107
+ `cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`
108
+ (RF is demodulated in-pipeline; IQ uses a baseband pipeline). The script is geometry-driven and
109
+ recurses into every sub-dataset folder; running `python reconstruct.py` from the root reconstructs
110
+ every `.hdf5` in the collection (or pass a folder-qualified path for a single acquisition) and writes
111
+ `<name>_zea_bmode.png` next to each file as a portable check that the recorded geometry and timing
112
+ are correct.
113
+
114
+ The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the
115
+ UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction
116
+ used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with
117
+ scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry.
118
+ These are the recommended reference reconstructions for visual verification.
119
+
120
+ ## Known Issues
121
+
122
+ Single-frame acquisitions; two transmit schemes (FI, CPWC).
123
+
124
+ ## Ethical Considerations
125
+
126
+ Phantom acquisitions; no human or animal subjects. No ethical considerations beyond standard laboratory practice.
oslo/E_simulation/README.md CHANGED
@@ -1,134 +1,134 @@
1
- ---
2
- pretty_name: "USTB - Simulation (Field II)"
3
- license: cc-by-4.0
4
- task_categories:
5
- - image-to-image
6
- language:
7
- - en
8
- tags:
9
- - ultrasound
10
- - rf
11
- - openh-rf
12
- - simulation
13
- - field-ii
14
- - synthetic
15
- size_categories:
16
- - n<1K
17
- ---
18
-
19
- # USTB - Simulation (Field II)
20
-
21
- Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** contributed to the
22
- [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All acquisitions are stored in the
23
- *zea* HDF5 file format (zea_version 0.1.6) and contain raw pre-beamformed
24
- channel data (`/data/raw_data`).
25
-
26
- ## Dataset Description
27
-
28
- Physics-based synthetic channel-capture data generated with the Field II ultrasound simulation framework. The collection covers point scatterers, cysts, speckle, dynamic-range targets and blocked-array (aperture-apodized) configurations, using linear (L7-4-like) and phased (P4-like) virtual probes with CPWC, FI and STA sequences. Because the scattering medium is fully defined, exact ground-truth scatterer positions and medium parameters are known. One numerical calibration acquisition (PICMUS_numerical_calib_v2) was created in collaboration with our group as part of the PICMUS effort; it is included here while the other PICMUS datasets are excluded (see Known Issues).
29
-
30
- ## Dataset Contributors
31
-
32
- University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius Hoel Rindal (omrindal@ifi.uio.no). Team: Ole Marius Hoel Rindal, Yucel Karabiyik, Sven Peter Nasholm, Andreas Austeng.
33
-
34
- ## Dataset Creation Date
35
-
36
- 06/23/2026 (packaging date; original acquisitions/simulations were produced between 2016 and 2023).
37
-
38
- ## License / Terms of Use
39
-
40
- Released under **Creative Commons Attribution 4.0 International (CC BY 4.0)** — see the `LICENCE`
41
- file at the submission root (this license is also declared in the YAML frontmatter above). The
42
- contributed data is cleared for this license. The UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo. Contributed to OpenH-RF. Zenodo record 20261898.
43
-
44
- ## Intended Usage
45
-
46
- Generalized reconstruction, beamformer development and validation with known ground truth (RFP task 6.1); resolution/contrast/dynamic-range characterization; training/validation of learned reconstruction methods. (OpenH-RF RFP task 6.1 Generalized Reconstruction).
47
-
48
- ## Dataset Characterization
49
-
50
- - **Data Collection Method:** synthetic
51
- - **Labeling Method:** Synthetic ground truth (known scatterer positions and medium parameters).
52
- - **Acquisition system:** probe(s) L7-4, P4-1;
53
- element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling
54
- frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
55
-
56
- ## Dataset Format
57
-
58
- All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single
59
- acquisition with raw channel data `/data/raw_data` of shape
60
- `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit
61
- sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF/IQ (n_ch in [1, 2]).
62
- No demodulation or decimation was applied during packaging beyond conversion from the USTB
63
- Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
64
-
65
- ## Dataset Quantification
66
-
67
- **Current OpenH-RF release:** 11 HDF5 files; 2.98 GB (2,980,642,816 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.
68
-
69
- - **Number of acquisitions:** 11
70
- - **Total channel-capture frames:** 17
71
- - **Train / validation / test split:** not predefined (research dataset).
72
- - **Stored HDF5 size:** 2.98 GB (2,980,642,816 bytes).
73
-
74
- Per-acquisition summary:
75
-
76
- | Acquisition | frames | transmits | samples | elements | n_ch | fs (MHz) | fc (MHz) | size (MB) |
77
- |---|---|---|---|---|---|---|---|---|
78
- | `FieldII_CPWC_point_scatterers_res_v2` | 7 | 1 | 7792 | 128 | 1 | 100.0 | 5.16 | 2.10 |
79
- | `FieldII_CPWC_simulation_v2` | 1 | 1 | 6494 | 128 | 1 | 100.0 | 5.13 | 0.92 |
80
- | `FieldII_P4_point_scatterers` | 1 | 128 | 14349 | 64 | 1 | 100.0 | 2.56 | 406.13 |
81
- | `FieldII_speckle_DMASsimulation300000pts` | 1 | 96 | 10570 | 128 | 1 | 100.0 | 3.50 | 200.67 |
82
- | `FieldII_STAI_dynamic_range` | 1 | 128 | 7792 | 128 | 1 | 100.0 | 5.13 | 355.40 |
83
- | `FieldII_STAI_simulated_dynamic_range` | 1 | 128 | 7792 | 128 | 1 | 100.0 | 5.13 | 347.60 |
84
- | `FieldII_STAI_uniform_fov` | 1 | 128 | 2771 | 128 | 1 | 25.0 | 5.13 | 125.57 |
85
- | `PICMUS_numerical_calib_v2` | 1 | 5 | 445 | 128 | 2 | 5.2 | 5.21 | 2.16 |
86
- | `speckle_sim_FI_P4_probe_apod_1_speckle_long_many_angles` | 1 | 150 | 15786 | 64 | 1 | 100.0 | 2.56 | 506.40 |
87
- | `speckle_sim_FI_P4_probe_apod_2_speckle_long_many_angles` | 1 | 150 | 15786 | 64 | 1 | 100.0 | 2.56 | 512.49 |
88
- | `speckle_sim_FI_P4_probe_apod_3_speckle_long_many_angles` | 1 | 150 | 15786 | 64 | 1 | 100.0 | 2.56 | 521.21 |
89
-
90
- Per-sample feature table:
91
-
92
- | Field | Shape | Dtype | Units | Description |
93
- |---|---|---|---|---|
94
- | `data/raw_data` | `(n_frames, n_tx, n_ax, n_el, n_ch)` | float32 | a.u. | Raw pre-beamformed RF channel data |
95
- | `scan/sampling_frequency` | `scalar` | float32 | Hz | A/D sampling frequency |
96
- | `scan/center_frequency` | `scalar` | float32 | Hz | Transmit pulse center frequency |
97
- | `scan/demodulation_frequency` | `scalar` | float32 | Hz | Demodulation (carrier) frequency |
98
- | `scan/sound_speed` | `scalar` | float32 | m/s | Assumed medium speed of sound |
99
- | `scan/initial_times` | `(n_tx,)` | float32 | s | A/D start time per transmit |
100
- | `scan/t0_delays` | `(n_tx, n_el)` | float32 | s | Per-element transmit fire times |
101
- | `scan/tx_apodizations` | `(n_tx, n_el)` | float32 | - | Per-element transmit apodization |
102
- | `scan/focus_distances` | `(n_tx,)` | float32 | m | Focus distance per transmit (0 = plane wave) |
103
- | `scan/polar_angles` | `(n_tx,)` | float32 | rad | Transmit steering (polar) angle |
104
- | `scan/transmit_origins` | `(n_tx, 3)` | float32 | m | Transmit beam origin (x, y, z) |
105
- | `probe/probe_geometry` | `(n_el, 3)` | float32 | m | Element positions (x, y, z) |
106
-
107
- ## Subject Metadata
108
-
109
- No human or animal subjects. Synthetic media simulated with Field II. Virtual probes: L7-4-like linear and P4-like phased arrays.
110
-
111
- ## Data Validation
112
-
113
- A Delay-And-Sum `zea.Pipeline` is provided in the **`pipeline.yaml` at the submission root** and
114
- run by the single **`reconstruct.py` at the submission root**:
115
- `cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`
116
- (RF is demodulated in-pipeline; IQ uses a baseband pipeline). The script is geometry-driven and
117
- recurses into every sub-dataset folder; running `python reconstruct.py` from the root reconstructs
118
- every `.hdf5` in the collection (or pass a folder-qualified path for a single acquisition) and writes
119
- `<name>_zea_bmode.png` next to each file as a portable check that the recorded geometry and timing
120
- are correct.
121
-
122
- The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the
123
- UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction
124
- used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with
125
- scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry.
126
- These are the recommended reference reconstructions for visual verification.
127
-
128
- ## Known Issues
129
-
130
- PICMUS calibration: 'PICMUS_numerical_calib_v2' was created in collaboration with our group as part of the PICMUS (Plane-wave Imaging Challenge in Medical UltraSound, IEEE IUS 2016) effort, and is therefore included here. The other PICMUS acquisitions (in-vivo carotid, experimental and simulated resolution/contrast) are deliberately excluded from this submission. Simulation framework: Field II (Jensen et al.).
131
-
132
- ## Ethical Considerations
133
-
134
- Fully synthetic data generated with the Field II simulation framework; no human or animal subjects. No personal data is present. The included numerical calibration file was produced in collaboration with our group as part of the PICMUS effort (IEEE IUS 2016) and is released here under CC BY 4.0.
 
1
+ ---
2
+ pretty_name: "USTB - Simulation (Field II)"
3
+ license: cc-by-4.0
4
+ task_categories:
5
+ - image-to-image
6
+ language:
7
+ - en
8
+ tags:
9
+ - ultrasound
10
+ - rf
11
+ - openh-rf
12
+ - simulation
13
+ - field-ii
14
+ - synthetic
15
+ size_categories:
16
+ - n<1K
17
+ ---
18
+
19
+ # USTB - Simulation (Field II)
20
+
21
+ Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** contributed to the
22
+ [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All acquisitions are stored in the
23
+ *zea* HDF5 file format (zea_version 0.1.6) and contain raw pre-beamformed
24
+ channel data (`/data/raw_data`).
25
+
26
+ ## Dataset Description
27
+
28
+ Physics-based synthetic channel-capture data generated with the Field II ultrasound simulation framework. The collection covers point scatterers, cysts, speckle, dynamic-range targets and blocked-array (aperture-apodized) configurations, using linear (L7-4-like) and phased (P4-like) virtual probes with CPWC, FI and STA sequences. Because the scattering medium is fully defined, exact ground-truth scatterer positions and medium parameters are known. One numerical calibration acquisition (PICMUS_numerical_calib_v2) was created in collaboration with our group as part of the PICMUS effort; it is included here while the other PICMUS datasets are excluded (see Known Issues).
29
+
30
+ ## Dataset Contributors
31
+
32
+ University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius Hoel Rindal (omrindal@ifi.uio.no). Team: Ole Marius Hoel Rindal, Yucel Karabiyik, Sven Peter Nasholm, Andreas Austeng.
33
+
34
+ ## Dataset Creation Date
35
+
36
+ 06/23/2026 (packaging date; original acquisitions/simulations were produced between 2016 and 2023).
37
+
38
+ ## License / Terms of Use
39
+
40
+ Released under **Creative Commons Attribution 4.0 International (CC BY 4.0)** — see the `LICENCE`
41
+ file at the submission root (this license is also declared in the YAML frontmatter above). The
42
+ contributed data is cleared for this license. The UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo. Contributed to OpenH-RF. Zenodo record 20261898.
43
+
44
+ ## Intended Usage
45
+
46
+ Generalized reconstruction, beamformer development and validation with known ground truth (RFP task 6.1); resolution/contrast/dynamic-range characterization; training/validation of learned reconstruction methods. (OpenH-RF RFP task 6.1 Generalized Reconstruction).
47
+
48
+ ## Dataset Characterization
49
+
50
+ - **Data Collection Method:** synthetic
51
+ - **Labeling Method:** Synthetic ground truth (known scatterer positions and medium parameters).
52
+ - **Acquisition system:** probe(s) L7-4, P4-1;
53
+ element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling
54
+ frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
55
+
56
+ ## Dataset Format
57
+
58
+ All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single
59
+ acquisition with raw channel data `/data/raw_data` of shape
60
+ `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit
61
+ sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF/IQ (n_ch in [1, 2]).
62
+ No demodulation or decimation was applied during packaging beyond conversion from the USTB
63
+ Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
64
+
65
+ ## Dataset Quantification
66
+
67
+ **Current OpenH-RF release:** 11 HDF5 files; 2.98 GB (2,980,642,816 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.
68
+
69
+ - **Number of acquisitions:** 11
70
+ - **Total channel-capture frames:** 17
71
+ - **Train / validation / test split:** not predefined (research dataset).
72
+ - **Stored HDF5 size:** 2.98 GB (2,980,642,816 bytes).
73
+
74
+ Per-acquisition summary:
75
+
76
+ | Acquisition | frames | transmits | samples | elements | n_ch | fs (MHz) | fc (MHz) | size (MB) |
77
+ |---|---|---|---|---|---|---|---|---|
78
+ | `FieldII_CPWC_point_scatterers_res_v2` | 7 | 1 | 7792 | 128 | 1 | 100.0 | 5.16 | 2.10 |
79
+ | `FieldII_CPWC_simulation_v2` | 1 | 1 | 6494 | 128 | 1 | 100.0 | 5.13 | 0.92 |
80
+ | `FieldII_P4_point_scatterers` | 1 | 128 | 14349 | 64 | 1 | 100.0 | 2.56 | 406.13 |
81
+ | `FieldII_speckle_DMASsimulation300000pts` | 1 | 96 | 10570 | 128 | 1 | 100.0 | 3.50 | 200.67 |
82
+ | `FieldII_STAI_dynamic_range` | 1 | 128 | 7792 | 128 | 1 | 100.0 | 5.13 | 355.40 |
83
+ | `FieldII_STAI_simulated_dynamic_range` | 1 | 128 | 7792 | 128 | 1 | 100.0 | 5.13 | 347.60 |
84
+ | `FieldII_STAI_uniform_fov` | 1 | 128 | 2771 | 128 | 1 | 25.0 | 5.13 | 125.57 |
85
+ | `PICMUS_numerical_calib_v2` | 1 | 5 | 445 | 128 | 2 | 5.2 | 5.21 | 2.16 |
86
+ | `speckle_sim_FI_P4_probe_apod_1_speckle_long_many_angles` | 1 | 150 | 15786 | 64 | 1 | 100.0 | 2.56 | 506.40 |
87
+ | `speckle_sim_FI_P4_probe_apod_2_speckle_long_many_angles` | 1 | 150 | 15786 | 64 | 1 | 100.0 | 2.56 | 512.49 |
88
+ | `speckle_sim_FI_P4_probe_apod_3_speckle_long_many_angles` | 1 | 150 | 15786 | 64 | 1 | 100.0 | 2.56 | 521.21 |
89
+
90
+ Per-sample feature table:
91
+
92
+ | Field | Shape | Dtype | Units | Description |
93
+ |---|---|---|---|---|
94
+ | `data/raw_data` | `(n_frames, n_tx, n_ax, n_el, n_ch)` | float32 | a.u. | Raw pre-beamformed RF channel data |
95
+ | `scan/sampling_frequency` | `scalar` | float32 | Hz | A/D sampling frequency |
96
+ | `scan/center_frequency` | `scalar` | float32 | Hz | Transmit pulse center frequency |
97
+ | `scan/demodulation_frequency` | `scalar` | float32 | Hz | Demodulation (carrier) frequency |
98
+ | `scan/sound_speed` | `scalar` | float32 | m/s | Assumed medium speed of sound |
99
+ | `scan/initial_times` | `(n_tx,)` | float32 | s | A/D start time per transmit |
100
+ | `scan/t0_delays` | `(n_tx, n_el)` | float32 | s | Per-element transmit fire times |
101
+ | `scan/tx_apodizations` | `(n_tx, n_el)` | float32 | - | Per-element transmit apodization |
102
+ | `scan/focus_distances` | `(n_tx,)` | float32 | m | Focus distance per transmit (0 = plane wave) |
103
+ | `scan/polar_angles` | `(n_tx,)` | float32 | rad | Transmit steering (polar) angle |
104
+ | `scan/transmit_origins` | `(n_tx, 3)` | float32 | m | Transmit beam origin (x, y, z) |
105
+ | `probe/probe_geometry` | `(n_el, 3)` | float32 | m | Element positions (x, y, z) |
106
+
107
+ ## Subject Metadata
108
+
109
+ No human or animal subjects. Synthetic media simulated with Field II. Virtual probes: L7-4-like linear and P4-like phased arrays.
110
+
111
+ ## Data Validation
112
+
113
+ A Delay-And-Sum `zea.Pipeline` is provided in the **`pipeline.yaml` at the submission root** and
114
+ run by the single **`reconstruct.py` at the submission root**:
115
+ `cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`
116
+ (RF is demodulated in-pipeline; IQ uses a baseband pipeline). The script is geometry-driven and
117
+ recurses into every sub-dataset folder; running `python reconstruct.py` from the root reconstructs
118
+ every `.hdf5` in the collection (or pass a folder-qualified path for a single acquisition) and writes
119
+ `<name>_zea_bmode.png` next to each file as a portable check that the recorded geometry and timing
120
+ are correct.
121
+
122
+ The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the
123
+ UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction
124
+ used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with
125
+ scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry.
126
+ These are the recommended reference reconstructions for visual verification.
127
+
128
+ ## Known Issues
129
+
130
+ PICMUS calibration: 'PICMUS_numerical_calib_v2' was created in collaboration with our group as part of the PICMUS (Plane-wave Imaging Challenge in Medical UltraSound, IEEE IUS 2016) effort, and is therefore included here. The other PICMUS acquisitions (in-vivo carotid, experimental and simulated resolution/contrast) are deliberately excluded from this submission. Simulation framework: Field II (Jensen et al.).
131
+
132
+ ## Ethical Considerations
133
+
134
+ Fully synthetic data generated with the Field II simulation framework; no human or animal subjects. No personal data is present. The included numerical calibration file was produced in collaboration with our group as part of the PICMUS effort (IEEE IUS 2016) and is released here under CC BY 4.0.
twente-cavitation/README.md CHANGED
@@ -1,117 +1,117 @@
1
- ---
2
- pretty_name: "OpenH-RF — Hermen de Roo / Passive cavitation detection"
3
- license: cc-by-4.0
4
- task_categories:
5
- - image-classification
6
- tags:
7
- - ultrasound
8
- - rf
9
- - openh-rf
10
- - cavitation
11
- language:
12
- - en
13
- size_categories:
14
- - 1K<n<10K
15
- ---
16
-
17
-
18
- ## Dataset Description
19
- The collected data is for cavitation mapping of microbubbles, insonified with focused ultrasound at various pressures and flowrates. This data applicable to therapeutic ultrasound and local drug delivery in any part of the human body. The used sensor hardware is a Verasonics research system with an L11-4v transducer for recording the bubble response during the treatment. Insonification is done using a single element transducer at 2.25MHz. The insonification is done with a 1000 cycles long pulse at 2.25MHz, where the first and last 2 microseconds are used for ramping up and down the pressure. The pulse repetition frequency used is 20Hz, repeated 400 times.
20
-
21
-
22
- ## Dataset Contributor(s)
23
- Hermen de Roo
24
- Michel Versluis
25
- Guillaume Lajoinie (contact email: g.p.r.lajoinie@utwente.nl)
26
-
27
-
28
- ## Dataset Creation Date
29
- Data recorded on 01/19/2026. Dataset created on 07/09/2026.
30
-
31
- ## License / Terms of Use
32
- I confirm that the data is cleared for use under CC BY 4.0.
33
-
34
- ## Intended Usage
35
- The dataset contains data over a large pressure range, from very low pressures up to the very high pressures used in therapeutic ultrasound. With this data one can quantify the treatment threshold and treatment effects over this wide range. The dataset also includes data for different levels of perfusion by varying the flowrate, from which the effect of perfusion on treatment efficacy can be studied. The data is intended to be processed with passive cavitation detection algorithms.
36
-
37
- ## Dataset Characterization
38
- - **Data Collection Method:** phantom
39
- - **Labeling Method:** N/A
40
- - **Acquisition system:** Verasonics Vantage 256, L11-4v transducer. 128 elements, 7.24MHz center frequency, 27.778 MHz sampling rate
41
-
42
- ## Dataset Format
43
- .zea file format. No preprocessing is applied.
44
-
45
- ## Dataset Quantification
46
-
47
- **Current OpenH-RF release:** 19 HDF5 files; 10.85 GB (10,850,533,376 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.
48
-
49
- - 19 aquisitions of 400 frames each, totalling 7600 frames
50
- - No train/validation/test split is defined; all acquisitions are provided in full.
51
- - **Stored HDF5 size:** 10.85 GB (10,850,533,376 bytes).
52
- - All recordings were taken under identical conditions, except for the driving pressure and flowrate of the microbubble solution through the channel.
53
-
54
- Each acquisition is one zea HDF5 file with a single track (`tracks/track_0`). The
55
- per-frame channel data plus the scan/probe fields needed to reconstruct it are:
56
-
57
- | Field | Shape | dtype | Units | Description |
58
- |---|---|---|---|---|
59
- | `data/raw_data` | (400, 1, 16384, 128, 1) | int16 | a.u. (ADC counts) | Receive RF channel data: 400 frames × 1 transmit event × 16384 axial samples × 128 elements × 1 channel. This is a passive acquisition — the array only receives. |
60
- | `probe/probe_geometry` | (128, 3) | float32 | m | (x, y, z) position of each of the 128 elements (L11-4v, 0.3 mm pitch). |
61
- | `probe/probe_center_frequency` | scalar | float32 | Hz | Probe center frequency (7.24 MHz). |
62
- | `probe/element_width` | scalar | float32 | m | Element width (0.27 mm). |
63
- | `scan/sampling_frequency` | scalar | float32 | Hz | RF sampling rate (27.78 MHz). |
64
- | `scan/center_frequency` | scalar | float32 | Hz | Receive center frequency (≈7.35 MHz). |
65
- | `scan/demodulation_frequency` | scalar | float32 | Hz | Demodulation frequency used for IQ conversion (≈6.94 MHz). |
66
- | `scan/sound_speed` | scalar | float32 | m/s | Assumed speed of sound (1480). |
67
- | `scan/initial_times` | (1,) | float32 | s | Time of the first recorded sample relative to transmit (0). |
68
- | `scan/t0_delays` | (1, 128) | float32 | s | Per-element transmit delays (all 0 — array does not transmit). |
69
- | `scan/tx_apodizations` | (1, 128) | float32 | a.u. | Transmit apodization per element (all 0 — passive acquisition; `reconstruct.py` overrides to ones for receive beamforming). |
70
- | `scan/time_to_next_transmit` | (400, 1) | float32 | s | Interval to the next transmit per frame (PRF = 20 Hz). |
71
- | `scan/tgc_gain_curve` | (16384,) | float32 | a.u. | Time-gain-compensation curve applied along the axial dimension. |
72
- | `tracks/track_0/transmit_only` | scalar | bool | — | False (the array receives). |
73
-
74
- > **Note.** The table below is the **acquisition matrix** — it lists which files exist
75
- > and under what driving pressure / flowrate, not the internal layout of a sample.
76
-
77
- Files are named `cavitation_bubbles_<pressure>kPa_<flowrate>mL.hdf5`, where
78
- `<flowrate>` is the microbubble flowrate in mL/min (`01` = 0.1, `05` = 0.5, `2` = 2).
79
-
80
- | Name | Acoustic driving pressure [kPa]| Microbubble flowrate [mL/min] |
81
- |--- |--- |--- |
82
- | cavitation_bubbles_10kPa_01mL.hdf5 | 10 | 0.1 |
83
- | cavitation_bubbles_25kPa_01mL.hdf5 | 25 | 0.1 |
84
- | cavitation_bubbles_50kPa_01mL.hdf5 | 50 | 0.1 |
85
- | cavitation_bubbles_75kPa_01mL.hdf5 | 75 | 0.1 |
86
- | cavitation_bubbles_100kPa_01mL.hdf5 | 100 | 0.1 |
87
- | cavitation_bubbles_250kPa_01mL.hdf5 | 250 | 0.1 |
88
- | cavitation_bubbles_500kPa_01mL.hdf5 | 500 | 0.1 |
89
- | cavitation_bubbles_750kPa_01mL.hdf5 | 750 | 0.1 |
90
- | cavitation_bubbles_1000kPa_01mL.hdf5 | 1000 | 0.1 |
91
- | cavitation_bubbles_10kPa_05mL.hdf5 | 10 | 0.5 |
92
- | cavitation_bubbles_50kPa_05mL.hdf5 | 50 | 0.5 |
93
- | cavitation_bubbles_100kPa_05mL.hdf5 | 100 | 0.5 |
94
- | cavitation_bubbles_500kPa_05mL.hdf5 | 500 | 0.5 |
95
- | cavitation_bubbles_1000kPa_05mL.hdf5 | 1000 | 0.5 |
96
- | cavitation_bubbles_10kPa_2mL.hdf5 | 10 | 2 |
97
- | cavitation_bubbles_50kPa_2mL.hdf5 | 50 | 2 |
98
- | cavitation_bubbles_100kPa_2mL.hdf5 | 100 | 2 |
99
- | cavitation_bubbles_500kPa_2mL.hdf5 | 500 | 2 |
100
- | cavitation_bubbles_1000kPa_2mL.hdf5 | 1000 | 2 |
101
-
102
-
103
- ## Subject Metadata
104
- Only one phantom was used. This is a phantom made of PVCp with a single flow channel ~200 micrometer diameter. The used scanner is a Verasonics Vantage 256 with a L11-4v transducer.
105
-
106
- ## Data Validation
107
- An reconstruction pipeline can be found in pipeline.yaml. The script reconstruct.py is an example of the reconstruction of the data, using the minimum variance / Capon beamformer. An example reconstruction is saved with this dataset, and named reference_image_1000kPa_2mL_per_min.png, which was generated using the Capon beamforming algorithm using epsilon = 2, on the datafile named cavitation_bubbles_1000kPa_2mL_per_min.hdf5. By default the script saves the map next to the input file with the same name and a `.png` extension (e.g. `my_file.hdf5` → `my_file.png`); pass `--output` to override. Usage:
108
- python reconstruct.py
109
- python reconstruct.py --input my_file.hdf5 --device cpu
110
- python reconstruct.py --input my_file.hdf5 --output my_map.png --frames 20 --device cuda:0
111
-
112
-
113
- ## Known Issues
114
- No known issues.
115
-
116
- ## Ethical Considerations
117
- This is phantom acquisition data, hence no human-subject IRB/HIPAA approval is required.
 
1
+ ---
2
+ pretty_name: "OpenH-RF — Hermen de Roo / Passive cavitation detection"
3
+ license: cc-by-4.0
4
+ task_categories:
5
+ - image-classification
6
+ tags:
7
+ - ultrasound
8
+ - rf
9
+ - openh-rf
10
+ - cavitation
11
+ language:
12
+ - en
13
+ size_categories:
14
+ - 1K<n<10K
15
+ ---
16
+
17
+
18
+ ## Dataset Description
19
+ The collected data is for cavitation mapping of microbubbles, insonified with focused ultrasound at various pressures and flowrates. This data applicable to therapeutic ultrasound and local drug delivery in any part of the human body. The used sensor hardware is a Verasonics research system with an L11-4v transducer for recording the bubble response during the treatment. Insonification is done using a single element transducer at 2.25MHz. The insonification is done with a 1000 cycles long pulse at 2.25MHz, where the first and last 2 microseconds are used for ramping up and down the pressure. The pulse repetition frequency used is 20Hz, repeated 400 times.
20
+
21
+
22
+ ## Dataset Contributor(s)
23
+ Hermen de Roo
24
+ Michel Versluis
25
+ Guillaume Lajoinie (contact email: g.p.r.lajoinie@utwente.nl)
26
+
27
+
28
+ ## Dataset Creation Date
29
+ Data recorded on 01/19/2026. Dataset created on 07/09/2026.
30
+
31
+ ## License / Terms of Use
32
+ I confirm that the data is cleared for use under CC BY 4.0.
33
+
34
+ ## Intended Usage
35
+ The dataset contains data over a large pressure range, from very low pressures up to the very high pressures used in therapeutic ultrasound. With this data one can quantify the treatment threshold and treatment effects over this wide range. The dataset also includes data for different levels of perfusion by varying the flowrate, from which the effect of perfusion on treatment efficacy can be studied. The data is intended to be processed with passive cavitation detection algorithms.
36
+
37
+ ## Dataset Characterization
38
+ - **Data Collection Method:** phantom
39
+ - **Labeling Method:** N/A
40
+ - **Acquisition system:** Verasonics Vantage 256, L11-4v transducer. 128 elements, 7.24MHz center frequency, 27.778 MHz sampling rate
41
+
42
+ ## Dataset Format
43
+ .zea file format. No preprocessing is applied.
44
+
45
+ ## Dataset Quantification
46
+
47
+ **Current OpenH-RF release:** 19 HDF5 files; 10.85 GB (10,850,533,376 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.
48
+
49
+ - 19 aquisitions of 400 frames each, totalling 7600 frames
50
+ - No train/validation/test split is defined; all acquisitions are provided in full.
51
+ - **Stored HDF5 size:** 10.85 GB (10,850,533,376 bytes).
52
+ - All recordings were taken under identical conditions, except for the driving pressure and flowrate of the microbubble solution through the channel.
53
+
54
+ Each acquisition is one zea HDF5 file with a single track (`tracks/track_0`). The
55
+ per-frame channel data plus the scan/probe fields needed to reconstruct it are:
56
+
57
+ | Field | Shape | dtype | Units | Description |
58
+ |---|---|---|---|---|
59
+ | `data/raw_data` | (400, 1, 16384, 128, 1) | int16 | a.u. (ADC counts) | Receive RF channel data: 400 frames × 1 transmit event × 16384 axial samples × 128 elements × 1 channel. This is a passive acquisition — the array only receives. |
60
+ | `probe/probe_geometry` | (128, 3) | float32 | m | (x, y, z) position of each of the 128 elements (L11-4v, 0.3 mm pitch). |
61
+ | `probe/probe_center_frequency` | scalar | float32 | Hz | Probe center frequency (7.24 MHz). |
62
+ | `probe/element_width` | scalar | float32 | m | Element width (0.27 mm). |
63
+ | `scan/sampling_frequency` | scalar | float32 | Hz | RF sampling rate (27.78 MHz). |
64
+ | `scan/center_frequency` | scalar | float32 | Hz | Receive center frequency (≈7.35 MHz). |
65
+ | `scan/demodulation_frequency` | scalar | float32 | Hz | Demodulation frequency used for IQ conversion (≈6.94 MHz). |
66
+ | `scan/sound_speed` | scalar | float32 | m/s | Assumed speed of sound (1480). |
67
+ | `scan/initial_times` | (1,) | float32 | s | Time of the first recorded sample relative to transmit (0). |
68
+ | `scan/t0_delays` | (1, 128) | float32 | s | Per-element transmit delays (all 0 — array does not transmit). |
69
+ | `scan/tx_apodizations` | (1, 128) | float32 | a.u. | Transmit apodization per element (all 0 — passive acquisition; `reconstruct.py` overrides to ones for receive beamforming). |
70
+ | `scan/time_to_next_transmit` | (400, 1) | float32 | s | Interval to the next transmit per frame (PRF = 20 Hz). |
71
+ | `scan/tgc_gain_curve` | (16384,) | float32 | a.u. | Time-gain-compensation curve applied along the axial dimension. |
72
+ | `tracks/track_0/transmit_only` | scalar | bool | — | False (the array receives). |
73
+
74
+ > **Note.** The table below is the **acquisition matrix** — it lists which files exist
75
+ > and under what driving pressure / flowrate, not the internal layout of a sample.
76
+
77
+ Files are named `cavitation_bubbles_<pressure>kPa_<flowrate>mL.hdf5`, where
78
+ `<flowrate>` is the microbubble flowrate in mL/min (`01` = 0.1, `05` = 0.5, `2` = 2).
79
+
80
+ | Name | Acoustic driving pressure [kPa]| Microbubble flowrate [mL/min] |
81
+ |--- |--- |--- |
82
+ | cavitation_bubbles_10kPa_01mL.hdf5 | 10 | 0.1 |
83
+ | cavitation_bubbles_25kPa_01mL.hdf5 | 25 | 0.1 |
84
+ | cavitation_bubbles_50kPa_01mL.hdf5 | 50 | 0.1 |
85
+ | cavitation_bubbles_75kPa_01mL.hdf5 | 75 | 0.1 |
86
+ | cavitation_bubbles_100kPa_01mL.hdf5 | 100 | 0.1 |
87
+ | cavitation_bubbles_250kPa_01mL.hdf5 | 250 | 0.1 |
88
+ | cavitation_bubbles_500kPa_01mL.hdf5 | 500 | 0.1 |
89
+ | cavitation_bubbles_750kPa_01mL.hdf5 | 750 | 0.1 |
90
+ | cavitation_bubbles_1000kPa_01mL.hdf5 | 1000 | 0.1 |
91
+ | cavitation_bubbles_10kPa_05mL.hdf5 | 10 | 0.5 |
92
+ | cavitation_bubbles_50kPa_05mL.hdf5 | 50 | 0.5 |
93
+ | cavitation_bubbles_100kPa_05mL.hdf5 | 100 | 0.5 |
94
+ | cavitation_bubbles_500kPa_05mL.hdf5 | 500 | 0.5 |
95
+ | cavitation_bubbles_1000kPa_05mL.hdf5 | 1000 | 0.5 |
96
+ | cavitation_bubbles_10kPa_2mL.hdf5 | 10 | 2 |
97
+ | cavitation_bubbles_50kPa_2mL.hdf5 | 50 | 2 |
98
+ | cavitation_bubbles_100kPa_2mL.hdf5 | 100 | 2 |
99
+ | cavitation_bubbles_500kPa_2mL.hdf5 | 500 | 2 |
100
+ | cavitation_bubbles_1000kPa_2mL.hdf5 | 1000 | 2 |
101
+
102
+
103
+ ## Subject Metadata
104
+ Only one phantom was used. This is a phantom made of PVCp with a single flow channel ~200 micrometer diameter. The used scanner is a Verasonics Vantage 256 with a L11-4v transducer.
105
+
106
+ ## Data Validation
107
+ An reconstruction pipeline can be found in pipeline.yaml. The script reconstruct.py is an example of the reconstruction of the data, using the minimum variance / Capon beamformer. An example reconstruction is saved with this dataset, and named reference_image_1000kPa_2mL_per_min.png, which was generated using the Capon beamforming algorithm using epsilon = 2, on the datafile named cavitation_bubbles_1000kPa_2mL_per_min.hdf5. By default the script saves the map next to the input file with the same name and a `.png` extension (e.g. `my_file.hdf5` → `my_file.png`); pass `--output` to override. Usage:
108
+ python reconstruct.py
109
+ python reconstruct.py --input my_file.hdf5 --device cpu
110
+ python reconstruct.py --input my_file.hdf5 --output my_map.png --frames 20 --device cuda:0
111
+
112
+
113
+ ## Known Issues
114
+ No known issues.
115
+
116
+ ## Ethical Considerations
117
+ This is phantom acquisition data, hence no human-subject IRB/HIPAA approval is required.
twente-cavitation/pipeline.yaml CHANGED
@@ -1,22 +1,22 @@
1
- pipeline:
2
- operations:
3
- - name: keras.ops.cast
4
- params:
5
- dtype: float32
6
- - demodulate
7
- - name: beamform
8
- params:
9
- beamformer: minimum_variance
10
- subarray_size: 32
11
- diagonal_loading: 0.01
12
- - envelope_detect
13
- parameters:
14
- grid_size_x: 387
15
- grid_size_z: 577
16
- xlims:
17
- - -0.019
18
- - 0.019
19
- zlims:
20
- - 0.002
21
- - 0.06
22
- apply_lens_correction: true
 
1
+ pipeline:
2
+ operations:
3
+ - name: keras.ops.cast
4
+ params:
5
+ dtype: float32
6
+ - demodulate
7
+ - name: beamform
8
+ params:
9
+ beamformer: minimum_variance
10
+ subarray_size: 32
11
+ diagonal_loading: 0.01
12
+ - envelope_detect
13
+ parameters:
14
+ grid_size_x: 387
15
+ grid_size_z: 577
16
+ xlims:
17
+ - -0.019
18
+ - 0.019
19
+ zlims:
20
+ - 0.002
21
+ - 0.06
22
+ apply_lens_correction: true
twente-vortexflow/README.md CHANGED
@@ -1,184 +1,184 @@
1
- ---
2
- pretty_name: "OpenH-RF — Flow Phantom Ultrasound Channel/Optical Data (Physics of Fluids, University of Twente)"
3
- license: cc-by-4.0
4
- task_categories:
5
- - image-segmentation
6
- - other
7
- tags:
8
- - ultrasound
9
- - rf
10
- - openh-rf
11
- - flow
12
- - phantom
13
- - blood-flow
14
- language:
15
- - en
16
- size_categories:
17
- - 1K<n<10K
18
- ---
19
-
20
- # OpenH-RF — Ultrasound-Optical Flow Phantom Chamber Data
21
-
22
- ## Dataset Description
23
-
24
- Pre-beamformed ultrasound channel-capture data acquired with a curved-array transducer
25
- (GEC1-6D, 192 elements, 3.4 MHz center frequency) from a **flow phantom**, accompanied with simultaneously recorded camera images. The phantom contains a flow chamber through which a water with optical and acoustical scatterers is pumped at controlled flow rates. Six acquisitions are provided,
26
- spanning three pump voltage levels (80 V, 120 V, 160 V) and two transmit voltage levels
27
- (3.4 V, 7.1 V), each capturing two transmit types: a **short imaging pulse** and a
28
- **chirp** waveform. Each acquisition contains 750 frames of single plane-wave RF channel
29
- data. The intended task is **blood-flow imaging and Doppler processing** (RFP task group 6.2).
30
-
31
- ### Phantom
32
- The front and the back of the flow chamber are made from medical-grade gelatin to facilitate ultrasound transmission. A cylinder with a diameter of 6 mm is placed inside the flow chamber which generates a von Kármán vortex street. The distance between the walls of the flow chamber is about 3 cm. A schematic of the setup is shown in Figure 1.
33
- ![Figure 1: Ultrasound - optical flow phantom setup](setup.png)
34
-
35
- The elevation focus of the transducer is aligned with the optical light sheet, see Figure 2.
36
- ![Figure 2: Alignment of the acoustical beam and the lightsheet](setup_side.png)
37
-
38
- ### Contrast
39
- Optical scattering was facilitated by hollow glass beads (mean particle size: 9-13 micrometer, Manufacturer: Sigma-Aldrich, PubChem Substance ID: 24867590). The acoustical scatter was enhanced by adding in-house produced microbubbles. The microbubble size distribution is shown in Figure 3.
40
- ![Figure 3: Microbubble size distribution](MB_size_distribution.png)
41
-
42
- ### Acquisition parameters
43
- The acquisition settings for all six datasets are summarized in Table 1.
44
-
45
- **Table 1. Acquisition parameters per dataset.**
46
-
47
- | Dataset number | Dataset name | Transformer output (V) | Est. pump output (L/s) | Transducer driving (V) |
48
- |---|---|---:|---:|---:|
49
- | 1 | AcqData_PVoltage80_TVoltage3.4 | 80 | 0.056 | 3.4 |
50
- | 2 | AcqData_PVoltage80_TVoltage7.1 | 80 | 0.056 | 7.1 |
51
- | 3 | AcqData_PVoltage120_TVoltage3.4 | 120 | 0.107 | 3.4 |
52
- | 4 | AcqData_PVoltage120_TVoltage7.1 | 120 | 0.107 | 7.1 |
53
- | 5 | AcqData_PVoltage160_TVoltage3.4 | 160 | 0.138 | 3.4 |
54
- | 6 | AcqData_PVoltage160_TVoltage7.1 | 160 | 0.138 | 7.1 |
55
-
56
-
57
- ## Dataset Contributor(s)
58
- Rienk Zorgdrager (email: r.c.zorgdrager@utwente.nl, ORCiD: 0009-0001-2537-117X), Guillaume Lajoinie, Michel Versluis
59
- Physics of Fluids Group, Faculty of Science and Technology, University of Twente, 2026.
60
-
61
- ## Dataset Creation Date
62
-
63
- 07/01/2026
64
-
65
- ## License / Terms of Use
66
-
67
- This dataset is released under the **Creative Commons Attribution 4.0 International
68
- (CC BY 4.0)** license. You are free to share and adapt the material for any purpose,
69
- including commercial use, provided appropriate credit is given.
70
-
71
- ## Intended Usage
72
-
73
- Suitable for research in:
74
- - Ultrasound localization microscopy (ULM) / super-resolution flow imaging
75
- - Validation/verification of ultrasound flow imaging techniques using optical references
76
- - Fluid dynamics using ultrasound
77
- - Chirp compression and coded-excitation beamforming
78
- - Beamforming quality comparison across transmit voltage levels (SNR studies)
79
-
80
-
81
- ## Dataset Characterization
82
-
83
- - **Data Collection Method:** Phantom / table-top (flow phantom, no human subjects)
84
- - **Labeling Method:** No manual labels; ground-truth flow rate is implicit in camera images. Note that the measured velocity may differ from the pump output in Table 1 due to changes in geometry and flow profiles in the flow chamber.
85
- - **Acquisition system:**
86
- - Transducer: GEC1-6D curved array, 192 elements, 3.4 MHz center frequency, 95% bandwidth,
87
- 35 µm element width, 66 mm elevation focus, 0.0568 m radius
88
- - Transmit: single plane-wave (focus distance = 0, polar angle = 0°)
89
- - Sampling rate: ~19.2 MHz
90
- - Sound speed used: 1509.6 m/s (water-based phantom)
91
- - Data type: raw RF (n_ch = 1, float32)
92
- - System: Verasonics Vantage 256
93
-
94
- ## Dataset Format
95
-
96
- All files are in the **zea** format (HDF5 + zea schema, current release `zea_version` 0.1.6).
97
- Each `.hdf5` file contains two tracks:
98
-
99
- | Track label | Description |
100
- |-------------------------|-----------------------------------------------------|
101
- | `short imaging pulse` | Standard narrow-band pulse transmit |
102
- | `chirp` | Frequency-swept (chirp) coded excitation transmit |
103
-
104
- Both tracks use the same probe and geometry. The raw channel data arrays are stored as
105
- `float32` and are pre-beamformed (not yet envelope-detected or log-compressed).
106
-
107
- No pre-processing (demodulation, decimation, filtering) has been applied before packaging.
108
-
109
- ## Dataset Quantification
110
-
111
- **Current OpenH-RF release:** 6 HDF5 files; 9.09 GB (9,088,991,232 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.
112
-
113
- | File | Pump V | TX V | Frames per track | Tracks | Stored HDF5 size |
114
- |-----------------------------------------|--------|------|--------|--------|-----------------|
115
- | AcqData_PVoltage80_TVoltage3.4.hdf5 | 80 V | 3.4 V | 750 | 2 | 1.44 GB |
116
- | AcqData_PVoltage80_TVoltage7.1.hdf5 | 80 V | 7.1 V | 750 | 2 | 1.55 GB |
117
- | AcqData_PVoltage120_TVoltage3.4.hdf5 | 120 V | 3.4 V | 750 | 2 | 1.50 GB |
118
- | AcqData_PVoltage120_TVoltage7.1.hdf5 | 120 V | 7.1 V | 750 | 2 | 1.54 GB |
119
- | AcqData_PVoltage160_TVoltage3.4.hdf5 | 160 V | 3.4 V | 750 | 2 | 1.51 GB |
120
- | AcqData_PVoltage160_TVoltage7.1.hdf5 | 160 V | 7.1 V | 750 | 2 | 1.55 GB |
121
-
122
- **Total frames:** 9,000 (6 files × 750 frames), each covering 2 transmit types.
123
- - **Stored HDF5 size:** 9.09 GB (9,088,991,232 bytes).
124
- **No train/validation/test split** is defined; all acquisitions are provided as-is.
125
-
126
- ### Per-sample feature table
127
-
128
- | Name | Shape (per frame) | Dtype | Units | Description |
129
- |-----------------------|-----------------------|---------|-------|-------------------------------------------------------|
130
- | `raw_data` | (1, 3456, 192, 1) | float32 | — | Pre-beamformed RF channel data (1 plane-wave TX) |
131
- | `image/values` | (646, 435) | uint8 | — | Pre-computed B-mode image (stored in file, uint8) |
132
- | `scan/sampling_frequency` | scalar | float32 | Hz | A/D sampling rate (~19.2 MHz) |
133
- | `scan/sound_speed` | scalar | float32 | m/s | Speed of sound used for reconstruction (~1509.6 m/s) |
134
- | `scan/t0_delays` | (1, 192) | float32 | s | Per-element transmit delays (plane-wave: all zeros) |
135
- | `scan/tx_apodizations`| (1, 192) | float32 | — | Transmit apodization (all ones = uniform) |
136
- | `scan/tgc_gain_curve` | (3456,) | float32 | dB | Time-gain compensation curve |
137
- | `probe/probe_geometry`| (192, 3) | float32 | m | Element positions (x, y, z) in metres |
138
-
139
- ## Subject Metadata
140
-
141
- This is a **phantom dataset** (no human or animal subjects). Flow rates are controlled
142
- by pump voltage (80 V, 120 V, 160 V), see Table 1.
143
-
144
- ## Data Validation
145
-
146
- The submission includes `reconstruct.py` and two pipeline YAML files (one per track):
147
- - `pipeline_short_imaging_pulse.yaml` — for the short imaging pulse track
148
- - `pipeline_chirp.yaml` — for the chirp track
149
-
150
- The pipeline applies: `Cast(float32) → Demodulate → Beamform(DAS, 100 patches) → EnvelopeDetect → Normalize → LogCompress`
151
-
152
- To reconstruct:
153
- ```bash
154
- python reconstruct.py --input AcqData_PVoltage80_TVoltage3.4.hdf5 --frame 10
155
- ```
156
-
157
- Reference B-mode image (AcqData_PVoltage80_TVoltage3.4.hdf5, frame 10):
158
-
159
- ![Reference B-mode reconstruction](reference_bmode.png)
160
-
161
- *Left: short imaging pulse track. Right: chirp track. Two horizontal phantom wall
162
- reflections are visible, with a speckle-filled flow chamber between them. Near-field
163
- reverberation and grating-lobe artifacts at the walls and the cylinder are acquisition-induced.*
164
-
165
- Reference mapping between camera and ultrasound image (AcqData_PVoltage80_TVoltage3.4.hdf5, frame 10):
166
-
167
- ![Reference images of particles in flow](reference_mapping.png)
168
- *Top: short imaging pulse track. Bottom: synchronized camera recording. The walls of the phantom and the cylinder are visible in both images. In the ultrasound image, speckle is visible in between the walls (mainly bubble induced), whereas in the camera image the contrast is induced by the hollow glass beads. Light reflection artefacts are visible in the camera image near the cylinder and the walls.*
169
-
170
-
171
- ## Known Issues
172
- - The ultrasound recordings made with the chirp contain clipped reflections at the interface between walls and the water.
173
- - The speed of sound differs between the water and the medical gelatin (1449.30 +- 3.37 m/s).
174
- - A chirp compression algorithm is not provided.
175
- - The center frequency of the chirp is determined as the mean of the input frequency for the associated cycle in the Verasonics. This may therefore only be considered a very rough estimation.
176
- - An image registration algorithm is not provided, but the camera pixel size can be estimated using the geometry of the flow chamber.
177
-
178
-
179
- ## Ethical Considerations
180
-
181
- This is a **phantom dataset** with no human or animal subjects. No IRB approval or
182
- informed consent is required. No personally identifiable information is present.
183
-
184
- The phantom and flow phantom components do not carry proprietary IP constraints.
 
1
+ ---
2
+ pretty_name: "OpenH-RF — Flow Phantom Ultrasound Channel/Optical Data (Physics of Fluids, University of Twente)"
3
+ license: cc-by-4.0
4
+ task_categories:
5
+ - image-segmentation
6
+ - other
7
+ tags:
8
+ - ultrasound
9
+ - rf
10
+ - openh-rf
11
+ - flow
12
+ - phantom
13
+ - blood-flow
14
+ language:
15
+ - en
16
+ size_categories:
17
+ - 1K<n<10K
18
+ ---
19
+
20
+ # OpenH-RF — Ultrasound-Optical Flow Phantom Chamber Data
21
+
22
+ ## Dataset Description
23
+
24
+ Pre-beamformed ultrasound channel-capture data acquired with a curved-array transducer
25
+ (GEC1-6D, 192 elements, 3.4 MHz center frequency) from a **flow phantom**, accompanied with simultaneously recorded camera images. The phantom contains a flow chamber through which a water with optical and acoustical scatterers is pumped at controlled flow rates. Six acquisitions are provided,
26
+ spanning three pump voltage levels (80 V, 120 V, 160 V) and two transmit voltage levels
27
+ (3.4 V, 7.1 V), each capturing two transmit types: a **short imaging pulse** and a
28
+ **chirp** waveform. Each acquisition contains 750 frames of single plane-wave RF channel
29
+ data. The intended task is **blood-flow imaging and Doppler processing** (RFP task group 6.2).
30
+
31
+ ### Phantom
32
+ The front and the back of the flow chamber are made from medical-grade gelatin to facilitate ultrasound transmission. A cylinder with a diameter of 6 mm is placed inside the flow chamber which generates a von Kármán vortex street. The distance between the walls of the flow chamber is about 3 cm. A schematic of the setup is shown in Figure 1.
33
+ ![Figure 1: Ultrasound - optical flow phantom setup](setup.png)
34
+
35
+ The elevation focus of the transducer is aligned with the optical light sheet, see Figure 2.
36
+ ![Figure 2: Alignment of the acoustical beam and the lightsheet](setup_side.png)
37
+
38
+ ### Contrast
39
+ Optical scattering was facilitated by hollow glass beads (mean particle size: 9-13 micrometer, Manufacturer: Sigma-Aldrich, PubChem Substance ID: 24867590). The acoustical scatter was enhanced by adding in-house produced microbubbles. The microbubble size distribution is shown in Figure 3.
40
+ ![Figure 3: Microbubble size distribution](MB_size_distribution.png)
41
+
42
+ ### Acquisition parameters
43
+ The acquisition settings for all six datasets are summarized in Table 1.
44
+
45
+ **Table 1. Acquisition parameters per dataset.**
46
+
47
+ | Dataset number | Dataset name | Transformer output (V) | Est. pump output (L/s) | Transducer driving (V) |
48
+ |---|---|---:|---:|---:|
49
+ | 1 | AcqData_PVoltage80_TVoltage3.4 | 80 | 0.056 | 3.4 |
50
+ | 2 | AcqData_PVoltage80_TVoltage7.1 | 80 | 0.056 | 7.1 |
51
+ | 3 | AcqData_PVoltage120_TVoltage3.4 | 120 | 0.107 | 3.4 |
52
+ | 4 | AcqData_PVoltage120_TVoltage7.1 | 120 | 0.107 | 7.1 |
53
+ | 5 | AcqData_PVoltage160_TVoltage3.4 | 160 | 0.138 | 3.4 |
54
+ | 6 | AcqData_PVoltage160_TVoltage7.1 | 160 | 0.138 | 7.1 |
55
+
56
+
57
+ ## Dataset Contributor(s)
58
+ Rienk Zorgdrager (email: r.c.zorgdrager@utwente.nl, ORCiD: 0009-0001-2537-117X), Guillaume Lajoinie, Michel Versluis
59
+ Physics of Fluids Group, Faculty of Science and Technology, University of Twente, 2026.
60
+
61
+ ## Dataset Creation Date
62
+
63
+ 07/01/2026
64
+
65
+ ## License / Terms of Use
66
+
67
+ This dataset is released under the **Creative Commons Attribution 4.0 International
68
+ (CC BY 4.0)** license. You are free to share and adapt the material for any purpose,
69
+ including commercial use, provided appropriate credit is given.
70
+
71
+ ## Intended Usage
72
+
73
+ Suitable for research in:
74
+ - Ultrasound localization microscopy (ULM) / super-resolution flow imaging
75
+ - Validation/verification of ultrasound flow imaging techniques using optical references
76
+ - Fluid dynamics using ultrasound
77
+ - Chirp compression and coded-excitation beamforming
78
+ - Beamforming quality comparison across transmit voltage levels (SNR studies)
79
+
80
+
81
+ ## Dataset Characterization
82
+
83
+ - **Data Collection Method:** Phantom / table-top (flow phantom, no human subjects)
84
+ - **Labeling Method:** No manual labels; ground-truth flow rate is implicit in camera images. Note that the measured velocity may differ from the pump output in Table 1 due to changes in geometry and flow profiles in the flow chamber.
85
+ - **Acquisition system:**
86
+ - Transducer: GEC1-6D curved array, 192 elements, 3.4 MHz center frequency, 95% bandwidth,
87
+ 35 µm element width, 66 mm elevation focus, 0.0568 m radius
88
+ - Transmit: single plane-wave (focus distance = 0, polar angle = 0°)
89
+ - Sampling rate: ~19.2 MHz
90
+ - Sound speed used: 1509.6 m/s (water-based phantom)
91
+ - Data type: raw RF (n_ch = 1, float32)
92
+ - System: Verasonics Vantage 256
93
+
94
+ ## Dataset Format
95
+
96
+ All files are in the **zea** format (HDF5 + zea schema, current release `zea_version` 0.1.6).
97
+ Each `.hdf5` file contains two tracks:
98
+
99
+ | Track label | Description |
100
+ |-------------------------|-----------------------------------------------------|
101
+ | `short imaging pulse` | Standard narrow-band pulse transmit |
102
+ | `chirp` | Frequency-swept (chirp) coded excitation transmit |
103
+
104
+ Both tracks use the same probe and geometry. The raw channel data arrays are stored as
105
+ `float32` and are pre-beamformed (not yet envelope-detected or log-compressed).
106
+
107
+ No pre-processing (demodulation, decimation, filtering) has been applied before packaging.
108
+
109
+ ## Dataset Quantification
110
+
111
+ **Current OpenH-RF release:** 6 HDF5 files; 9.09 GB (9,088,991,232 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.
112
+
113
+ | File | Pump V | TX V | Frames per track | Tracks | Stored HDF5 size |
114
+ |-----------------------------------------|--------|------|--------|--------|-----------------|
115
+ | AcqData_PVoltage80_TVoltage3.4.hdf5 | 80 V | 3.4 V | 750 | 2 | 1.44 GB |
116
+ | AcqData_PVoltage80_TVoltage7.1.hdf5 | 80 V | 7.1 V | 750 | 2 | 1.55 GB |
117
+ | AcqData_PVoltage120_TVoltage3.4.hdf5 | 120 V | 3.4 V | 750 | 2 | 1.50 GB |
118
+ | AcqData_PVoltage120_TVoltage7.1.hdf5 | 120 V | 7.1 V | 750 | 2 | 1.54 GB |
119
+ | AcqData_PVoltage160_TVoltage3.4.hdf5 | 160 V | 3.4 V | 750 | 2 | 1.51 GB |
120
+ | AcqData_PVoltage160_TVoltage7.1.hdf5 | 160 V | 7.1 V | 750 | 2 | 1.55 GB |
121
+
122
+ **Total frames:** 9,000 (6 files × 750 frames), each covering 2 transmit types.
123
+ - **Stored HDF5 size:** 9.09 GB (9,088,991,232 bytes).
124
+ **No train/validation/test split** is defined; all acquisitions are provided as-is.
125
+
126
+ ### Per-sample feature table
127
+
128
+ | Name | Shape (per frame) | Dtype | Units | Description |
129
+ |-----------------------|-----------------------|---------|-------|-------------------------------------------------------|
130
+ | `raw_data` | (1, 3456, 192, 1) | float32 | — | Pre-beamformed RF channel data (1 plane-wave TX) |
131
+ | `image/values` | (646, 435) | uint8 | — | Pre-computed B-mode image (stored in file, uint8) |
132
+ | `scan/sampling_frequency` | scalar | float32 | Hz | A/D sampling rate (~19.2 MHz) |
133
+ | `scan/sound_speed` | scalar | float32 | m/s | Speed of sound used for reconstruction (~1509.6 m/s) |
134
+ | `scan/t0_delays` | (1, 192) | float32 | s | Per-element transmit delays (plane-wave: all zeros) |
135
+ | `scan/tx_apodizations`| (1, 192) | float32 | — | Transmit apodization (all ones = uniform) |
136
+ | `scan/tgc_gain_curve` | (3456,) | float32 | dB | Time-gain compensation curve |
137
+ | `probe/probe_geometry`| (192, 3) | float32 | m | Element positions (x, y, z) in metres |
138
+
139
+ ## Subject Metadata
140
+
141
+ This is a **phantom dataset** (no human or animal subjects). Flow rates are controlled
142
+ by pump voltage (80 V, 120 V, 160 V), see Table 1.
143
+
144
+ ## Data Validation
145
+
146
+ The submission includes `reconstruct.py` and two pipeline YAML files (one per track):
147
+ - `pipeline_short_imaging_pulse.yaml` — for the short imaging pulse track
148
+ - `pipeline_chirp.yaml` — for the chirp track
149
+
150
+ The pipeline applies: `Cast(float32) → Demodulate → Beamform(DAS, 100 patches) → EnvelopeDetect → Normalize → LogCompress`
151
+
152
+ To reconstruct:
153
+ ```bash
154
+ python reconstruct.py --input AcqData_PVoltage80_TVoltage3.4.hdf5 --frame 10
155
+ ```
156
+
157
+ Reference B-mode image (AcqData_PVoltage80_TVoltage3.4.hdf5, frame 10):
158
+
159
+ ![Reference B-mode reconstruction](reference_bmode.png)
160
+
161
+ *Left: short imaging pulse track. Right: chirp track. Two horizontal phantom wall
162
+ reflections are visible, with a speckle-filled flow chamber between them. Near-field
163
+ reverberation and grating-lobe artifacts at the walls and the cylinder are acquisition-induced.*
164
+
165
+ Reference mapping between camera and ultrasound image (AcqData_PVoltage80_TVoltage3.4.hdf5, frame 10):
166
+
167
+ ![Reference images of particles in flow](reference_mapping.png)
168
+ *Top: short imaging pulse track. Bottom: synchronized camera recording. The walls of the phantom and the cylinder are visible in both images. In the ultrasound image, speckle is visible in between the walls (mainly bubble induced), whereas in the camera image the contrast is induced by the hollow glass beads. Light reflection artefacts are visible in the camera image near the cylinder and the walls.*
169
+
170
+
171
+ ## Known Issues
172
+ - The ultrasound recordings made with the chirp contain clipped reflections at the interface between walls and the water.
173
+ - The speed of sound differs between the water and the medical gelatin (1449.30 +- 3.37 m/s).
174
+ - A chirp compression algorithm is not provided.
175
+ - The center frequency of the chirp is determined as the mean of the input frequency for the associated cycle in the Verasonics. This may therefore only be considered a very rough estimation.
176
+ - An image registration algorithm is not provided, but the camera pixel size can be estimated using the geometry of the flow chamber.
177
+
178
+
179
+ ## Ethical Considerations
180
+
181
+ This is a **phantom dataset** with no human or animal subjects. No IRB approval or
182
+ informed consent is required. No personally identifiable information is present.
183
+
184
+ The phantom and flow phantom components do not carry proprietary IP constraints.
twente-vortexflow/pipeline_chirp.yaml CHANGED
@@ -1,14 +1,14 @@
1
- pipeline:
2
- operations:
3
- - name: keras.ops.cast
4
- params:
5
- dtype: float32
6
- - demodulate
7
- - name: beamform
8
- - envelope_detect
9
- - name: normalize
10
- params:
11
- output_range:
12
- - 0.0
13
- - 1.0
14
- - log_compress
 
1
+ pipeline:
2
+ operations:
3
+ - name: keras.ops.cast
4
+ params:
5
+ dtype: float32
6
+ - demodulate
7
+ - name: beamform
8
+ - envelope_detect
9
+ - name: normalize
10
+ params:
11
+ output_range:
12
+ - 0.0
13
+ - 1.0
14
+ - log_compress
twente-vortexflow/pipeline_short_imaging_pulse.yaml CHANGED
@@ -1,14 +1,14 @@
1
- pipeline:
2
- operations:
3
- - name: keras.ops.cast
4
- params:
5
- dtype: float32
6
- - demodulate
7
- - name: beamform
8
- - envelope_detect
9
- - name: normalize
10
- params:
11
- output_range:
12
- - 0.0
13
- - 1.0
14
- - log_compress
 
1
+ pipeline:
2
+ operations:
3
+ - name: keras.ops.cast
4
+ params:
5
+ dtype: float32
6
+ - demodulate
7
+ - name: beamform
8
+ - envelope_detect
9
+ - name: normalize
10
+ params:
11
+ output_range:
12
+ - 0.0
13
+ - 1.0
14
+ - log_compress
ubc/module_C/README.md CHANGED
@@ -1,308 +1,308 @@
1
- ---
2
- pretty_name: "OpenH-RF — UBC Module C Fetal Phantom"
3
- license: cc-by-4.0
4
- task_categories:
5
- - image-to-image
6
- tags:
7
- - ultrasound
8
- - rf
9
- - b-mode
10
- - beamforming
11
- - fetal-imaging
12
- - phantom
13
- - synthetic
14
- - multimodal
15
- - timeseries
16
- - video
17
- - openh-rf
18
- language:
19
- - en
20
- size_categories:
21
- - "1K<n<10K"
22
- ---
23
-
24
- # UBC Module C
25
-
26
- ## Dataset Description
27
-
28
- This dataset contains **3,845 two-dimensional ultrasound frames from two
29
- sessions** with the Kyoto Kagaku Fetus Ultrasound Examination Phantom
30
- “SPACE FAN-ST.” Each frame contains **synthetic RF channel data**, preserved
31
- beamformed IQ, a source-derived B-mode reference, and relative-time links to
32
- NDI tracking, BK scanner viewport video, and Intel RealSense video.
33
-
34
- The RF channels were simulated from already beamformed and compounded BK3500
35
- IQ using a custom scatterer model and assumed transmit/receive geometry. They
36
- are not measured pre-beamforming channels. Modalities have temporal
37
- synchronization only; no validated spatial registration is supplied.
38
-
39
- ## Dataset Contributors
40
-
41
- - **Organization:** The University of British Columbia (UBC), Department of
42
- Electrical and Computer Engineering and School of Biomedical Engineering.
43
- - **Dataset-preparation contact:** Zongze Li, zongze@student.ubc.ca.
44
- - **Contributors:** Septimiu E. Salcudean, Robert Rohling, Qi Zeng,
45
- Tajwar Abrar Aleef, Hamid Moradi, Mohammad Honarvar, Wanwen Chen, Zijian Wu,
46
- Yuxin Chen, Yu Chung Lee, Zongze Li, Patrick Boyan Chen, and Michael Frew.
47
-
48
- ## Dataset Creation Date
49
-
50
- - **Physical phantom acquisition:** 06/12/2026.
51
- - **Release preparation:** 09/08/2026.
52
-
53
- ## License / Terms of Use
54
-
55
- The dataset is licensed under **Creative Commons Attribution 4.0 International
56
- (CC BY 4.0)** (https://creativecommons.org/licenses/by/4.0/). The HDF5 `metadata/credit` field carries
57
- the following attribution with the contributor names and contact listed above:
58
-
59
- > University of British Columbia OpenH-RF contributors (2026). *UBC Module C:
60
- > Synthetic Channel Proxy and Multimodal Fetal Phantom Ultrasound*. OpenH-RF.
61
- > CC BY 4.0.
62
-
63
- ## Intended Usage
64
-
65
- Research uses include synthetic RF-to-B-mode reconstruction, denoising,
66
- super-resolution, fetal-phantom scan-plane assessment, and temporally aligned
67
- multimodal learning. The dataset is for research and technical evaluation,
68
- not clinical diagnosis. Source-derived reference images are not independent
69
- physical ground truth for the simulated channels.
70
-
71
- ## Dataset Characterization
72
-
73
- - **Collection:** Phantom ultrasound and simultaneous room-camera and tracking
74
- recordings, followed by deterministic synthetic-channel generation.
75
- - **Acquisition system:** BK3500 ultrasound; NDI Tool-2 tracked-marker poses;
76
- NDI Tool-1 reference-tool poses; Intel RealSense RGB, left/right infrared,
77
- and encoded depth video.
78
- - **Labels:** Source indices, synchronization validity flags, and simulation
79
- provenance. No manual fetal-structure segmentations or verified phantom
80
- configuration labels are supplied.
81
- - **Simulation framework:** Custom NumPy/SciPy scatterer forward model using
82
- four-point fractional delays, pulse filtering, frame-specific noise, and
83
- `int16` quantization. Session 1 preserves its original amplitudes and shared random draws,
84
- with scatterer depths evaluated on each frame's source IQ axial grid. Session 2 uses fixed
85
- deterministic positions and reflectivity draws for the session, with
86
- frame amplitudes derived from its IQ envelope.
87
- No two-channel proxy data are included as equivalent RF measurements.
88
-
89
- ### Ultrasound and synthetic-channel parameters
90
-
91
- | Parameter | Value | Status |
92
- |---|---:|---|
93
- | Frames | 3,845 | Two sessions; one per matched BK/RealSense frame |
94
- | Focused transmit events per frame | 248 | Stored in each Zea file |
95
- | Receive elements | 192 | Synthetic assumption |
96
- | Axial RF samples per trace | 3,153 | Includes 300 zero-tail samples |
97
- | RF components | 1 real component | Stored as `int16` |
98
- | Sampling frequency | 15 MHz | Stored Zea scan parameter |
99
- | Center/demodulation frequency | 3.75 MHz | Stored Zea scan parameter |
100
- | Assumed sound speed | 1,540 m/s | Stored Zea scan parameter |
101
- | Assumed element pitch | 0.2 mm | Synthetic geometry assumption |
102
- | Assumed nominal aperture | 38.4 mm | 192 elements × 0.2 mm |
103
- | Element width / height | 0.18 mm / 5.0 mm | Synthetic model |
104
- | Assumed transmit focus | 98 mm | Copied from source scan metadata |
105
- | RF trace duration | 210.2 µs | Stored raw-data attribute |
106
- | Zero-amplitude tail | 20 µs / 300 samples | Stored raw-data attributes |
107
- | Target maximum magnitude | 26,000 counts | Below `int16` full scale |
108
-
109
- The element geometry and dimensions are simulation assumptions, not measured
110
- probe specifications. The relationship between the recorded 98-mm focus and
111
- the proprietary scanner transmit law is unknown.
112
-
113
-
114
- ## Dataset Format
115
-
116
- Each Zea HDF5 file contains one frame and is written with **Zea 0.1.5**.
117
- The writer-version field describes serialization,
118
- not processing speed. Source IQ and its display reference are under
119
- `/custom/source_provenance`.
120
-
121
- ### Package layout
122
-
123
- | Path | Contents |
124
- |---|---|
125
- | `acquisitions/session_01/session_01_fNNNN.hdf5` | Selected source frames 0055–2586; gaps are intentional |
126
- | `acquisitions/session_02/session_02_fNNNN.hdf5` | Selected source frames 0001–5017; gaps are intentional |
127
- | `source_bmode/session_XX/` | BK viewport MP4 video |
128
- | `external_camera/session_XX/` | RealSense MP4 video |
129
- | [`pipeline.yaml`](pipeline.yaml) | Shared reconstruction configuration for both sessions |
130
-
131
- `session_XX` denotes `session_01` or `session_02`. All public identifiers are
132
- neutral session labels. HDF5 `source_file` values identify private source
133
- container aliases, not downloadable package files; the source IQ is embedded
134
- in each sample. This HF release includes HDF5 files, this card, the pipeline
135
- configuration, and the source BK viewport and RealSense MP4 videos.
136
- Composite review videos, standalone scripts, timing/tracking tables,
137
- calibration sidecars, and validation reports are not included. References
138
- inside unchanged HDF5 metadata may identify sidecars from the source package
139
- that are not available in this release.
140
-
141
- ### Timestamp conventions
142
-
143
- **All acquisition timestamps are session-relative. Absolute wall-clock times
144
- are intentionally withheld for de-identification.** IQ, BK viewport, NDI
145
- reference-tool, and RealSense host times are relative to the first **source** IQ
146
- frame of their own session, even when that frame is excluded from the release. RealSense device time is relative to its first camera frame.
147
- Negative host-relative camera times can precede the first IQ frame.
148
- Each one-frame Zea probe-pose timestamp is locally zero, with session-relative
149
- IQ time stored separately in `/custom/synchronization`.
150
-
151
- Use alignment indices and validity flags, not video frame rate alone, to link
152
- modalities. The HDF5 Tool-2 previous/next/recorded-last indices address the
153
- **status-zero subset** of the source tracking records. Tool-1 reference
154
- indices address the full source reference-tool records. These standalone
155
- tables are not included in this HF release. MP4 playback time is an encoded
156
- presentation timeline, not an acquisition clock; use the per-frame
157
- synchronization metadata retained in HDF5.
158
-
159
- ## Dataset Quantification
160
-
161
- | Quantity | session_01 | session_02 | Total |
162
- |---|---:|---:|---:|
163
- | Retained ultrasound frames / HDF5 files | 1,339 | 2,506 | 3,845 |
164
- | Original ultrasound frames | 2,613 | 5,019 | 7,632 |
165
- | Excluded unmatched or repeated video associations | 1,274 | 2,513 | 3,787 |
166
- | Retained source frame range (with gaps) | 55–2586 | 1–5017 | Original frame numbers preserved |
167
- | Retained IQ time span (s) | 1.063–52.681 | 0.018–93.757 | Separate source-session origins |
168
- | BK viewport video frames | 1,582 | 2,798 | 4,380 |
169
- | Frames per RealSense stream | 1,591 | 3,677 | 5,268 |
170
- | Valid BK / NDI Tool-2 / NDI Tool-1 / RealSense links | 1,339 each | 2,506 each | 3,845 each |
171
-
172
- **Frame selection:** Every retained ultrasound frame has a valid BK video link,
173
- RealSense video link, interpolated NDI Tool-2 pose, and NDI Tool-1 reference
174
- link. Each BK frame and each RealSense frame is associated with **at most one**
175
- retained ultrasound frame. Selection maximizes the number of chronological
176
- matches, then minimizes the sum of absolute BK/RealSense timing offsets; source
177
- frame order breaks remaining ties. Original frame indices, relative times, and
178
- noise seeds are preserved. HDF5 files contain only retained ultrasound frames;
179
- videos retain their full temporal context.
180
-
181
- **HDF5 storage:** session_01: 205,236,518,547 bytes (191.14 GiB); session_02: 388,206,776,234 bytes (361.55 GiB). Total: **593,443,294,781 bytes (552.69 GiB)**. Files use lossless compression.
182
-
183
- **Splits:** None supplied. Neighboring frames and the two sessions share a
184
- phantom and acquisition setting. Split by session for temporal separation;
185
- this does not establish generalization to different phantoms or patients.
186
-
187
- ### Per-sample feature table
188
-
189
- | Name | Shape | Dtype | Units | Description |
190
- |---|---:|---|---|---|
191
- | `/tracks/track_0/data/raw_data` | `(1, 248, 3153, 192, 1)` | `int16` | scaled ADC-like counts | Synthetic real-RF channel tensor ordered as frame, transmit, axial sample, receive element, RF component |
192
- | `/tracks/track_0/data/image/values` | `(1, 704, 248, 1)` | `uint8` | display gray level | Stored source-derived reference image; not used as a reconstruction input |
193
- | `/tracks/track_0/data/image/coordinates` | `(704, 248, 3)` | `float32` | m | Cartesian coordinate for each stored reference-image pixel |
194
- | `/probe/probe_geometry` | `(192, 3)` | `float32` | m | Assumed synthetic receive-element positions |
195
- | `/tracks/track_0/scan/tx_apodizations` | `(248, 192)` | `float32` | unitless | Assumed transmit apodization per event and element |
196
- | `/tracks/track_0/scan/t0_delays` | `(248, 192)` | `float32` | s | Assumed transmit delay per event and element |
197
- | `/tracks/track_0/scan/transmit_origins` | `(248, 3)` | `float32` | m | Transmit-beam origins |
198
- | `/tracks/track_0/scan/focus_distances` | `(248,)` | `float32` | m | Focus distance for each transmit event |
199
- | `/tracks/track_0/scan/azimuth_angles` | `(248,)` | `float32` | rad | Azimuth angle for each scanline |
200
- | `/tracks/track_0/scan/initial_times` | `(248,)` | `float32` | s | ADC start time for each transmit event |
201
- | `/tracks/track_0/scan/tgc_gain_curve` | `(3153,)` | `float32` | unitless | Stored time-gain-compensation curve |
202
- | `/metadata/probe_pose/translation` | `(1, 3)` | `float32` | m | Interpolated NDI Tool-2 marker translation; not a calibrated probe-tip pose |
203
- | `/metadata/probe_pose/rotation` | `(1, 4)` | `float32` | unitless | NDI Tool-2 marker quaternion in `xyzw` order |
204
- | `/metadata/probe_pose/timestamps` | `(1,)` | `float32` | s | Locally rebased one-frame pose time; session-relative IQ time is stored separately |
205
- | `/custom/source_provenance/source_beamformed_iq` | `(N_IQ, 248, 2)` | `float32` | arbitrary | Preserved source beamformed and compounded IQ; axial sample count varies by frame |
206
- | `/custom/source_provenance/source_bmode_normalized` | `(704, 248)` | `float32` | normalized intensity | Source IQ envelope displayed over −50 to 0 dB |
207
- | `/custom/source_provenance/imaging_depth_m` | `()` | `float32` | m | 0.14-m depth read by reconstruction |
208
- | `/custom/simulation/scatterer_positions` | `(95232, 3)` | `float32` | m | Synthetic coordinates; source-grid-dependent in session 1, fixed across session 2 |
209
- | `/custom/simulation/scatterer_magnitudes` | `(95232,)` | `float32` | arbitrary | Signed synthetic scatterer magnitudes |
210
- | `/custom/simulation/simulation_settings` | `(11,)` | `float64` | mixed | Element, transmit, scatterer, aperture, focus, timing, scaling, and seed settings; ordering is documented in the dataset attribute |
211
- | `/custom/synchronization/*` | scalar or small vector | mixed | s, ms, rad, m, index, or unitless | Relative-time frame links, validity flags, NDI poses, source-frame fields, and deterministic simulation seeds |
212
- | `/custom/session_calibration/image_t_tracker` | `(4, 4)` | `float64` | translation in mm; linear-block units unconfirmed | Source-supplied transform; direction and spatial registration unconfirmed |
213
-
214
- `N_IQ` is 1,824, 1,840, or 1,888, as recorded per frame in
215
- `/custom/synchronization/source_valid_axial_samples`. The synthetic RF tensor
216
- has a fixed 3,153 axial samples regardless of source IQ length.
217
-
218
- Scalar Zea fields additionally store the 15-MHz sampling frequency, 3.75-MHz
219
- center and demodulation frequencies, and 1,540-m/s sound speed. Dataset-level
220
- attributes provide descriptions and units for individual fields.
221
-
222
-
223
- ### Camera representation and calibration
224
-
225
- RGB and left/right IR are privacy crops, independently reviewed for each
226
- session: `x=320, y=200, width=720, height=520` from 1280 × 720 source frames.
227
- All source frames and their order are retained at 30 encoded fps. Crop-adjusted
228
- principal points satisfy `cx_crop = cx_source − 320` and
229
- `cy_crop = cy_source − 200`; focal lengths, distortion coefficients, and
230
- inter-camera extrinsics are unchanged. Depth remains an uncropped encoded
231
- preview. Standalone calibration and crop-check sidecars are not included in
232
- this HF release.
233
-
234
- ## Data Validation
235
-
236
- ### Reconstruction
237
-
238
- The contributor reports validation with Python 3.12, Zea 0.1.5, and a
239
- CUDA 12.8 / PyTorch configuration. The retained `pipeline.yaml` records the
240
- shared reconstruction configuration; the standalone reconstruction entry
241
- point and its dependency file are not included in this HF release.
242
-
243
- The contributor's reconstruction reads synthetic `raw_data`, Zea scan/probe parameters, and
244
- imaging depth. Zea's native aligned scanline DAS uses exactly one transmit per
245
- scanline, followed by envelope detection, normalization, log compression, and
246
- the documented display conversion. Source IQ, stored B-mode, and videos are
247
- not reconstruction inputs. Prepared pipelines are reused only for matching
248
- scan/probe parameters and precision/device settings.
249
-
250
- The contributor's mixed-precision qualification compares against float32,
251
- using float32 if scanline RMSE exceeds 0.001 dB or maximum difference exceeds
252
- 0.05 dB. This describes the contributor's validation, not a runnable command
253
- included in this release. The contributor reports reconstruction of 90 frames
254
- across the two sessions, with four endpoints shared with a six-frame precision
255
- comparison. This does not imply that every RF file has been reconstructed.
256
-
257
- ### Software references
258
-
259
- - Harris, C. R., et al. (2020). [Array programming with NumPy](https://doi.org/10.1038/s41586-020-2649-2). *Nature*, 585, 357–362.
260
- - Virtanen, P., et al. (2020). [SciPy 1.0: fundamental algorithms for scientific computing in Python](https://doi.org/10.1038/s41592-019-0686-2). *Nature Methods*, 17, 261–272.
261
- - Stevens, T. S. W., et al. (2026). [zea: A Toolbox for Cognitive Ultrasound Imaging](https://doi.org/10.21105/joss.09881). *Journal of Open Source Software*, 11(121), 9881. See also the [Zea operations documentation](https://zea.readthedocs.io/en/stable/_autosummary/zea.ops.html).
262
-
263
- ## Subject Metadata
264
-
265
- - **Subject type:** Phantom; no human patient or animal subject.
266
- - **Phantom:** Kyoto Kagaku Fetus Ultrasound Examination Phantom “SPACE FAN-ST.”
267
- - **Stable HDF5 subject ID:** `Kyoto-Kagaku-SPACE-FAN-ST` in both sessions.
268
- - **Sessions:** `session_01` and `session_02`, recorded separately from subject ID.
269
- - **Anatomical region:** Fetal ultrasound training phantom within an abdominal model.
270
- - **Demographics/pathology:** Not applicable. No verified phantom configuration label.
271
-
272
- ## Known Issues
273
-
274
- - **Synthetic provenance:** Already beamformed IQ cannot recover original
275
- element-level receive signals. RF and source-derived B-mode share source
276
- information; similarity is not independent physical validation.
277
- - **Unverified acquisition geometry:** The synthetic geometry is assumed.
278
- Scanner transmit law, receive aperture, RF time-zero, and proprietary
279
- compound/multibeam processing are unavailable.
280
- - **Display approximation:** Scan conversion uses a 31.1-mm display aperture,
281
- ±14.96° scanline range, virtual apex, and 4% black border. This differs from
282
- the 38.4-mm synthetic receive aperture and does not alter DAS delays.
283
- - **Spatial registration:** Probe/tool poses and ultrasound/cameras are
284
- **temporally synchronized only, not spatially registered**. The source-supplied
285
- `image_t_tracker` matrix has an **unconfirmed transform direction**. No
286
- camera-to-NDI or camera-to-ultrasound transform, calibrated probe-tip mapping,
287
- or phantom-anatomical registration is supplied. NDI axis interpretation is
288
- unverified. RealSense inter-camera calibration does not establish those mappings.
289
- - **Camera encoding:** RGB/IR are lossy H.264 crops. Depth is an H.264 display
290
- preview, not lossless metric Z16 depth.
291
- - **Identical infrared views:** Within each session, source IR-left/right are
292
- byte-identical, as are their cropped derivatives. They are not independent
293
- stereo views; supplied stereo extrinsics do not resolve this source limitation.
294
-
295
- ## Ethical Considerations
296
-
297
- Ultrasound content is phantom and simulation data, with no patient records,
298
- demographics, or animal subjects. Patient consent, human-subject IRB approval,
299
- and animal-welfare review are not applicable to that content.
300
-
301
- Room-camera recordings originally captured people. Released RGB/IR crops
302
- retain hands/forearms but exclude faces and the wider room. Uncropped RGB/IR,
303
- audio, original source identifiers, absolute acquisition clocks, and local
304
- filesystem paths are excluded. The camera review fully decoded all ten retained streams, inspected
305
- 48 distributed frames per stream, and reviewed every face-detector hit.
306
- The contributor reports that the reviewed hits were false positives and no
307
- faces were visible in the crops. The underlying review records are not
308
- included in this HF release.
 
1
+ ---
2
+ pretty_name: "OpenH-RF — UBC Module C Fetal Phantom"
3
+ license: cc-by-4.0
4
+ task_categories:
5
+ - image-to-image
6
+ tags:
7
+ - ultrasound
8
+ - rf
9
+ - b-mode
10
+ - beamforming
11
+ - fetal-imaging
12
+ - phantom
13
+ - synthetic
14
+ - multimodal
15
+ - timeseries
16
+ - video
17
+ - openh-rf
18
+ language:
19
+ - en
20
+ size_categories:
21
+ - "1K<n<10K"
22
+ ---
23
+
24
+ # UBC Module C
25
+
26
+ ## Dataset Description
27
+
28
+ This dataset contains **3,845 two-dimensional ultrasound frames from two
29
+ sessions** with the Kyoto Kagaku Fetus Ultrasound Examination Phantom
30
+ “SPACE FAN-ST.” Each frame contains **synthetic RF channel data**, preserved
31
+ beamformed IQ, a source-derived B-mode reference, and relative-time links to
32
+ NDI tracking, BK scanner viewport video, and Intel RealSense video.
33
+
34
+ The RF channels were simulated from already beamformed and compounded BK3500
35
+ IQ using a custom scatterer model and assumed transmit/receive geometry. They
36
+ are not measured pre-beamforming channels. Modalities have temporal
37
+ synchronization only; no validated spatial registration is supplied.
38
+
39
+ ## Dataset Contributors
40
+
41
+ - **Organization:** The University of British Columbia (UBC), Department of
42
+ Electrical and Computer Engineering and School of Biomedical Engineering.
43
+ - **Dataset-preparation contact:** Zongze Li, zongze@student.ubc.ca.
44
+ - **Contributors:** Septimiu E. Salcudean, Robert Rohling, Qi Zeng,
45
+ Tajwar Abrar Aleef, Hamid Moradi, Mohammad Honarvar, Wanwen Chen, Zijian Wu,
46
+ Yuxin Chen, Yu Chung Lee, Zongze Li, Patrick Boyan Chen, and Michael Frew.
47
+
48
+ ## Dataset Creation Date
49
+
50
+ - **Physical phantom acquisition:** 06/12/2026.
51
+ - **Release preparation:** 09/08/2026.
52
+
53
+ ## License / Terms of Use
54
+
55
+ The dataset is licensed under **Creative Commons Attribution 4.0 International
56
+ (CC BY 4.0)** (https://creativecommons.org/licenses/by/4.0/). The HDF5 `metadata/credit` field carries
57
+ the following attribution with the contributor names and contact listed above:
58
+
59
+ > University of British Columbia OpenH-RF contributors (2026). *UBC Module C:
60
+ > Synthetic Channel Proxy and Multimodal Fetal Phantom Ultrasound*. OpenH-RF.
61
+ > CC BY 4.0.
62
+
63
+ ## Intended Usage
64
+
65
+ Research uses include synthetic RF-to-B-mode reconstruction, denoising,
66
+ super-resolution, fetal-phantom scan-plane assessment, and temporally aligned
67
+ multimodal learning. The dataset is for research and technical evaluation,
68
+ not clinical diagnosis. Source-derived reference images are not independent
69
+ physical ground truth for the simulated channels.
70
+
71
+ ## Dataset Characterization
72
+
73
+ - **Collection:** Phantom ultrasound and simultaneous room-camera and tracking
74
+ recordings, followed by deterministic synthetic-channel generation.
75
+ - **Acquisition system:** BK3500 ultrasound; NDI Tool-2 tracked-marker poses;
76
+ NDI Tool-1 reference-tool poses; Intel RealSense RGB, left/right infrared,
77
+ and encoded depth video.
78
+ - **Labels:** Source indices, synchronization validity flags, and simulation
79
+ provenance. No manual fetal-structure segmentations or verified phantom
80
+ configuration labels are supplied.
81
+ - **Simulation framework:** Custom NumPy/SciPy scatterer forward model using
82
+ four-point fractional delays, pulse filtering, frame-specific noise, and
83
+ `int16` quantization. Session 1 preserves its original amplitudes and shared random draws,
84
+ with scatterer depths evaluated on each frame's source IQ axial grid. Session 2 uses fixed
85
+ deterministic positions and reflectivity draws for the session, with
86
+ frame amplitudes derived from its IQ envelope.
87
+ No two-channel proxy data are included as equivalent RF measurements.
88
+
89
+ ### Ultrasound and synthetic-channel parameters
90
+
91
+ | Parameter | Value | Status |
92
+ |---|---:|---|
93
+ | Frames | 3,845 | Two sessions; one per matched BK/RealSense frame |
94
+ | Focused transmit events per frame | 248 | Stored in each Zea file |
95
+ | Receive elements | 192 | Synthetic assumption |
96
+ | Axial RF samples per trace | 3,153 | Includes 300 zero-tail samples |
97
+ | RF components | 1 real component | Stored as `int16` |
98
+ | Sampling frequency | 15 MHz | Stored Zea scan parameter |
99
+ | Center/demodulation frequency | 3.75 MHz | Stored Zea scan parameter |
100
+ | Assumed sound speed | 1,540 m/s | Stored Zea scan parameter |
101
+ | Assumed element pitch | 0.2 mm | Synthetic geometry assumption |
102
+ | Assumed nominal aperture | 38.4 mm | 192 elements × 0.2 mm |
103
+ | Element width / height | 0.18 mm / 5.0 mm | Synthetic model |
104
+ | Assumed transmit focus | 98 mm | Copied from source scan metadata |
105
+ | RF trace duration | 210.2 µs | Stored raw-data attribute |
106
+ | Zero-amplitude tail | 20 µs / 300 samples | Stored raw-data attributes |
107
+ | Target maximum magnitude | 26,000 counts | Below `int16` full scale |
108
+
109
+ The element geometry and dimensions are simulation assumptions, not measured
110
+ probe specifications. The relationship between the recorded 98-mm focus and
111
+ the proprietary scanner transmit law is unknown.
112
+
113
+
114
+ ## Dataset Format
115
+
116
+ Each Zea HDF5 file contains one frame and is written with **Zea 0.1.5**.
117
+ The writer-version field describes serialization,
118
+ not processing speed. Source IQ and its display reference are under
119
+ `/custom/source_provenance`.
120
+
121
+ ### Package layout
122
+
123
+ | Path | Contents |
124
+ |---|---|
125
+ | `acquisitions/session_01/session_01_fNNNN.hdf5` | Selected source frames 0055–2586; gaps are intentional |
126
+ | `acquisitions/session_02/session_02_fNNNN.hdf5` | Selected source frames 0001–5017; gaps are intentional |
127
+ | `source_bmode/session_XX/` | BK viewport MP4 video |
128
+ | `external_camera/session_XX/` | RealSense MP4 video |
129
+ | [`pipeline.yaml`](pipeline.yaml) | Shared reconstruction configuration for both sessions |
130
+
131
+ `session_XX` denotes `session_01` or `session_02`. All public identifiers are
132
+ neutral session labels. HDF5 `source_file` values identify private source
133
+ container aliases, not downloadable package files; the source IQ is embedded
134
+ in each sample. This HF release includes HDF5 files, this card, the pipeline
135
+ configuration, and the source BK viewport and RealSense MP4 videos.
136
+ Composite review videos, standalone scripts, timing/tracking tables,
137
+ calibration sidecars, and validation reports are not included. References
138
+ inside unchanged HDF5 metadata may identify sidecars from the source package
139
+ that are not available in this release.
140
+
141
+ ### Timestamp conventions
142
+
143
+ **All acquisition timestamps are session-relative. Absolute wall-clock times
144
+ are intentionally withheld for de-identification.** IQ, BK viewport, NDI
145
+ reference-tool, and RealSense host times are relative to the first **source** IQ
146
+ frame of their own session, even when that frame is excluded from the release. RealSense device time is relative to its first camera frame.
147
+ Negative host-relative camera times can precede the first IQ frame.
148
+ Each one-frame Zea probe-pose timestamp is locally zero, with session-relative
149
+ IQ time stored separately in `/custom/synchronization`.
150
+
151
+ Use alignment indices and validity flags, not video frame rate alone, to link
152
+ modalities. The HDF5 Tool-2 previous/next/recorded-last indices address the
153
+ **status-zero subset** of the source tracking records. Tool-1 reference
154
+ indices address the full source reference-tool records. These standalone
155
+ tables are not included in this HF release. MP4 playback time is an encoded
156
+ presentation timeline, not an acquisition clock; use the per-frame
157
+ synchronization metadata retained in HDF5.
158
+
159
+ ## Dataset Quantification
160
+
161
+ | Quantity | session_01 | session_02 | Total |
162
+ |---|---:|---:|---:|
163
+ | Retained ultrasound frames / HDF5 files | 1,339 | 2,506 | 3,845 |
164
+ | Original ultrasound frames | 2,613 | 5,019 | 7,632 |
165
+ | Excluded unmatched or repeated video associations | 1,274 | 2,513 | 3,787 |
166
+ | Retained source frame range (with gaps) | 55–2586 | 1–5017 | Original frame numbers preserved |
167
+ | Retained IQ time span (s) | 1.063–52.681 | 0.018–93.757 | Separate source-session origins |
168
+ | BK viewport video frames | 1,582 | 2,798 | 4,380 |
169
+ | Frames per RealSense stream | 1,591 | 3,677 | 5,268 |
170
+ | Valid BK / NDI Tool-2 / NDI Tool-1 / RealSense links | 1,339 each | 2,506 each | 3,845 each |
171
+
172
+ **Frame selection:** Every retained ultrasound frame has a valid BK video link,
173
+ RealSense video link, interpolated NDI Tool-2 pose, and NDI Tool-1 reference
174
+ link. Each BK frame and each RealSense frame is associated with **at most one**
175
+ retained ultrasound frame. Selection maximizes the number of chronological
176
+ matches, then minimizes the sum of absolute BK/RealSense timing offsets; source
177
+ frame order breaks remaining ties. Original frame indices, relative times, and
178
+ noise seeds are preserved. HDF5 files contain only retained ultrasound frames;
179
+ videos retain their full temporal context.
180
+
181
+ **HDF5 storage:** session_01: 205,236,518,547 bytes (191.14 GiB); session_02: 388,206,776,234 bytes (361.55 GiB). Total: **593,443,294,781 bytes (552.69 GiB)**. Files use lossless compression.
182
+
183
+ **Splits:** None supplied. Neighboring frames and the two sessions share a
184
+ phantom and acquisition setting. Split by session for temporal separation;
185
+ this does not establish generalization to different phantoms or patients.
186
+
187
+ ### Per-sample feature table
188
+
189
+ | Name | Shape | Dtype | Units | Description |
190
+ |---|---:|---|---|---|
191
+ | `/tracks/track_0/data/raw_data` | `(1, 248, 3153, 192, 1)` | `int16` | scaled ADC-like counts | Synthetic real-RF channel tensor ordered as frame, transmit, axial sample, receive element, RF component |
192
+ | `/tracks/track_0/data/image/values` | `(1, 704, 248, 1)` | `uint8` | display gray level | Stored source-derived reference image; not used as a reconstruction input |
193
+ | `/tracks/track_0/data/image/coordinates` | `(704, 248, 3)` | `float32` | m | Cartesian coordinate for each stored reference-image pixel |
194
+ | `/probe/probe_geometry` | `(192, 3)` | `float32` | m | Assumed synthetic receive-element positions |
195
+ | `/tracks/track_0/scan/tx_apodizations` | `(248, 192)` | `float32` | unitless | Assumed transmit apodization per event and element |
196
+ | `/tracks/track_0/scan/t0_delays` | `(248, 192)` | `float32` | s | Assumed transmit delay per event and element |
197
+ | `/tracks/track_0/scan/transmit_origins` | `(248, 3)` | `float32` | m | Transmit-beam origins |
198
+ | `/tracks/track_0/scan/focus_distances` | `(248,)` | `float32` | m | Focus distance for each transmit event |
199
+ | `/tracks/track_0/scan/azimuth_angles` | `(248,)` | `float32` | rad | Azimuth angle for each scanline |
200
+ | `/tracks/track_0/scan/initial_times` | `(248,)` | `float32` | s | ADC start time for each transmit event |
201
+ | `/tracks/track_0/scan/tgc_gain_curve` | `(3153,)` | `float32` | unitless | Stored time-gain-compensation curve |
202
+ | `/metadata/probe_pose/translation` | `(1, 3)` | `float32` | m | Interpolated NDI Tool-2 marker translation; not a calibrated probe-tip pose |
203
+ | `/metadata/probe_pose/rotation` | `(1, 4)` | `float32` | unitless | NDI Tool-2 marker quaternion in `xyzw` order |
204
+ | `/metadata/probe_pose/timestamps` | `(1,)` | `float32` | s | Locally rebased one-frame pose time; session-relative IQ time is stored separately |
205
+ | `/custom/source_provenance/source_beamformed_iq` | `(N_IQ, 248, 2)` | `float32` | arbitrary | Preserved source beamformed and compounded IQ; axial sample count varies by frame |
206
+ | `/custom/source_provenance/source_bmode_normalized` | `(704, 248)` | `float32` | normalized intensity | Source IQ envelope displayed over −50 to 0 dB |
207
+ | `/custom/source_provenance/imaging_depth_m` | `()` | `float32` | m | 0.14-m depth read by reconstruction |
208
+ | `/custom/simulation/scatterer_positions` | `(95232, 3)` | `float32` | m | Synthetic coordinates; source-grid-dependent in session 1, fixed across session 2 |
209
+ | `/custom/simulation/scatterer_magnitudes` | `(95232,)` | `float32` | arbitrary | Signed synthetic scatterer magnitudes |
210
+ | `/custom/simulation/simulation_settings` | `(11,)` | `float64` | mixed | Element, transmit, scatterer, aperture, focus, timing, scaling, and seed settings; ordering is documented in the dataset attribute |
211
+ | `/custom/synchronization/*` | scalar or small vector | mixed | s, ms, rad, m, index, or unitless | Relative-time frame links, validity flags, NDI poses, source-frame fields, and deterministic simulation seeds |
212
+ | `/custom/session_calibration/image_t_tracker` | `(4, 4)` | `float64` | translation in mm; linear-block units unconfirmed | Source-supplied transform; direction and spatial registration unconfirmed |
213
+
214
+ `N_IQ` is 1,824, 1,840, or 1,888, as recorded per frame in
215
+ `/custom/synchronization/source_valid_axial_samples`. The synthetic RF tensor
216
+ has a fixed 3,153 axial samples regardless of source IQ length.
217
+
218
+ Scalar Zea fields additionally store the 15-MHz sampling frequency, 3.75-MHz
219
+ center and demodulation frequencies, and 1,540-m/s sound speed. Dataset-level
220
+ attributes provide descriptions and units for individual fields.
221
+
222
+
223
+ ### Camera representation and calibration
224
+
225
+ RGB and left/right IR are privacy crops, independently reviewed for each
226
+ session: `x=320, y=200, width=720, height=520` from 1280 × 720 source frames.
227
+ All source frames and their order are retained at 30 encoded fps. Crop-adjusted
228
+ principal points satisfy `cx_crop = cx_source − 320` and
229
+ `cy_crop = cy_source − 200`; focal lengths, distortion coefficients, and
230
+ inter-camera extrinsics are unchanged. Depth remains an uncropped encoded
231
+ preview. Standalone calibration and crop-check sidecars are not included in
232
+ this HF release.
233
+
234
+ ## Data Validation
235
+
236
+ ### Reconstruction
237
+
238
+ The contributor reports validation with Python 3.12, Zea 0.1.5, and a
239
+ CUDA 12.8 / PyTorch configuration. The retained `pipeline.yaml` records the
240
+ shared reconstruction configuration; the standalone reconstruction entry
241
+ point and its dependency file are not included in this HF release.
242
+
243
+ The contributor's reconstruction reads synthetic `raw_data`, Zea scan/probe parameters, and
244
+ imaging depth. Zea's native aligned scanline DAS uses exactly one transmit per
245
+ scanline, followed by envelope detection, normalization, log compression, and
246
+ the documented display conversion. Source IQ, stored B-mode, and videos are
247
+ not reconstruction inputs. Prepared pipelines are reused only for matching
248
+ scan/probe parameters and precision/device settings.
249
+
250
+ The contributor's mixed-precision qualification compares against float32,
251
+ using float32 if scanline RMSE exceeds 0.001 dB or maximum difference exceeds
252
+ 0.05 dB. This describes the contributor's validation, not a runnable command
253
+ included in this release. The contributor reports reconstruction of 90 frames
254
+ across the two sessions, with four endpoints shared with a six-frame precision
255
+ comparison. This does not imply that every RF file has been reconstructed.
256
+
257
+ ### Software references
258
+
259
+ - Harris, C. R., et al. (2020). [Array programming with NumPy](https://doi.org/10.1038/s41586-020-2649-2). *Nature*, 585, 357–362.
260
+ - Virtanen, P., et al. (2020). [SciPy 1.0: fundamental algorithms for scientific computing in Python](https://doi.org/10.1038/s41592-019-0686-2). *Nature Methods*, 17, 261–272.
261
+ - Stevens, T. S. W., et al. (2026). [zea: A Toolbox for Cognitive Ultrasound Imaging](https://doi.org/10.21105/joss.09881). *Journal of Open Source Software*, 11(121), 9881. See also the [Zea operations documentation](https://zea.readthedocs.io/en/stable/_autosummary/zea.ops.html).
262
+
263
+ ## Subject Metadata
264
+
265
+ - **Subject type:** Phantom; no human patient or animal subject.
266
+ - **Phantom:** Kyoto Kagaku Fetus Ultrasound Examination Phantom “SPACE FAN-ST.”
267
+ - **Stable HDF5 subject ID:** `Kyoto-Kagaku-SPACE-FAN-ST` in both sessions.
268
+ - **Sessions:** `session_01` and `session_02`, recorded separately from subject ID.
269
+ - **Anatomical region:** Fetal ultrasound training phantom within an abdominal model.
270
+ - **Demographics/pathology:** Not applicable. No verified phantom configuration label.
271
+
272
+ ## Known Issues
273
+
274
+ - **Synthetic provenance:** Already beamformed IQ cannot recover original
275
+ element-level receive signals. RF and source-derived B-mode share source
276
+ information; similarity is not independent physical validation.
277
+ - **Unverified acquisition geometry:** The synthetic geometry is assumed.
278
+ Scanner transmit law, receive aperture, RF time-zero, and proprietary
279
+ compound/multibeam processing are unavailable.
280
+ - **Display approximation:** Scan conversion uses a 31.1-mm display aperture,
281
+ ±14.96° scanline range, virtual apex, and 4% black border. This differs from
282
+ the 38.4-mm synthetic receive aperture and does not alter DAS delays.
283
+ - **Spatial registration:** Probe/tool poses and ultrasound/cameras are
284
+ **temporally synchronized only, not spatially registered**. The source-supplied
285
+ `image_t_tracker` matrix has an **unconfirmed transform direction**. No
286
+ camera-to-NDI or camera-to-ultrasound transform, calibrated probe-tip mapping,
287
+ or phantom-anatomical registration is supplied. NDI axis interpretation is
288
+ unverified. RealSense inter-camera calibration does not establish those mappings.
289
+ - **Camera encoding:** RGB/IR are lossy H.264 crops. Depth is an H.264 display
290
+ preview, not lossless metric Z16 depth.
291
+ - **Identical infrared views:** Within each session, source IR-left/right are
292
+ byte-identical, as are their cropped derivatives. They are not independent
293
+ stereo views; supplied stereo extrinsics do not resolve this source limitation.
294
+
295
+ ## Ethical Considerations
296
+
297
+ Ultrasound content is phantom and simulation data, with no patient records,
298
+ demographics, or animal subjects. Patient consent, human-subject IRB approval,
299
+ and animal-welfare review are not applicable to that content.
300
+
301
+ Room-camera recordings originally captured people. Released RGB/IR crops
302
+ retain hands/forearms but exclude faces and the wider room. Uncropped RGB/IR,
303
+ audio, original source identifiers, absolute acquisition clocks, and local
304
+ filesystem paths are excluded. The camera review fully decoded all ten retained streams, inspected
305
+ 48 distributed frames per stream, and reviewed every face-detector hit.
306
+ The contributor reports that the reviewed hits were false positives and no
307
+ faces were visible in the crops. The underlying review records are not
308
+ included in this HF release.