nv-raw2insights-us: restructure the data card to the common layout
#53
by tristan-deep - opened
- nv-raw2insights-us/README.md +28 -56
nv-raw2insights-us/README.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
| 1 |
---
|
| 2 |
-
|
|
|
|
| 3 |
license: cc-by-4.0
|
| 4 |
task_categories:
|
| 5 |
- other
|
|
@@ -23,32 +24,21 @@ size_categories:
|
|
| 23 |
|
| 24 |

|
| 25 |
|
| 26 |
-
*DBUA results using synthetic validation sample
|
| 27 |
|
| 28 |
<!-- assets/main.png is the unlabelled final B-mode panel from this run, for the dataset collage. -->
|
| 29 |
|
| 30 |
## Dataset Description
|
| 31 |
|
| 32 |
-
NV-Raw2Insights-US is a **simulated full-synthetic-aperture (FSA)** ultrasound
|
| 33 |
-
dataset for training and evaluating neural networks on **sound-speed
|
| 34 |
-
estimation**, **phase-aberration correction**, **tissue segmentation**, and
|
| 35 |
-
**learned image reconstruction** from raw pre-beamformed channel data.
|
| 36 |
|
| 37 |
-
Each sample is a single-frame FSA acquisition from a **180-element linear
|
| 38 |
-
array** simulated with **k-Wave** over a heterogeneous tissue phantom
|
| 39 |
-
containing cysts. Every acquisition provides raw baseband **IQ channel data**
|
| 40 |
-
alongside co-registered ground truth: a **speed-of-sound map**, a **binary cyst
|
| 41 |
-
segmentation mask**, a **DAS B-mode** and a **focused-transmit B-mode**, and a
|
| 42 |
-
per-sample **phase-aberration** value. All data are **synthetic**; no human or
|
| 43 |
-
animal subjects are involved.
|
| 44 |
|
| 45 |
-
This is the **zea-format (OpenH-RF) release**; the same simulations are also
|
| 46 |
-
published in a Hugging Face `datasets`/Arrow build at
|
| 47 |
-
[`nvidia/NV-Raw2Insights-US`](https://huggingface.co/datasets/nvidia/NV-Raw2Insights-US).
|
| 48 |
|
| 49 |
## Dataset Contributor(s)
|
| 50 |
|
| 51 |
-
NVIDIA Corporation
|
| 52 |
|
| 53 |
## Dataset Creation Date
|
| 54 |
|
|
@@ -56,33 +46,27 @@ NVIDIA Corporation.
|
|
| 56 |
|
| 57 |
## License / Terms of Use
|
| 58 |
|
| 59 |
-
[Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode.en).
|
| 60 |
-
Retain attribution and identify modifications when reusing the data.
|
| 61 |
|
| 62 |
## Intended Usage
|
| 63 |
|
| 64 |
-
Developing and benchmarking methods that operate on raw ultrasound channel data:
|
| 65 |
-
learned/adaptive beamforming, sound-speed estimation, phase-aberration
|
| 66 |
-
correction, and tissue segmentation. Because the sound-speed map, segmentation
|
| 67 |
-
mask, and aberration value are exact simulation ground truth, the dataset
|
| 68 |
-
supports fully-supervised training of channel-data-to-insight models.
|
| 69 |
|
| 70 |
## Dataset Characterization
|
| 71 |
|
| 72 |
-
- **Data Collection Method:** Synthetic — k-Wave acoustic simulation of a
|
| 73 |
-
|
| 74 |
-
- **
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
background sound speed 1540 m/s.
|
| 80 |
|
| 81 |
## Dataset Format
|
| 82 |
|
| 83 |
-
|
| 84 |
-
|
| 85 |
-
filename (`nv_r2i_us_train_XXXX.hdf5`, `nv_r2i_us_validation_XXXX.hdf5`).
|
| 86 |
|
| 87 |
Per-file contents:
|
| 88 |
|
|
@@ -105,45 +89,33 @@ Per-file contents:
|
|
| 105 |
|
| 106 |
**Current OpenH-RF release:** 923 HDF5 files; 214.13 GB (214,133,178,368 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.
|
| 107 |
|
| 108 |
-
- **923 samples (830 train / 93 validation)**, one HDF5 per sample, all in
|
| 109 |
-
`data/`; the split is carried in the filename.
|
| 110 |
- Each sample is a single-frame FSA acquisition (frame index always 0).
|
| 111 |
|
| 112 |
## Subject Metadata
|
| 113 |
|
| 114 |
-
- **Synthetic only** — no human or animal subjects. Each sample is a k-Wave
|
| 115 |
-
simulation over a digital tissue phantom containing cysts.
|
| 116 |
- No PHI; `subject/type` is a simulation label, not a patient identifier.
|
| 117 |
|
| 118 |
## Data Validation
|
| 119 |
|
| 120 |
-
Each file's `tracks/track_0/data/image` is a DAS B-mode reconstructed from
|
| 121 |
-
`raw_data` by the zea pipeline (see `pipeline.yaml`), so the reconstruction is
|
| 122 |
-
reproducible from the raw channel data and the recorded transmit description.
|
| 123 |
|
| 124 |
## Known Issues
|
| 125 |
|
| 126 |
-
- `sos_map` is a coarse `32 × 32` grid while the B-mode and segmentation are on
|
| 127 |
-
|
| 128 |
-
-
|
| 129 |
-
segmentation mask.
|
| 130 |
-
- Some regions of gross reverberation artifact can be incorrectly segmented as
|
| 131 |
-
cysts.
|
| 132 |
|
| 133 |
## Ethical Considerations
|
| 134 |
|
| 135 |
-
The data are entirely synthetic (k-Wave simulation of digital phantoms). There
|
| 136 |
-
are no human participants, animal subjects, patient identifiers, or protected
|
| 137 |
-
health information. Released under CC BY 4.0 for research and technical
|
| 138 |
-
evaluation, not clinical decision-making.
|
| 139 |
|
| 140 |
## Source Dataset & Citation
|
| 141 |
|
| 142 |
-
This is the **zea-format conversion** of the original **NV-Raw2Insights-US**
|
| 143 |
-
dataset published by NVIDIA on Hugging Face:
|
| 144 |
<https://huggingface.co/datasets/nvidia/NV-Raw2Insights-US>. The raw
|
| 145 |
-
simulations, ground-truth labels, and normalization statistics originate there;
|
| 146 |
-
please cite the original dataset:
|
| 147 |
|
| 148 |
```bibtex
|
| 149 |
@misc{nv_raw2insights_us_2026,
|
|
|
|
| 1 |
---
|
| 2 |
+
name: nv-raw2insights-us
|
| 3 |
+
pretty_name: "NV-Raw2Insights-US (simulated FSA, sound-speed / aberration / segmentation)"
|
| 4 |
license: cc-by-4.0
|
| 5 |
task_categories:
|
| 6 |
- other
|
|
|
|
| 24 |
|
| 25 |

|
| 26 |
|
| 27 |
+
*DBUA results using synthetic validation sample [`data/nv_r2i_us_validation_0084.hdf5`](https://huggingface.co/datasets/nvidia/OpenH-RF/blob/main/nv-raw2insights-us/data/nv_r2i_us_validation_0084.hdf5): B-mode (left) and estimated sound speed (right). Bulk-speed calibration is followed by 400 spatial-refinement iterations, with fixed display scales. These are DBUA reconstructions, not predictions from an NV-Raw2Insights-US model.*
|
| 28 |
|
| 29 |
<!-- assets/main.png is the unlabelled final B-mode panel from this run, for the dataset collage. -->
|
| 30 |
|
| 31 |
## Dataset Description
|
| 32 |
|
| 33 |
+
NV-Raw2Insights-US is a **simulated full-synthetic-aperture (FSA)** ultrasound dataset for training and evaluating neural networks on **sound-speed estimation**, **phase-aberration correction**, **tissue segmentation**, and **learned image reconstruction** from raw pre-beamformed channel data.
|
|
|
|
|
|
|
|
|
|
| 34 |
|
| 35 |
+
Each sample is a single-frame FSA acquisition from a **180-element linear array** simulated with **k-Wave** over a heterogeneous tissue phantom containing cysts. Every acquisition provides raw baseband **IQ channel data** alongside co-registered ground truth: a **speed-of-sound map**, a **binary cyst segmentation mask**, a **DAS B-mode** and a **focused-transmit B-mode**, and a per-sample **phase-aberration** value. All data are **synthetic**; no human or animal subjects are involved.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 36 |
|
| 37 |
+
This is the **zea-format (OpenH-RF) release**; the same simulations are also published in a Hugging Face `datasets`/Arrow build at [`nvidia/NV-Raw2Insights-US`](https://huggingface.co/datasets/nvidia/NV-Raw2Insights-US).
|
|
|
|
|
|
|
| 38 |
|
| 39 |
## Dataset Contributor(s)
|
| 40 |
|
| 41 |
+
- NVIDIA Corporation
|
| 42 |
|
| 43 |
## Dataset Creation Date
|
| 44 |
|
|
|
|
| 46 |
|
| 47 |
## License / Terms of Use
|
| 48 |
|
| 49 |
+
[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.
|
|
|
|
| 50 |
|
| 51 |
## Intended Usage
|
| 52 |
|
| 53 |
+
Developing and benchmarking methods that operate on raw ultrasound channel data: learned/adaptive beamforming, sound-speed estimation, phase-aberration correction, and tissue segmentation. Because the sound-speed map, segmentation mask, and aberration value are exact simulation ground truth, the dataset supports fully-supervised training of channel-data-to-insight models.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 54 |
|
| 55 |
## Dataset Characterization
|
| 56 |
|
| 57 |
+
- **Data Collection Method:** Synthetic — k-Wave acoustic simulation of a 180-element linear array over heterogeneous tissue phantoms with cysts.
|
| 58 |
+
- **Labeling Method:** Synthetic — ground truth taken directly from the simulation parameters (sound-speed map, cyst segmentation, aberration).
|
| 59 |
+
- **Acquisition model:** Full synthetic aperture (multi-static) — 180 single-element transmit events per frame, all 180 elements received; transmit centre frequency 6.5 MHz, baseband IQ sampled at 13.3 MHz, background sound speed 1540 m/s.
|
| 60 |
+
|
| 61 |
+
## Processing the Dataset
|
| 62 |
+
|
| 63 |
+
The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/nv-raw2insights-us/reconstruct.py) as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), which uses the [zea library](https://github.com/tue-bmd/zea) and streams the data from the Hugging Face Hub. It reconstructs both a plain DAS B-mode (the `pipeline.yaml` in this folder) and a sound-speed-corrected B-mode using the ground-truth `sos_map`.
|
|
|
|
| 64 |
|
| 65 |
## Dataset Format
|
| 66 |
|
| 67 |
+
[zea v0.1.6](https://github.com/tue-bmd/zea)
|
| 68 |
+
|
| 69 |
+
Packaged in the **zea** file format (`zea_version` 0.1.6), **one HDF5 file per sample**, all under `data/`. The train/validation split is encoded in each filename (`nv_r2i_us_train_XXXX.hdf5`, `nv_r2i_us_validation_XXXX.hdf5`).
|
| 70 |
|
| 71 |
Per-file contents:
|
| 72 |
|
|
|
|
| 89 |
|
| 90 |
**Current OpenH-RF release:** 923 HDF5 files; 214.13 GB (214,133,178,368 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.
|
| 91 |
|
| 92 |
+
- **923 samples (830 train / 93 validation)**, one HDF5 per sample, all in `data/`; the split is carried in the filename.
|
|
|
|
| 93 |
- Each sample is a single-frame FSA acquisition (frame index always 0).
|
| 94 |
|
| 95 |
## Subject Metadata
|
| 96 |
|
| 97 |
+
- **Synthetic only** — no human or animal subjects. Each sample is a k-Wave simulation over a digital tissue phantom containing cysts.
|
|
|
|
| 98 |
- No PHI; `subject/type` is a simulation label, not a patient identifier.
|
| 99 |
|
| 100 |
## Data Validation
|
| 101 |
|
| 102 |
+
Each file's `tracks/track_0/data/image` is a DAS B-mode reconstructed from `raw_data` by the zea pipeline (see `pipeline.yaml`), so the reconstruction is reproducible from the raw channel data and the recorded transmit description.
|
|
|
|
|
|
|
| 103 |
|
| 104 |
## Known Issues
|
| 105 |
|
| 106 |
+
- `sos_map` is a coarse `32 × 32` grid while the B-mode and segmentation are on the fine `507 × 456` grid; each carries its own `coordinates` for alignment.
|
| 107 |
+
- Cysts that touch the edge of the B-mode frame are not included in the segmentation mask.
|
| 108 |
+
- Some regions of gross reverberation artifact can be incorrectly segmented as cysts.
|
|
|
|
|
|
|
|
|
|
| 109 |
|
| 110 |
## Ethical Considerations
|
| 111 |
|
| 112 |
+
The data are entirely synthetic (k-Wave simulation of digital phantoms). There are no human participants, animal subjects, patient identifiers, or protected health information. Released under CC BY 4.0 for research and technical evaluation, not clinical decision-making.
|
|
|
|
|
|
|
|
|
|
| 113 |
|
| 114 |
## Source Dataset & Citation
|
| 115 |
|
| 116 |
+
This is the **zea-format conversion** of the original **NV-Raw2Insights-US** dataset published by NVIDIA on Hugging Face:
|
|
|
|
| 117 |
<https://huggingface.co/datasets/nvidia/NV-Raw2Insights-US>. The raw
|
| 118 |
+
simulations, ground-truth labels, and normalization statistics originate there; please cite the original dataset:
|
|
|
|
| 119 |
|
| 120 |
```bibtex
|
| 121 |
@misc{nv_raw2insights_us_2026,
|