us4us: restructure the data card to the common layout
Browse files- us4us/README.md +26 -25
us4us/README.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
| 1 |
---
|
| 2 |
-
|
|
|
|
| 3 |
license: cc-by-4.0
|
| 4 |
task_categories:
|
| 5 |
- other
|
|
@@ -23,10 +24,7 @@ size_categories:
|
|
| 23 |
|
| 24 |

|
| 25 |
|
| 26 |
-
A left-forearm cross-section, slice 8 of
|
| 27 |
-
[`data/s1_l.hdf5`](https://huggingface.co/datasets/nvidia/OpenH-RF/blob/main/us4us/data/s1_l.hdf5),
|
| 28 |
-
reconstructed by [`reconstruct.py`](https://github.com/open-h/OpenH-RF/blob/main/datasets/us4us/reconstruct.py)
|
| 29 |
-
beside the sinogram and reference image stored in the file.
|
| 30 |
|
| 31 |
## Dataset Description
|
| 32 |
Raw RF data acquired with the us4us Ltd. us4R system and a Draminski ring probe.
|
|
@@ -42,33 +40,33 @@ The forearm and phantom acquisitions comprise consecutive slices spaced 9 mm apa
|
|
| 42 |
|
| 43 |
Each slice was recorded using 1024 subsequent single-element transmissions, and received by a 512-element aperture located opposite the transmitting element.
|
| 44 |
|
|
|
|
| 45 |
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
|
|
|
| 51 |
|
| 52 |
## Dataset Creation Date
|
| 53 |
09/07/2026
|
| 54 |
|
|
|
|
| 55 |
|
| 56 |
-
|
| 57 |
-
CC BY 4.0
|
| 58 |
-
|
| 59 |
|
| 60 |
## Intended Usage
|
| 61 |
Ultrasound computed tomography image reconstruction.
|
| 62 |
|
| 63 |
-
|
| 64 |
## Dataset Characterization
|
| 65 |
* Data Collection Method: phantom, healthy adult human volunteers.
|
| 66 |
* Labeling Method: N/A.
|
| 67 |
-
* Acquisition system:
|
| 68 |
- ring probe:
|
| 69 |
- probe radius: 130mm,
|
| 70 |
-
- number of elements: 1024,
|
| 71 |
-
- center frequency: 2MHz,
|
| 72 |
- sampling rate: 8125000.0,
|
| 73 |
- us4R research system + host PC,
|
| 74 |
- custom positioning system for subject spatial control.
|
|
@@ -79,10 +77,17 @@ Ultrasound computed tomography image reconstruction.
|
|
| 79 |
- for each transmission, the center of the receiving aperture was positioned on the opposite side of the probe relative to the transmitting element,
|
| 80 |
- for example, for the 0th transmission, the 0th probe element transmitted, and the receiving aperture consisted of probe elements 256–767.
|
| 81 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 82 |
## Dataset Format
|
| 83 |
-
All sub-datasets are provided in the ZEA file format.
|
| 84 |
-
No preprocessing was performed on the raw channel data.
|
| 85 |
|
|
|
|
|
|
|
|
|
|
| 86 |
|
| 87 |
## Dataset Quantification
|
| 88 |
|
|
@@ -91,23 +96,19 @@ No preprocessing was performed on the raw channel data.
|
|
| 91 |
* Each forearm HDF5 file contains 10 slices of the subject; `yezitronix-b-rg-1.2.hdf5` contains 11 and `reference_water.hdf5` a single slice.
|
| 92 |
* Stored HDF5 file sizes vary: 1.89 GB to 1.95 GB excluding the water reference. `reference_water.hdf5` is 183,107,584 bytes (183.11 MB).
|
| 93 |
|
| 94 |
-
|
| 95 |
## Subject Metadata
|
| 96 |
The dataset contains data from:
|
| 97 |
* breast phantom Yezitronix B-RG-1.2,
|
| 98 |
* both forearms of 8 healthy human volunteers (2 females and 6 males, age range [20, 55]),
|
| 99 |
* water only (reference data).
|
| 100 |
|
| 101 |
-
|
| 102 |
## Data Validation
|
| 103 |
-
* The data files contain attenuation sinograms and images reconstructed from raw data using the filtered backprojection algorithm.
|
| 104 |
-
* [`reconstruct.py`](https://github.com/open-h/OpenH-RF/blob/main/datasets/us4us/reconstruct.py) rebuilds both from `data/raw_data` and plots them beside the stored versions. Set `ZEA_FILE` and `FRAME` at the top of the script and run `python reconstruct.py`.
|
| 105 |
|
|
|
|
|
|
|
| 106 |
|
| 107 |
## Known Issues
|
| 108 |
* The following probe elements should be considered damaged: [367, 409, 457, 764, 775, 776, 368, 390, 470, 739, 792].
|
| 109 |
|
| 110 |
-
|
| 111 |
## Ethical Considerations
|
| 112 |
* All human subjects were healthy adults who voluntarily participated in the measurements.
|
| 113 |
-
|
|
|
|
| 1 |
---
|
| 2 |
+
name: us4us
|
| 3 |
+
pretty_name: "us4us Ring-Array USCT (forearm, breast phantom, water)"
|
| 4 |
license: cc-by-4.0
|
| 5 |
task_categories:
|
| 6 |
- other
|
|
|
|
| 24 |
|
| 25 |

|
| 26 |
|
| 27 |
+
*A left-forearm cross-section, slice 8 of [`data/s1_l.hdf5`](https://huggingface.co/datasets/nvidia/OpenH-RF/blob/main/us4us/data/s1_l.hdf5), reconstructed beside the sinogram and reference image stored in the file.*
|
|
|
|
|
|
|
|
|
|
| 28 |
|
| 29 |
## Dataset Description
|
| 30 |
Raw RF data acquired with the us4us Ltd. us4R system and a Draminski ring probe.
|
|
|
|
| 40 |
|
| 41 |
Each slice was recorded using 1024 subsequent single-element transmissions, and received by a 512-element aperture located opposite the transmitting element.
|
| 42 |
|
| 43 |
+
## Dataset Contributor(s)
|
| 44 |
|
| 45 |
+
- Ziemowit Klimonda (PI)
|
| 46 |
+
- Piotr Jarosik
|
| 47 |
+
- Jakub Rozbicki
|
| 48 |
+
- Piotr Karwat
|
| 49 |
+
- Marcin Lewandowski
|
| 50 |
+
- us4us Ltd. (https://us4us.eu/)
|
| 51 |
|
| 52 |
## Dataset Creation Date
|
| 53 |
09/07/2026
|
| 54 |
|
| 55 |
+
## License / Terms of Use
|
| 56 |
|
| 57 |
+
[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.
|
|
|
|
|
|
|
| 58 |
|
| 59 |
## Intended Usage
|
| 60 |
Ultrasound computed tomography image reconstruction.
|
| 61 |
|
|
|
|
| 62 |
## Dataset Characterization
|
| 63 |
* Data Collection Method: phantom, healthy adult human volunteers.
|
| 64 |
* Labeling Method: N/A.
|
| 65 |
+
* Acquisition system:
|
| 66 |
- ring probe:
|
| 67 |
- probe radius: 130mm,
|
| 68 |
+
- number of elements: 1024,
|
| 69 |
+
- center frequency: 2MHz,
|
| 70 |
- sampling rate: 8125000.0,
|
| 71 |
- us4R research system + host PC,
|
| 72 |
- custom positioning system for subject spatial control.
|
|
|
|
| 77 |
- for each transmission, the center of the receiving aperture was positioned on the opposite side of the probe relative to the transmitting element,
|
| 78 |
- for example, for the 0th transmission, the 0th probe element transmitted, and the receiving aperture consisted of probe elements 256–767.
|
| 79 |
|
| 80 |
+
## Processing the Dataset
|
| 81 |
+
|
| 82 |
+
The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/us4us/reconstruct.py) as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF), together with the `pipeline.yaml` definition in this folder and the [zea library](https://github.com/tue-bmd/zea). The script streams the data from the Hugging Face Hub.
|
| 83 |
+
|
| 84 |
+
The script rebuilds the attenuation sinogram and filtered-backprojection image from `data/raw_data` and plots them beside the versions stored in the file. Set `ZEA_FILE` and `FRAME` (the slice) at the top of the script.
|
| 85 |
+
|
| 86 |
## Dataset Format
|
|
|
|
|
|
|
| 87 |
|
| 88 |
+
[zea v0.1.6](https://github.com/tue-bmd/zea)
|
| 89 |
+
|
| 90 |
+
All sub-datasets are provided in the ZEA file format. No preprocessing was performed on the raw channel data.
|
| 91 |
|
| 92 |
## Dataset Quantification
|
| 93 |
|
|
|
|
| 96 |
* Each forearm HDF5 file contains 10 slices of the subject; `yezitronix-b-rg-1.2.hdf5` contains 11 and `reference_water.hdf5` a single slice.
|
| 97 |
* Stored HDF5 file sizes vary: 1.89 GB to 1.95 GB excluding the water reference. `reference_water.hdf5` is 183,107,584 bytes (183.11 MB).
|
| 98 |
|
|
|
|
| 99 |
## Subject Metadata
|
| 100 |
The dataset contains data from:
|
| 101 |
* breast phantom Yezitronix B-RG-1.2,
|
| 102 |
* both forearms of 8 healthy human volunteers (2 females and 6 males, age range [20, 55]),
|
| 103 |
* water only (reference data).
|
| 104 |
|
|
|
|
| 105 |
## Data Validation
|
|
|
|
|
|
|
| 106 |
|
| 107 |
+
* The data files contain attenuation sinograms and images reconstructed from raw data using the filtered backprojection algorithm.
|
| 108 |
+
* `reconstruct.py` rebuilds both from `data/raw_data` and plots them beside the stored versions (see *Processing the Dataset*).
|
| 109 |
|
| 110 |
## Known Issues
|
| 111 |
* The following probe elements should be considered damaged: [367, 409, 457, 764, 775, 776, 368, 390, 470, 739, 792].
|
| 112 |
|
|
|
|
| 113 |
## Ethical Considerations
|
| 114 |
* All human subjects were healthy adults who voluntarily participated in the measurements.
|
|
|