oslo: restructure the data cards to the common layout

#54
oslo/A_cardiac/README.md CHANGED
@@ -1,4 +1,5 @@
1
  ---
 
2
  pretty_name: "USTB - In-vivo Cardiac (Verasonics P4-2)"
3
  license: cc-by-4.0
4
  task_categories:
@@ -17,18 +18,19 @@ size_categories:
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
 
@@ -36,9 +38,7 @@ University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius
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
 
@@ -48,18 +48,17 @@ Generalized reconstruction and adaptive beamforming of cardiac ultrasound (RFP t
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
 
@@ -100,20 +99,9 @@ Healthy adult volunteer(s). Anatomy: heart (parasternal long-axis, apical four-c
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
 
@@ -122,3 +110,7 @@ Focused sector acquisition: lateral resolution and field of view follow the tran
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
+ name: oslo-a-cardiac
3
  pretty_name: "USTB - In-vivo Cardiac (Verasonics P4-2)"
4
  license: cc-by-4.0
5
  task_categories:
 
18
 
19
  # USTB - In-vivo Cardiac (Verasonics P4-2)
20
 
 
 
 
 
 
21
  ## Dataset Description
22
 
23
+ Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** (see the [collection card](../README.md)).
24
+
25
  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.
26
 
27
+ ## Dataset Contributor(s)
28
 
29
+ - Ole Marius Hoel Rindal <omrindal@ifi.uio.no> (primary contact)
30
+ - Yucel Karabiyik
31
+ - Sven Peter Nasholm
32
+ - Andreas Austeng
33
+ - University of Oslo (UiO), Department of Informatics
34
 
35
  ## Dataset Creation Date
36
 
 
38
 
39
  ## License / Terms of Use
40
 
41
+ [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode.en). Retain attribution and identify modifications when reusing the data.
 
 
42
 
43
  ## Intended Usage
44
 
 
48
 
49
  - **Data Collection Method:** clinical
50
  - **Labeling Method:** N/A (raw channel data; no annotations).
51
+ - **Acquisition system:** probe(s) P4-2; element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
52
+
53
+ ## Processing the Dataset
54
+
55
+ The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/oslo/reconstruct.py) at the root of this collection, as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), together with the `pipeline*.yaml` definitions at the collection root and the [zea library](https://github.com/tue-bmd/zea). The script streams the data from the Hugging Face Hub; `parameters.yaml` picks the pipeline, display window and dynamic range per acquisition (see the [collection card](../README.md#processing-the-dataset)).
56
 
57
  ## Dataset Format
58
 
59
+ [zea v0.1.6](https://github.com/tue-bmd/zea)
60
+
61
+ All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single acquisition with raw channel data `/data/raw_data` of shape `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1). No demodulation or decimation was applied during packaging beyond conversion from the USTB Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
 
 
 
62
 
63
  ## Dataset Quantification
64
 
 
99
 
100
  ## Data Validation
101
 
102
+ A Delay-And-Sum `zea.Pipeline` (`cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`; RF is demodulated in-pipeline, IQ uses a baseband pipeline) reconstructs every acquisition as a portable check that the recorded geometry and timing are correct (see *Processing the Dataset*).
103
+
104
+ The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry. These are the recommended reference reconstructions for visual verification.
 
 
 
 
 
 
 
 
 
 
 
105
 
106
  ## Known Issues
107
 
 
110
  ## Ethical Considerations
111
 
112
  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).
113
+
114
+ ## Citation
115
+
116
+ Please cite the UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo (Zenodo record 20261898).
oslo/B_carotid/README.md CHANGED
@@ -1,4 +1,5 @@
1
  ---
 
2
  pretty_name: "USTB - In-vivo Carotid (Verasonics L7-4)"
3
  license: cc-by-4.0
4
  task_categories:
@@ -18,18 +19,19 @@ size_categories:
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
 
@@ -37,9 +39,7 @@ University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius
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
 
@@ -49,18 +49,17 @@ Generalized reconstruction and adaptive beamforming of vascular ultrasound (RFP
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
 
@@ -102,20 +101,9 @@ Healthy adult volunteer(s). Anatomy: carotid artery (cross-section). Scanner: Ve
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
 
@@ -124,3 +112,7 @@ Single/few-frame acquisitions; focused linear imaging.
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
+ name: oslo-b-carotid
3
  pretty_name: "USTB - In-vivo Carotid (Verasonics L7-4)"
4
  license: cc-by-4.0
5
  task_categories:
 
19
 
20
  # USTB - In-vivo Carotid (Verasonics L7-4)
21
 
 
 
 
 
 
22
  ## Dataset Description
23
 
24
+ Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** (see the [collection card](../README.md)).
25
+
26
  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.
27
 
28
+ ## Dataset Contributor(s)
29
 
30
+ - Ole Marius Hoel Rindal <omrindal@ifi.uio.no> (primary contact)
31
+ - Yucel Karabiyik
32
+ - Sven Peter Nasholm
33
+ - Andreas Austeng
34
+ - University of Oslo (UiO), Department of Informatics
35
 
36
  ## Dataset Creation Date
37
 
 
39
 
40
  ## License / Terms of Use
41
 
42
+ [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode.en). Retain attribution and identify modifications when reusing the data.
 
 
43
 
44
  ## Intended Usage
45
 
 
49
 
50
  - **Data Collection Method:** clinical
51
  - **Labeling Method:** N/A (raw channel data; no annotations).
52
+ - **Acquisition system:** probe(s) L7-4; element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
53
+
54
+ ## Processing the Dataset
55
+
56
+ The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/oslo/reconstruct.py) at the root of this collection, as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), together with the `pipeline*.yaml` definitions at the collection root and the [zea library](https://github.com/tue-bmd/zea). The script streams the data from the Hugging Face Hub; `parameters.yaml` picks the pipeline, display window and dynamic range per acquisition (see the [collection card](../README.md#processing-the-dataset)).
57
 
58
  ## Dataset Format
59
 
60
+ [zea v0.1.6](https://github.com/tue-bmd/zea)
61
+
62
+ All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single acquisition with raw channel data `/data/raw_data` of shape `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1). No demodulation or decimation was applied during packaging beyond conversion from the USTB Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
 
 
 
63
 
64
  ## Dataset Quantification
65
 
 
101
 
102
  ## Data Validation
103
 
104
+ A Delay-And-Sum `zea.Pipeline` (`cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`; RF is demodulated in-pipeline, IQ uses a baseband pipeline) reconstructs every acquisition as a portable check that the recorded geometry and timing are correct (see *Processing the Dataset*).
105
+
106
+ The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry. These are the recommended reference reconstructions for visual verification.
 
 
 
 
 
 
 
 
 
 
 
107
 
108
  ## Known Issues
109
 
 
112
  ## Ethical Considerations
113
 
114
  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.
115
+
116
+ ## Citation
117
+
118
+ Please cite the UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo (Zenodo record 20261898).
oslo/C_verasonics_phantom/README.md CHANGED
@@ -1,4 +1,5 @@
1
  ---
 
2
  pretty_name: "USTB - Phantom (Verasonics L7-4 / P4)"
3
  license: cc-by-4.0
4
  task_categories:
@@ -17,18 +18,19 @@ size_categories:
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
 
@@ -36,9 +38,7 @@ University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius
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
 
@@ -48,18 +48,17 @@ Generalized reconstruction, image-quality assessment (resolution, contrast, dyna
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
 
@@ -113,20 +112,9 @@ No human or animal subjects. Targets: CIRS tissue-mimicking phantoms and lab pha
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
 
@@ -135,3 +123,7 @@ Mixed transmit schemes across files (CPWC / FI / STA / DW). Single-frame acquisi
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
+ name: oslo-c-verasonics-phantom
3
  pretty_name: "USTB - Phantom (Verasonics L7-4 / P4)"
4
  license: cc-by-4.0
5
  task_categories:
 
18
 
19
  # USTB - Phantom (Verasonics L7-4 / P4)
20
 
 
 
 
 
 
21
  ## Dataset Description
22
 
23
+ Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** (see the [collection card](../README.md)).
24
+
25
  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.
26
 
27
+ ## Dataset Contributor(s)
28
 
29
+ - Ole Marius Hoel Rindal <omrindal@ifi.uio.no> (primary contact)
30
+ - Yucel Karabiyik
31
+ - Sven Peter Nasholm
32
+ - Andreas Austeng
33
+ - University of Oslo (UiO), Department of Informatics
34
 
35
  ## Dataset Creation Date
36
 
 
38
 
39
  ## License / Terms of Use
40
 
41
+ [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode.en). Retain attribution and identify modifications when reusing the data.
 
 
42
 
43
  ## Intended Usage
44
 
 
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; element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
52
+
53
+ ## Processing the Dataset
54
+
55
+ The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/oslo/reconstruct.py) at the root of this collection, as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), together with the `pipeline*.yaml` definitions at the collection root and the [zea library](https://github.com/tue-bmd/zea). The script streams the data from the Hugging Face Hub; `parameters.yaml` picks the pipeline, display window and dynamic range per acquisition (see the [collection card](../README.md#processing-the-dataset)).
56
 
57
  ## Dataset Format
58
 
59
+ [zea v0.1.6](https://github.com/tue-bmd/zea)
60
+
61
+ All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single acquisition with raw channel data `/data/raw_data` of shape `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1). No demodulation or decimation was applied during packaging beyond conversion from the USTB Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
 
 
 
62
 
63
  ## Dataset Quantification
64
 
 
112
 
113
  ## Data Validation
114
 
115
+ A Delay-And-Sum `zea.Pipeline` (`cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`; RF is demodulated in-pipeline, IQ uses a baseband pipeline) reconstructs every acquisition as a portable check that the recorded geometry and timing are correct (see *Processing the Dataset*).
116
+
117
+ The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry. These are the recommended reference reconstructions for visual verification.
 
 
 
 
 
 
 
 
 
 
 
118
 
119
  ## Known Issues
120
 
 
123
  ## Ethical Considerations
124
 
125
  Phantom / table-top acquisitions; no human or animal subjects are involved. No ethical considerations beyond standard laboratory practice.
126
+
127
+ ## Citation
128
+
129
+ Please cite the UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo (Zenodo record 20261898).
oslo/D_alpinion_phantom/README.md CHANGED
@@ -1,4 +1,5 @@
1
  ---
 
2
  pretty_name: "USTB - Phantom (Alpinion L3-8)"
3
  license: cc-by-4.0
4
  task_categories:
@@ -17,18 +18,19 @@ size_categories:
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
 
@@ -36,9 +38,7 @@ University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius
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
 
@@ -48,18 +48,17 @@ Generalized reconstruction and image-quality assessment on a second hardware pla
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
 
@@ -102,20 +101,9 @@ No human or animal subjects. Targets: hypoechoic/hyperechoic phantom inclusions.
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
 
@@ -124,3 +112,7 @@ Single-frame acquisitions; two transmit schemes (FI, CPWC).
124
  ## Ethical Considerations
125
 
126
  Phantom acquisitions; no human or animal subjects. No ethical considerations beyond standard laboratory practice.
 
 
 
 
 
1
  ---
2
+ name: oslo-d-alpinion-phantom
3
  pretty_name: "USTB - Phantom (Alpinion L3-8)"
4
  license: cc-by-4.0
5
  task_categories:
 
18
 
19
  # USTB - Phantom (Alpinion L3-8)
20
 
 
 
 
 
 
21
  ## Dataset Description
22
 
23
+ Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** (see the [collection card](../README.md)).
24
+
25
  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.
26
 
27
+ ## Dataset Contributor(s)
28
 
29
+ - Ole Marius Hoel Rindal <omrindal@ifi.uio.no> (primary contact)
30
+ - Yucel Karabiyik
31
+ - Sven Peter Nasholm
32
+ - Andreas Austeng
33
+ - University of Oslo (UiO), Department of Informatics
34
 
35
  ## Dataset Creation Date
36
 
 
38
 
39
  ## License / Terms of Use
40
 
41
+ [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode.en). Retain attribution and identify modifications when reusing the data.
 
 
42
 
43
  ## Intended Usage
44
 
 
48
 
49
  - **Data Collection Method:** phantom
50
  - **Labeling Method:** Derived (known phantom target types).
51
+ - **Acquisition system:** probe(s) L3-8; element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
52
+
53
+ ## Processing the Dataset
54
+
55
+ The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/oslo/reconstruct.py) at the root of this collection, as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), together with the `pipeline*.yaml` definitions at the collection root and the [zea library](https://github.com/tue-bmd/zea). The script streams the data from the Hugging Face Hub; `parameters.yaml` picks the pipeline, display window and dynamic range per acquisition (see the [collection card](../README.md#processing-the-dataset)).
56
 
57
  ## Dataset Format
58
 
59
+ [zea v0.1.6](https://github.com/tue-bmd/zea)
60
+
61
+ All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single acquisition with raw channel data `/data/raw_data` of shape `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1). No demodulation or decimation was applied during packaging beyond conversion from the USTB Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
 
 
 
62
 
63
  ## Dataset Quantification
64
 
 
101
 
102
  ## Data Validation
103
 
104
+ A Delay-And-Sum `zea.Pipeline` (`cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`; RF is demodulated in-pipeline, IQ uses a baseband pipeline) reconstructs every acquisition as a portable check that the recorded geometry and timing are correct (see *Processing the Dataset*).
105
+
106
+ The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry. These are the recommended reference reconstructions for visual verification.
 
 
 
 
 
 
 
 
 
 
 
107
 
108
  ## Known Issues
109
 
 
112
  ## Ethical Considerations
113
 
114
  Phantom acquisitions; no human or animal subjects. No ethical considerations beyond standard laboratory practice.
115
+
116
+ ## Citation
117
+
118
+ Please cite the UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo (Zenodo record 20261898).
oslo/E_simulation/README.md CHANGED
@@ -1,4 +1,5 @@
1
  ---
 
2
  pretty_name: "USTB - Simulation (Field II)"
3
  license: cc-by-4.0
4
  task_categories:
@@ -18,18 +19,19 @@ size_categories:
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
 
@@ -37,9 +39,7 @@ University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius
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
 
@@ -49,18 +49,17 @@ Generalized reconstruction, beamformer development and validation with known gro
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
 
@@ -110,20 +109,9 @@ No human or animal subjects. Synthetic media simulated with Field II. Virtual pr
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
 
@@ -132,3 +120,7 @@ PICMUS calibration: 'PICMUS_numerical_calib_v2' was created in collaboration wit
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
+ name: oslo-e-simulation
3
  pretty_name: "USTB - Simulation (Field II)"
4
  license: cc-by-4.0
5
  task_categories:
 
19
 
20
  # USTB - Simulation (Field II)
21
 
 
 
 
 
 
22
  ## Dataset Description
23
 
24
+ Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** (see the [collection card](../README.md)).
25
+
26
  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).
