tristan-deep commited on
Commit
b768e81
·
verified ·
1 Parent(s): 712d90b

twente-cavitation: restructure the data card to the common layout

Browse files

Syncs the twente-cavitation card on the Hub with the reviewed state on GitHub (open-h/OpenH-RF).

The card now follows the layout shared by every OpenH-RF dataset: frontmatter with a `name`, a stand-alone title, the hero image with an italic caption linking the sample it shows, Description, Contributor(s), Creation Date and the standard CC BY 4.0 text, then a new **Processing the Dataset** section (the `zea process` command where the pipeline carries the whole reconstruction, and the `reconstruct.py` link) followed by Dataset Format, which opens with the zea version. Hard line breaks are gone so the Hub wraps paragraphs itself; the longer sections keep their content.

The card gains a title. Data Validation described a Capon beamformer and a reference image that are not in this release; it now describes the passive acoustic mapping `reconstruct.py` does.

**GitHub PRs:**
- [tristan-deep/OpenH-RF#28](https://github.com/tristan-deep/OpenH-RF/pull/28) — Restructure all data cards to the common README layout

Files changed: 1.

```
~ twente-cavitation/README.md
```

Files changed (1) hide show
  1. twente-cavitation/README.md +26 -19
twente-cavitation/README.md CHANGED
@@ -1,5 +1,6 @@
1
  ---
2
- pretty_name: "OpenH-RF — Hermen de Roo / Passive cavitation detection"
 
3
  license: cc-by-4.0
4
  task_categories:
5
  - image-classification
@@ -14,33 +15,43 @@ size_categories:
14
  - 1K<n<10K
15
  ---
16
 
 
17
 
18
  ## Dataset Description
19
  The collected data is for cavitation mapping of microbubbles, insonified with focused ultrasound at various pressures and flowrates. This data applicable to therapeutic ultrasound and local drug delivery in any part of the human body. The used sensor hardware is a Verasonics research system with an L11-4v transducer for recording the bubble response during the treatment. Insonification is done using a single element transducer at 2.25MHz. The insonification is done with a 1000 cycles long pulse at 2.25MHz, where the first and last 2 microseconds are used for ramping up and down the pressure. The pulse repetition frequency used is 20Hz, repeated 400 times.
20
 
21
-
22
  ## Dataset Contributor(s)
23
- Hermen de Roo
24
- Michel Versluis
25
- Guillaume Lajoinie (contact email: g.p.r.lajoinie@utwente.nl)
26
 
 
 
 
27
 
28
  ## Dataset Creation Date
29
  Data recorded on 01/19/2026. Dataset created on 07/09/2026.
30
 
31
  ## License / Terms of Use
32
- I confirm that the data is cleared for use under CC BY 4.0.
 
33
 
34
  ## Intended Usage
35
  The dataset contains data over a large pressure range, from very low pressures up to the very high pressures used in therapeutic ultrasound. With this data one can quantify the treatment threshold and treatment effects over this wide range. The dataset also includes data for different levels of perfusion by varying the flowrate, from which the effect of perfusion on treatment efficacy can be studied. The data is intended to be processed with passive cavitation detection algorithms.
36
 
37
  ## Dataset Characterization
38
  - **Data Collection Method:** phantom
39
- - **Labeling Method:** N/A
40
  - **Acquisition system:** Verasonics Vantage 256, L11-4v transducer. 128 elements, 7.24MHz center frequency, 27.778 MHz sampling rate
41
 
 
 
 
 
 
 
42
  ## Dataset Format
43
- .zea file format. No preprocessing is applied.
 
 
 
44
 
45
  ## Dataset Quantification
46
 
@@ -51,8 +62,7 @@ The dataset contains data over a large pressure range, from very low pressures u
51
  - **Stored HDF5 size:** 10.85 GB (10,850,533,376 bytes).
52
  - All recordings were taken under identical conditions, except for the driving pressure and flowrate of the microbubble solution through the channel.
53
 
54
- Each acquisition is one zea HDF5 file with a single track (`tracks/track_0`). The
55
- per-frame channel data plus the scan/probe fields needed to reconstruct it are:
56
 
57
  | Field | Shape | dtype | Units | Description |
58
  |---|---|---|---|---|
@@ -71,11 +81,9 @@ per-frame channel data plus the scan/probe fields needed to reconstruct it are:
71
  | `scan/tgc_gain_curve` | (16384,) | float32 | a.u. | Time-gain-compensation curve applied along the axial dimension. |
72
  | `tracks/track_0/transmit_only` | scalar | bool | — | False (the array receives). |
73
 
74
- > **Note.** The table below is the **acquisition matrix** — it lists which files exist
75
- > and under what driving pressure / flowrate, not the internal layout of a sample.
76
 
77
- Files are named `cavitation_bubbles_<pressure>kPa_<flowrate>mL.hdf5`, where
78
- `<flowrate>` is the microbubble flowrate in mL/min (`01` = 0.1, `05` = 0.5, `2` = 2).
79
 
80
  | Name | Acoustic driving pressure [kPa]| Microbubble flowrate [mL/min] |
81
  |--- |--- |--- |
@@ -99,19 +107,18 @@ Files are named `cavitation_bubbles_<pressure>kPa_<flowrate>mL.hdf5`, where
99
  | cavitation_bubbles_500kPa_2mL.hdf5 | 500 | 2 |
100
  | cavitation_bubbles_1000kPa_2mL.hdf5 | 1000 | 2 |
101
 
102
-
103
  ## Subject Metadata
104
  Only one phantom was used. This is a phantom made of PVCp with a single flow channel ~200 micrometer diameter. The used scanner is a Verasonics Vantage 256 with a L11-4v transducer.
105
 
106
  ## Data Validation
107
- An reconstruction pipeline can be found in pipeline.yaml. The script reconstruct.py is an example of the reconstruction of the data, using the minimum variance / Capon beamformer. An example reconstruction is saved with this dataset, and named reference_image_1000kPa_2mL_per_min.png, which was generated using the Capon beamforming algorithm using epsilon = 2, on the datafile named cavitation_bubbles_1000kPa_2mL_per_min.hdf5. By default the script saves the map next to the input file with the same name and a `.png` extension (e.g. `my_file.hdf5` → `my_file.png`); pass `--output` to override. Usage:
108
- python reconstruct.py
109
- python reconstruct.py --input my_file.hdf5 --device cpu
110
- python reconstruct.py --input my_file.hdf5 --output my_map.png --frames 20 --device cuda:0
111
 
 
112
 
113
  ## Known Issues
114
  No known issues.
115
 
116
  ## Ethical Considerations
 
117
  This is phantom acquisition data, hence no human-subject IRB/HIPAA approval is required.
 
 
 
1
  ---
2
+ name: twente-cavitation
3
+ pretty_name: "Twente Passive Cavitation Detection of Flowing Microbubbles"
4
  license: cc-by-4.0
5
  task_categories:
6
  - image-classification
 
15
  - 1K<n<10K
16
  ---
17
 
18
+ # Twente Passive Cavitation Detection of Flowing Microbubbles
19
 
20
  ## Dataset Description
21
  The collected data is for cavitation mapping of microbubbles, insonified with focused ultrasound at various pressures and flowrates. This data applicable to therapeutic ultrasound and local drug delivery in any part of the human body. The used sensor hardware is a Verasonics research system with an L11-4v transducer for recording the bubble response during the treatment. Insonification is done using a single element transducer at 2.25MHz. The insonification is done with a 1000 cycles long pulse at 2.25MHz, where the first and last 2 microseconds are used for ramping up and down the pressure. The pulse repetition frequency used is 20Hz, repeated 400 times.
22
 
 
23
  ## Dataset Contributor(s)
 
 
 
24
 
25
+ - Hermen de Roo
26
+ - Michel Versluis
27
+ - Guillaume Lajoinie <g.p.r.lajoinie@utwente.nl> (contact)
28
 
29
  ## Dataset Creation Date
30
  Data recorded on 01/19/2026. Dataset created on 07/09/2026.
31
 
32
  ## License / Terms of Use
33
+
34
+ [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.
35
 
36
  ## Intended Usage
37
  The dataset contains data over a large pressure range, from very low pressures up to the very high pressures used in therapeutic ultrasound. With this data one can quantify the treatment threshold and treatment effects over this wide range. The dataset also includes data for different levels of perfusion by varying the flowrate, from which the effect of perfusion on treatment efficacy can be studied. The data is intended to be processed with passive cavitation detection algorithms.
38
 
39
  ## Dataset Characterization
40
  - **Data Collection Method:** phantom
41
+ - **Labeling Method:** N/A
42
  - **Acquisition system:** Verasonics Vantage 256, L11-4v transducer. 128 elements, 7.24MHz center frequency, 27.778 MHz sampling rate
43
 
44
+ ## Processing the Dataset
45
+
46
+ The acquisitions can be processed with the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/twente-cavitation/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.
47
+
48
+ Set `ZEA_FILE` at the top of the script to pick an acquisition and `N_FRAMES` to set how many frames are averaged; the map is written to `assets/<file>.png`.
49
+
50
  ## Dataset Format
51
+
52
+ [zea v0.1.6](https://github.com/tue-bmd/zea)
53
+
54
+ .zea file format. No preprocessing is applied.
55
 
56
  ## Dataset Quantification
57
 
 
62
  - **Stored HDF5 size:** 10.85 GB (10,850,533,376 bytes).
63
  - All recordings were taken under identical conditions, except for the driving pressure and flowrate of the microbubble solution through the channel.
64
 
65
+ Each acquisition is one zea HDF5 file with a single track (`tracks/track_0`). The per-frame channel data plus the scan/probe fields needed to reconstruct it are:
 
66
 
67
  | Field | Shape | dtype | Units | Description |
68
  |---|---|---|---|---|
 
81
  | `scan/tgc_gain_curve` | (16384,) | float32 | a.u. | Time-gain-compensation curve applied along the axial dimension. |
82
  | `tracks/track_0/transmit_only` | scalar | bool | — | False (the array receives). |
83
 
84
+ > **Note.** The table below is the **acquisition matrix** — it lists which files exist and under what driving pressure / flowrate, not the internal layout of a sample.
 
85
 
86
+ Files are named `cavitation_bubbles_<pressure>kPa_<flowrate>mL.hdf5`, where `<flowrate>` is the microbubble flowrate in mL/min (`01` = 0.1, `05` = 0.5, `2` = 2).
 
87
 
88
  | Name | Acoustic driving pressure [kPa]| Microbubble flowrate [mL/min] |
89
  |--- |--- |--- |
 
107
  | cavitation_bubbles_500kPa_2mL.hdf5 | 500 | 2 |
108
  | cavitation_bubbles_1000kPa_2mL.hdf5 | 1000 | 2 |
109
 
 
110
  ## Subject Metadata
111
  Only one phantom was used. This is a phantom made of PVCp with a single flow channel ~200 micrometer diameter. The used scanner is a Verasonics Vantage 256 with a L11-4v transducer.
112
 
113
  ## Data Validation
 
 
 
 
114
 
115
+ `reconstruct.py` reconstructs a passive acoustic map (PAM) with the `zea.Pipeline` in `pipeline.yaml`: the array only receives, so the transmit model is overridden and the chain aligns purely on receive curvature (one-way passive beamforming), averaging the envelope energy over sampling instants and frames. An example output is [`assets/cavitation_bubbles_10kPa_01mL_per_min.png`](assets/cavitation_bubbles_10kPa_01mL_per_min.png).
116
 
117
  ## Known Issues
118
  No known issues.
119
 
120
  ## Ethical Considerations
121
+
122
  This is phantom acquisition data, hence no human-subject IRB/HIPAA approval is required.
123
+
124
+ The contributors confirm that the data is cleared for use under CC BY 4.0.