tristan-deep commited on
Commit
afd4138
·
verified ·
1 Parent(s): e3afc47

kaist-snubh-barreleye: sync data card and main image with GitHub

Browse files
kaist-snubh-barreleye/README.md CHANGED
@@ -2,6 +2,25 @@
2
 
3
  *An in-vivo human breast plane-wave raw-channel ultrasound sub-dataset for the OpenH-RF foundation initiative.*
4
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
  ## Dataset Description
6
 
7
  Breast OpenH-RF contains pre-beamformed RF channel-capture data from in-vivo breast ultrasound exams performed on a clinical, FDA-cleared scanner. Every acquisition is a 9-angle plane-wave compounding sequence with a 192-element linear array, paired with a B-mode reference image and a clinically verified diagnostic label. The intended research contribution is two-fold: (1) provide a clinically-grounded benchmark for **sound-speed and attenuation imaging** (Section 6.3 of the RFP) on real human breast tissue with biopsy-proven outcomes and (2) supply a high-quality plane-wave compounding corpus for **generalized reconstruction** research (Section 6.1: super-resolution, aberration correction, adaptive transmit design). Pathology and BI-RADS labels additionally enable benchmarking of **ultrasound interpretation** (Section 6.5).
@@ -19,7 +38,7 @@ Breast OpenH-RF contains pre-beamformed RF channel-capture data from in-vivo bre
19
 
20
  ## License / Terms of Use
21
 
22
- **CC BY 4.0** (see [`LICENCE`](LICENCE)).
23
 
24
  ## Intended Usage
25
 
@@ -142,20 +161,19 @@ Plane-wave transmit beamforming is used, with all 192 elements activated on each
142
 
143
  ## Data Validation
144
 
145
- A reference reconstruction is provided in [`reconstruct.py`](reconstruct.py). It defines the DAS pipeline directly in code (via zea ops) and applies, to the raw RF channel data:
146
 
147
  ```
148
  cast(float32) → band-pass filter (1–12 MHz) → demodulate → DAS beamform → envelope detect → normalize → log compression
149
  ```
150
 
151
- The 1–12 MHz band-pass rejects a persistent sub-MHz band before coherent beamforming, which allows to produce a clean B-mode directly from the raw RF. Run it to reproduce a reference B-mode from any delivered file:
152
 
153
- ```bash
154
- python reconstruct.py --input hdf5/original/S01_D1.hdf5 # single file
155
- python reconstruct.py --compare S01_D1 # DAS vs. scanner reference B-mode
156
  ```
157
 
158
- `python reconstruct.py --save-yaml` exports the pipeline as `pipeline.yaml` if a shareable recipe is needed (the script itself does not load it).
159
 
160
  ## Known Issues
161
 
 
2
 
3
  *An in-vivo human breast plane-wave raw-channel ultrasound sub-dataset for the OpenH-RF foundation initiative.*
4
 
5
+ ![DAS B-mode reconstruction of a biopsy-proven invasive ductal carcinoma (S01_D1)](assets/main.png)
6
+
7
+ Delay-and-sum reconstruction of the raw RF channel data in `data/S01_D1.hdf5`. Produced by `reconstruct.py`.
8
+
9
+ `zea` renders it straight from the Hub with the
10
+ `pipeline.yaml` in this folder. Try it out with the following command:
11
+
12
+ ```bash
13
+ zea process \
14
+ --dataset hf://nvidia/OpenH-RF/kaist-snubh-barreleye/data/S01_D1.hdf5 \
15
+ --config hf://nvidia/OpenH-RF/kaist-snubh-barreleye/pipeline.yaml \
16
+ --n-frames 1 \
17
+ --save-as png
18
+ ```
19
+
20
+ This is a single-frame acquisition, so `zea process` outputs a `.png` rather
21
+ than a `.gif` — this requires a `zea` build newer than the currently pinned
22
+ 0.1.6 (single-frame PNG output landed after that release).
23
+
24
  ## Dataset Description
25
 
26
  Breast OpenH-RF contains pre-beamformed RF channel-capture data from in-vivo breast ultrasound exams performed on a clinical, FDA-cleared scanner. Every acquisition is a 9-angle plane-wave compounding sequence with a 192-element linear array, paired with a B-mode reference image and a clinically verified diagnostic label. The intended research contribution is two-fold: (1) provide a clinically-grounded benchmark for **sound-speed and attenuation imaging** (Section 6.3 of the RFP) on real human breast tissue with biopsy-proven outcomes and (2) supply a high-quality plane-wave compounding corpus for **generalized reconstruction** research (Section 6.1: super-resolution, aberration correction, adaptive transmit design). Pathology and BI-RADS labels additionally enable benchmarking of **ultrasound interpretation** (Section 6.5).
 
38
 
39
  ## License / Terms of Use
40
 
41
+ **CC BY 4.0** ([Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/)).
42
 
43
  ## Intended Usage
44
 
 
161
 
162
  ## Data Validation
163
 
164
+ [`reconstruct.py`](https://github.com/open-h/OpenH-RF/blob/main/datasets/kaist-snubh-barreleye/reconstruct.py) reconstructs a B-mode from `raw_data` using the `zea.Pipeline` defined in [`pipeline.yaml`](pipeline.yaml):
165
 
166
  ```
167
  cast(float32) → band-pass filter (1–12 MHz) → demodulate → DAS beamform → envelope detect → normalize → log compression
168
  ```
169
 
170
+ The 1–12 MHz band-pass rejects a persistent sub-MHz band before coherent beamforming, which allows it to produce a clean B-mode directly from the raw RF. Run:
171
 
172
+ ```
173
+ python reconstruct.py
 
174
  ```
175
 
176
+ Reference output: `main.png` — `data/S01_D1.hdf5` (biopsy-proven invasive ductal carcinoma), shown above.
177
 
178
  ## Known Issues
179
 
kaist-snubh-barreleye/assets/main.png ADDED

Git LFS Details

  • SHA256: d144c0704e3ab610b2adcf6ab190dfc17aafea2ed40fbc5396a2cdf1b526fe5a
  • Pointer size: 131 Bytes
  • Size of remote file: 553 kB