27
 
28
+ ## Dataset Contributor(s)
29
 
30
+ - Ole Marius Hoel Rindal <omrindal@ifi.uio.no> (primary contact)
31
+ - Yucel Karabiyik
32
+ - Sven Peter Nasholm
33
+ - Andreas Austeng
34
+ - University of Oslo (UiO), Department of Informatics
35
 
36
  ## Dataset Creation Date
37
 
 
39
 
40
  ## License / Terms of Use
41
 
42
+ [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode.en). Retain attribution and identify modifications when reusing the data.
 
 
43
 
44
  ## Intended Usage
45
 
 
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; element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
53
+
54
+ ## Processing the Dataset
55
+
56
+ The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/oslo/reconstruct.py) at the root of this collection, as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), together with the `pipeline*.yaml` definitions at the collection root and the [zea library](https://github.com/tue-bmd/zea). The script streams the data from the Hugging Face Hub; `parameters.yaml` picks the pipeline, display window and dynamic range per acquisition (see the [collection card](../README.md#processing-the-dataset)).
57
 
58
  ## Dataset Format
59
 
60
+ [zea v0.1.6](https://github.com/tue-bmd/zea)
61
+
62
+ All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single acquisition with raw channel data `/data/raw_data` of shape `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF/IQ (n_ch in [1, 2]). No demodulation or decimation was applied during packaging beyond conversion from the USTB Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
 
 
 
63
 
64
  ## Dataset Quantification
65
 
 
109
 
110
  ## Data Validation
111
 
112
+ A Delay-And-Sum `zea.Pipeline` (`cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`; RF is demodulated in-pipeline, IQ uses a baseband pipeline) reconstructs every acquisition as a portable check that the recorded geometry and timing are correct (see *Processing the Dataset*).
113
+
114
+ The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html), with scanline transmit apodization for focused/sector acquisitions and correct sector-scan geometry. These are the recommended reference reconstructions for visual verification.
 
 
 
 
 
 
 
 
 
 
 
115
 
116
  ## Known Issues
117
 
 
120
  ## Ethical Considerations
121
 
122
  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.
123
+
124
+ ## Citation
125
+
126
+ Please cite the UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo (Zenodo record 20261898).
oslo/F_motion/README.md CHANGED
@@ -1,4 +1,5 @@
1
  ---
 
2
  pretty_name: "USTB - Motion Estimation (SWE / ARFI, Verasonics L7-4)"
3
  license: cc-by-4.0
4
  task_categories:
@@ -18,18 +19,19 @@ size_categories:
18
 
19
  # USTB - Motion Estimation (SWE / ARFI, 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
  Shear-wave elastography (SWE) and acoustic-radiation-force-impulse (ARFI) push-tracking phantom acquisitions on a Verasonics Vantage 256 with an L7-4 linear array. Each acquisition contains many high-frame-rate tracking frames following an acoustic push, suitable for tissue-motion and shear-wave-velocity estimation.
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
 
@@ -37,9 +39,7 @@ University of Oslo (UiO), Department of Informatics. Primary contact: Ole Marius
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
 
@@ -49,18 +49,17 @@ Motion estimation (RFP task 6.4): shear-wave velocity estimation, ARFI displacem
49
 
50
  - **Data Collection Method:** phantom
51
  - **Labeling Method:** Derived (elastography phantom of known/typical stiffness classes).
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
 
@@ -103,20 +102,9 @@ No human or animal subjects. Elastography phantoms. Scanner: Verasonics Vantage
103
 
104
  ## Data Validation
105
 
106
- A Delay-And-Sum `zea.Pipeline` is provided in the **`pipeline.yaml` at the submission root** and
107
- run by the single **`reconstruct.py` at the submission root**:
108
- `cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`
109
- (RF is demodulated in-pipeline; IQ uses a baseband pipeline). The script is geometry-driven and
110
- recurses into every sub-dataset folder; running `python reconstruct.py` from the root reconstructs
111
- every `.hdf5` in the collection (or pass a folder-qualified path for a single acquisition) and writes
112
- `<name>_zea_bmode.png` next to each file as a portable check that the recorded geometry and timing
113
- are correct. These plane-wave tracking acquisitions use the non-focused `compound` pipeline, and the
114
- reference reconstruction shows a single tracking frame.
115
-
116
- The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the
117
- UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction
118
- used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html). These are
119
- the recommended reference reconstructions for visual verification.
120
 
121
  ## Known Issues
122
 
@@ -125,3 +113,7 @@ Push-track sequences contain many frames at a high frame rate; the B-mode refere
125
  ## Ethical Considerations
126
 
127
  Phantom acquisitions; no human or animal subjects. No ethical considerations beyond standard laboratory practice.
 
 
 
 
 
1
  ---
2
+ name: oslo-f-motion
3
  pretty_name: "USTB - Motion Estimation (SWE / ARFI, Verasonics L7-4)"
4
  license: cc-by-4.0
5
  task_categories:
 
19
 
20
  # USTB - Motion Estimation (SWE / ARFI, Verasonics L7-4)
21
 
 
 
 
 
 
22
  ## Dataset Description
23
 
24
+ Part of the **UltraSound ToolBox (USTB) Channel Capture Collection** (see the [collection card](../README.md)).
25
+
26
  Shear-wave elastography (SWE) and acoustic-radiation-force-impulse (ARFI) push-tracking phantom acquisitions on a Verasonics Vantage 256 with an L7-4 linear array. Each acquisition contains many high-frame-rate tracking frames following an acoustic push, suitable for tissue-motion and shear-wave-velocity estimation.
27
 
28
+ ## Dataset Contributor(s)
29
 
30
+ - Ole Marius Hoel Rindal <omrindal@ifi.uio.no> (primary contact)
31
+ - Yucel Karabiyik
32
+ - Sven Peter Nasholm
33
+ - Andreas Austeng
34
+ - University of Oslo (UiO), Department of Informatics
35
 
36
  ## Dataset Creation Date
37
 
 
39
 
40
  ## License / Terms of Use
41
 
42
+ [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode.en). Retain attribution and identify modifications when reusing the data.
 
 
43
 
44
  ## Intended Usage
45
 
 
49
 
50
  - **Data Collection Method:** phantom
51
  - **Labeling Method:** Derived (elastography phantom of known/typical stiffness classes).
52
+ - **Acquisition system:** probe(s) L7-4; element positions stored in `/probe/probe_geometry` (meters); center frequency, sampling frequency and sound speed stored per acquisition in `/scan` (see per-sample feature table).
53
+
54
+ ## Processing the Dataset
55
+
56
+ The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/oslo/reconstruct.py) at the root of this collection, as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), together with the `pipeline*.yaml` definitions at the collection root and the [zea library](https://github.com/tue-bmd/zea). The script streams the data from the Hugging Face Hub; `parameters.yaml` picks the pipeline, display window and dynamic range per acquisition (see the [collection card](../README.md#processing-the-dataset)). These plane-wave tracking acquisitions use the non-focused `compound` pipeline, and the reference reconstruction shows a single tracking frame.
57
 
58
  ## Dataset Format
59
 
60
+ [zea v0.1.6](https://github.com/tue-bmd/zea)
61
+
62
+ All acquisitions are stored in the **zea** HDF5 file format. Each `.hdf5` file is a single acquisition with raw channel data `/data/raw_data` of shape `(n_frames, n_tx, n_ax, n_el, n_ch)` and a fully populated `/scan` group describing the transmit sequence (delays, focus distances, steering angles, apodization, timing). Data type: RF (n_ch=1). No demodulation or decimation was applied during packaging beyond conversion from the USTB Ultrasound File Format (UFF) to zea; RF data is demodulated inside the reconstruction pipeline.
 
 
 
63
 
64
  ## Dataset Quantification
65
 
 
102
 
103
  ## Data Validation
104
 
105
+ A Delay-And-Sum `zea.Pipeline` (`cast -> demodulate -> delay-and-sum beamform -> envelope detect -> normalize -> log compress`; RF is demodulated in-pipeline, IQ uses a baseband pipeline) reconstructs every acquisition as a portable check that the recorded geometry and timing are correct (see *Processing the Dataset*).
106
+
107
+ The reference B-mode images committed alongside the data (`<name>_bmode.png`) are produced with the UltraSound ToolBox (USTB) MATLAB Delay-And-Sum beamformer — the exact per-dataset reconstruction used in the public USTB dataset catalog (https://unioslo.github.io/USTB/datasets.html). These are the recommended reference reconstructions for visual verification.
 
 
 
 
 
 
 
 
 
 
 
108
 
109
  ## Known Issues
110
 
 
113
  ## Ethical Considerations
114
 
115
  Phantom acquisitions; no human or animal subjects. No ethical considerations beyond standard laboratory practice.
116
+
117
+ ## Citation
118
+
119
+ Please cite the UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo (Zenodo record 20261898).
oslo/README.md CHANGED
@@ -1,5 +1,6 @@
1
  ---
2
- pretty_name: "OpenH-RF — UltraSound ToolBox (USTB) Channel Capture Collection"
 
3
  license: cc-by-4.0
4
  task_categories:
5
  - image-to-image
@@ -15,25 +16,17 @@ size_categories:
15
  - n<1K
16
  ---
17
 
18
- # UltraSound ToolBox (USTB) Channel Capture Collection — OpenH-RF Submission
19
 
20
- Contributed by the **University of Oslo (UiO), Department of Informatics** (the USTB team)
21
- to the [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All data is pre-beamformed
22
- (raw channel-capture) ultrasound stored in the **zea** HDF5 format (`zea_version 0.1.6`,
23
- meeting the OpenH-RF minimum format version `0.1.4`) and released under **CC BY 4.0**.
24
 
25
- ## OpenH-RF Release Inventory
26
 
27
- **Current OpenH-RF release:** 39 HDF5 files; 8.61 GB (8,613,593,088 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.
28
 
29
- ## Contents
30
 
31
- 39 acquisitions packaged into six application sub-datasets. Each sub-dataset folder contains its
32
- zea `.hdf5` files, a Hugging Face–style `README.md` data card, and one reference B-mode PNG per
33
- acquisition. The **`reconstruct.py`, `pipeline.yaml`, and the CC BY 4.0 `LICENCE` live once at the
34
- submission root** — the reconstruction reconstructs every sub-dataset (the pipeline is identical
35
- across folders), and the single LICENCE covers the whole collection (each data card also declares
36
- `license: cc-by-4.0` in its YAML frontmatter).
37
 
38
  | Folder | Sub-dataset | Tier | RFP task | Acq. |
39
  |---|---|---|---|---|
@@ -46,23 +39,37 @@ across folders), and the single LICENCE covers the whole collection (each data c
46
 
47
  Total: **39 acquisitions**, 8.61 GB of stored HDF5 data.
48
 
49
- ## How to reconstruct
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
50
 
51
- Every acquisition is reconstructable from the file alone — all acquisition parameters live in the
52
- zea `/scan` and `/probe` groups. A single `reconstruct.py` at the submission root reconstructs
53
- every acquisition in every sub-dataset folder:
54
 
55
- ```bash
56
- export KERAS_BACKEND=jax
57
- python reconstruct.py # standard recon for every .hdf5
58
- python reconstruct.py --refocus # also emit REFoCUS where enabled
59
- python reconstruct.py A_cardiac/<file>.hdf5 # a single acquisition
60
- ```
61
 
62
- All reconstruction choices live in **`parameters.yaml`** — one entry per acquisition giving its
63
- `pipeline` (which `zea.Pipeline` to use), display window (`zlims`/`xlims` in mm) and `dynamic_range`.
64
- Every acquisition uses the same workflow (load parameters → run the pipeline → plot); there is no
65
- per-file logic in the script. Each `pipeline` value maps to a `zea.Pipeline` YAML at the root:
 
 
 
66
 
67
  | `pipeline` | Used for | `zea.Pipeline` |
68
  |---|---|---|
@@ -71,44 +78,18 @@ per-file logic in the script. Each `pipeline` value maps to a `zea.Pipeline` YAM
71
  | `iq` | baseband IQ (`n_ch == 2`, e.g. PICMUS) | `pipeline_iq.yaml` (no demodulation step). |
72
  | `compound` | non-focused linear (plane-wave / diverging / STA / SWE-ARFI) | `pipeline.yaml`: coherent compounding, no pfield (these insonify the whole field of view). |
73
 
74
- The pipelines share the same shape as zea's regular B-mode pipeline (`cast → apply_window →
75
- demodulate → beamform → envelope → normalize → log_compress`). Scanline imaging
76
- uses the same `beamform` op with a scanline grid plus receive apodization rather than a dedicated
77
- scanline-specific operation. Two zea features used in this submission are scanline receive
78
- apodization (`enable_receive_apodization`) and `focal_region_length` (focal-region delay blending,
79
- Rindal et al., IUS 2018).
80
-
81
- An acquisition may also set `refocus: true` in `parameters.yaml`. When `reconstruct.py` is run
82
- with the `--refocus` flag (off by default), it additionally runs a REFoCUS reconstruction for
83
- those acquisitions — transmit-encoding recovery (Bottenus, 2018) that
84
- inverts the transmit-encoding matrix to recover the multistatic (full-matrix-capture) dataset
85
- before pressure-field-weighted DAS — and writes a `<name>_zea_refocus_bmode.png` alongside the
86
- standard reconstruction. REFoCUS is enabled for **every acquisition with enough encoded transmits
87
- for the inversion to be well posed (≥ 8 transmit events)** — coherent plane-wave compounding
88
- (CPWC), diverging waves (DW), and focused linear (FI) and phased-array sector scans. Phased-array
89
- `sector` acquisitions use `pipeline_refocus_sector.yaml` (polar grid + scan conversion, preserving
90
- the sector geometry); every other geometry uses the linear/cartesian `pipeline_refocus.yaml`.
91
- REFoCUS is **not** enabled where the inversion is ill-posed or undefined: single/few-transmit
92
- acquisitions (the `n_tx = 1` plane-wave tracking sets and single-angle simulations, PICMUS's
93
- 5-angle IQ) and synthetic transmit aperture (STA) acquisitions, which are already multistatic.
94
 
95
  ## Reference images
96
 
97
  Each acquisition ships with:
98
  - `<name>_zea_bmode.png` — produced by the root `reconstruct.py` (zea); the reproducible reference.
99
  - `<name>_zea_bmode_old.png` — the initial v2 zea reconstruction (kept for comparison).
100
- - `<name>_bmode.png` — the canonical USTB MATLAB Delay-And-Sum reconstruction from the public
101
- [USTB dataset catalog](https://unioslo.github.io/USTB/datasets.html), for cross-validation.
102
- - `<name>_zea_refocus_bmode.png` — REFoCUS variant, for acquisitions with `refocus: true`
103
- (CPWC / DW / focused FI / sector with ≥ 8 transmits; not STA or single/few-transmit sets).
104
-
105
- ## Licensing & attribution
106
-
107
- Released under **CC BY 4.0**. Please cite the UltraSound ToolBox (USTB), University of Oslo
108
- (Zenodo record 20261898). `PICMUS_numerical_calib_v2` (group E) was created **in collaboration
109
- with our group** as part of the PICMUS effort and is included on that basis; the other PICMUS
110
- datasets are excluded.
111
 
112
- ## Contact
113
 
114
- Ole Marius Hoel Rindal — omrindal@ifi.uio.no (UiO, USTB).
 
1
  ---
2
+ name: oslo
3
+ pretty_name: "UltraSound ToolBox (USTB) Channel Capture Collection"
4
  license: cc-by-4.0
5
  task_categories:
6
  - image-to-image
 
16
  - n<1K
17
  ---
18
 
19
+ # UltraSound ToolBox (USTB) Channel Capture Collection
20
 
21
+ ![Focused sector B-mode of an apical four-chamber view](assets/Verasonics_P2-4_apical_four_chamber_subject_1_zea_bmode.png)
 
 
 
22
 
23
+ *Apical four-chamber view reconstructed from the raw channel data, [`A_cardiac/Verasonics_P2-4_apical_four_chamber_subject_1.hdf5`](https://huggingface.co/datasets/nvidia/OpenH-RF/blob/main/oslo/A_cardiac/Verasonics_P2-4_apical_four_chamber_subject_1.hdf5).*
24
 
25
+ ## Dataset Description
26
 
27
+ Contributed by the **University of Oslo (UiO), Department of Informatics** (the USTB team) to the [OpenH-RF](https://github.com/open-h/OpenH-RF) initiative. All data is pre-beamformed (raw channel-capture) ultrasound stored in the **zea** HDF5 format and released under **CC BY 4.0**.
28
 
29
+ 39 acquisitions packaged into six application sub-datasets. Each sub-dataset folder contains its zea `.hdf5` files, a Hugging Face–style `README.md` data card, and one reference B-mode PNG per acquisition. The **`reconstruct.py`, `pipeline.yaml`, and the CC BY 4.0 `LICENCE` live once at the submission root** — the reconstruction reconstructs every sub-dataset (the pipeline is identical across folders), and the single LICENCE covers the whole collection (each data card also declares `license: cc-by-4.0` in its YAML frontmatter).
 
 
 
 
 
30
 
31
  | Folder | Sub-dataset | Tier | RFP task | Acq. |
32
  |---|---|---|---|---|
 
39
 
40
  Total: **39 acquisitions**, 8.61 GB of stored HDF5 data.
41
 
42
+ ## Dataset Contributor(s)
43
+
44
+ - Ole Marius Hoel Rindal <omrindal@ifi.uio.no> (primary contact)
45
+ - Yucel Karabiyik
46
+ - Sven Peter Nasholm
47
+ - Andreas Austeng
48
+ - University of Oslo (UiO), Department of Informatics
49
+
50
+ ## Dataset Creation Date
51
+
52
+ 06/23/2026 (packaging date; original acquisitions/simulations were produced between 2016 and 2023).
53
+
54
+ ## License / Terms of Use
55
+
56
+ [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode.en). Retain attribution and identify modifications when reusing the data.
57
+
58
+ ## Processing the Dataset
59
+
60
+ Every acquisition is reconstructable from the file alone — all acquisition parameters live in the zea `/scan` and `/probe` groups. The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/oslo/reconstruct.py), as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), together with the `pipeline*.yaml` and `parameters.yaml` definitions in this folder and the [zea library](https://github.com/tue-bmd/zea). The script streams the data from the Hugging Face Hub: set `PATHS` to the acquisition to reconstruct (default: the apical four-chamber cardiac scan above) and `REFOCUS = True` to also emit the REFoCUS variant. See [Reconstruction Details](#reconstruction-details) for how each acquisition's pipeline is chosen.
61
 
62
+ ## Dataset Format
 
 
63
 
64
+ [zea v0.1.6](https://github.com/tue-bmd/zea)
 
 
 
 
 
65
 
66
+ ## Dataset Quantification
67
+
68
+ **Current OpenH-RF release:** 39 HDF5 files; 8.61 GB (8,613,593,088 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.
69
+
70
+ ## Reconstruction Details
71
+
72
+ All reconstruction choices live in **`parameters.yaml`** — one entry per acquisition giving its `pipeline` (which `zea.Pipeline` to use), display window (`zlims`/`xlims` in mm) and `dynamic_range`. Every acquisition uses the same workflow (load parameters → run the pipeline → plot); there is no per-file logic in the script. Each `pipeline` value maps to a `zea.Pipeline` YAML at the root:
73
 
74
  | `pipeline` | Used for | `zea.Pipeline` |
75
  |---|---|---|
 
78
  | `iq` | baseband IQ (`n_ch == 2`, e.g. PICMUS) | `pipeline_iq.yaml` (no demodulation step). |
79
  | `compound` | non-focused linear (plane-wave / diverging / STA / SWE-ARFI) | `pipeline.yaml`: coherent compounding, no pfield (these insonify the whole field of view). |
80
 
81
+ The pipelines share the same shape as zea's regular B-mode pipeline (`cast → apply_window → demodulate → beamform → envelope → normalize → log_compress`). Scanline imaging uses the same `beamform` op with a scanline grid plus receive apodization rather than a dedicated scanline-specific operation. Two zea features used in this submission are scanline receive apodization (`enable_receive_apodization`) and `focal_region_length` (focal-region delay blending, Rindal et al., IUS 2018).
82
+
83
+ An acquisition may also set `refocus: true` in `parameters.yaml`. With `REFOCUS = True` (off by default), `reconstruct.py` additionally runs a REFoCUS reconstruction for those acquisitions — transmit-encoding recovery (Bottenus, 2018) that inverts the transmit-encoding matrix to recover the multistatic (full-matrix-capture) dataset before pressure-field-weighted DAS — and writes a `<name>_zea_refocus_bmode.png` alongside the standard reconstruction. REFoCUS is enabled for **every acquisition with enough encoded transmits for the inversion to be well posed (≥ 8 transmit events)** — coherent plane-wave compounding (CPWC), diverging waves (DW), and focused linear (FI) and phased-array sector scans. Phased-array `sector` acquisitions use `pipeline_refocus_sector.yaml` (polar grid + scan conversion, preserving the sector geometry); every other geometry uses the linear/cartesian `pipeline_refocus.yaml`. REFoCUS is **not** enabled where the inversion is ill-posed or undefined: single/few-transmit acquisitions (the `n_tx = 1` plane-wave tracking sets and single-angle simulations, PICMUS's 5-angle IQ) and synthetic transmit aperture (STA) acquisitions, which are already multistatic.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
84
 
85
  ## Reference images
86
 
87
  Each acquisition ships with:
88
  - `<name>_zea_bmode.png` — produced by the root `reconstruct.py` (zea); the reproducible reference.
89
  - `<name>_zea_bmode_old.png` — the initial v2 zea reconstruction (kept for comparison).
90
+ - `<name>_bmode.png` — the canonical USTB MATLAB Delay-And-Sum reconstruction from the public [USTB dataset catalog](https://unioslo.github.io/USTB/datasets.html), for cross-validation.
91
+ - `<name>_zea_refocus_bmode.png` — REFoCUS variant, for acquisitions with `refocus: true` (CPWC / DW / focused FI / sector with ≥ 8 transmits; not STA or single/few-transmit sets).
 
 
 
 
 
 
 
 
 
92
 
93
+ ## Citation
94
 
95
+ Please cite the UltraSound ToolBox (USTB) Channel Capture Collection, University of Oslo (Zenodo record 20261898). `PICMUS_numerical_calib_v2` (group E) was created **in collaboration with our group** as part of the PICMUS effort and is included on that basis; the other PICMUS datasets are excluded.