Commit ·
2de063e
1
Parent(s): 33fd6aa
Point data cards at pipeline.yaml and the merged reconstruct scripts
Browse files- weizmann-sampl: remove the pipeline YAML embedded in the card. It had
drifted from the real pipeline.yaml (grid 300x400 vs 377x525, and missing
apply_window plus the lens-correction parameters), so the card now points
at that file as the single source of truth.
- politorino: visualize_tracking_on_image.py has been merged into
reconstruct.py, so describe that script's constants instead.
- concordia: visualize.py has been merged into reconstruct.py, so describe
the one combined figure rather than two separate outputs.
- Spell the library "zea" rather than "Zea" throughout.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
- concordia/README.md +10 -12
- politorino/README.md +6 -7
- twente-microbubblesim/README.md +3 -3
- ubc/module_A/README.md +12 -12
- ubc/module_C/README.md +11 -11
- ubc/module_C/pipeline.yaml +1 -1
- weizmann-sampl/README.md +5 -31
concordia/README.md
CHANGED
|
@@ -137,7 +137,7 @@ Fields from Arbitrarily Shaped, Apodized, and Excited Ultrasound Transducers,"
|
|
| 137 |
|
| 138 |
The dataset is 2,000 individual zea HDF5 files (one acquisition per file) under
|
| 139 |
`data/` (zea format; `zea_version` 0.1.6). Reference figures are in
|
| 140 |
-
`examples/`; `reconstruct.py`, `
|
| 141 |
at the repository root. Per file:
|
| 142 |
|
| 143 |
- `data/raw_data` — full FSA channel data, `int16`, quantized from the native
|
|
@@ -244,25 +244,23 @@ scatterers (amplitude 18–22) scattered at valid random positions, for realism.
|
|
| 244 |
|
| 245 |
## Data Validation
|
| 246 |
|
| 247 |
-
**Setup:** `reconstruct.py`
|
| 248 |
and `KERAS_BACKEND=jax` (or `torch`/`tensorflow`) set before import. This submission
|
| 249 |
was built and verified against the [OpenH-RF repo](https://github.com/open-h/OpenH-RF)'s environment (`uv sync` inside a clone of that repo installs `zea` and every other
|
| 250 |
-
dependency
|
| 251 |
|
| 252 |
`reconstruct.py` (+ `pipeline.yaml`, zea's default DAS pipeline: Cast → ApplyWindow →
|
| 253 |
Demodulate → Beamform → EnvelopeDetect → Normalize → LogCompress; each stage is
|
| 254 |
explained in `reconstruct.py`'s own module docstring) reconstructs a synthetic
|
| 255 |
transmit aperture (STA) B-mode from `data/raw_data` using all 128 transmits, over
|
| 256 |
-
the same field of view as the stored `data/image` reference.
|
| 257 |
-
|
| 258 |
-
|
| 259 |
-
representative capture of each of the five classes, an `<id>_bmode.png` (the STA
|
| 260 |
-
reference reconstruction from `reconstruct.py`, physical mm axes, titled with the
|
| 261 |
-
sample ID) and an `<id>_panels.png` (the `visualize.py` output: stored `data/image`,
|
| 262 |
-
class label — segmentation foreground for anechoic/hypoechoic/hyperechoic,
|
| 263 |
`data/diverse_source_image` for diverse, none for point-target — and the
|
| 264 |
-
`data/scatterers` cloud coloured by |amplitude|, on shared equal-aspect mm
|
| 265 |
-
confirming the label, reconstruction, and scatterer field are spatially
|
|
|
|
|
|
|
| 266 |
|
| 267 |
## Known Issues
|
| 268 |
|
|
|
|
| 137 |
|
| 138 |
The dataset is 2,000 individual zea HDF5 files (one acquisition per file) under
|
| 139 |
`data/` (zea format; `zea_version` 0.1.6). Reference figures are in
|
| 140 |
+
`examples/`; `reconstruct.py`, `pipeline.yaml`, and this card sit
|
| 141 |
at the repository root. Per file:
|
| 142 |
|
| 143 |
- `data/raw_data` — full FSA channel data, `int16`, quantized from the native
|
|
|
|
| 244 |
|
| 245 |
## Data Validation
|
| 246 |
|
| 247 |
+
**Setup:** `reconstruct.py` requires `zea>=0.1.1`, `matplotlib`,
|
| 248 |
and `KERAS_BACKEND=jax` (or `torch`/`tensorflow`) set before import. This submission
|
| 249 |
was built and verified against the [OpenH-RF repo](https://github.com/open-h/OpenH-RF)'s environment (`uv sync` inside a clone of that repo installs `zea` and every other
|
| 250 |
+
dependency this script needs — see that repo's README for the exact commands).
|
| 251 |
|
| 252 |
`reconstruct.py` (+ `pipeline.yaml`, zea's default DAS pipeline: Cast → ApplyWindow →
|
| 253 |
Demodulate → Beamform → EnvelopeDetect → Normalize → LogCompress; each stage is
|
| 254 |
explained in `reconstruct.py`'s own module docstring) reconstructs a synthetic
|
| 255 |
transmit aperture (STA) B-mode from `data/raw_data` using all 128 transmits, over
|
| 256 |
+
the same field of view as the stored `data/image` reference. It renders that
|
| 257 |
+
reconstruction on physical mm axes next to the capture's class-specific label
|
| 258 |
+
— segmentation foreground for anechoic/hypoechoic/hyperechoic,
|
|
|
|
|
|
|
|
|
|
|
|
|
| 259 |
`data/diverse_source_image` for diverse, none for point-target — and the
|
| 260 |
+
`data/scatterers` cloud coloured by |amplitude|, all on shared equal-aspect mm
|
| 261 |
+
axes, confirming the label, reconstruction, and scatterer field are spatially
|
| 262 |
+
registered. `examples/` holds one such figure for a representative capture of
|
| 263 |
+
each of the five classes.
|
| 264 |
|
| 265 |
## Known Issues
|
| 266 |
|
politorino/README.md
CHANGED
|
@@ -50,14 +50,13 @@ This data was employed for an initial study evaluating fascicle tracking algorit
|
|
| 50 |
|
| 51 |
Submitted in the [`zea` file format](https://zea.readthedocs.io/en/latest/)
|
| 52 |
(one HDF5 file per acquisition).
|
| 53 |
-
`
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
--tracking-frame-idx: index of the frame to visualize.
|
| 57 |
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
|
| 62 |
Per-sample contents of the HDF5:
|
| 63 |
|
|
|
|
| 50 |
|
| 51 |
Submitted in the [`zea` file format](https://zea.readthedocs.io/en/latest/)
|
| 52 |
(one HDF5 file per acquisition).
|
| 53 |
+
`reconstruct.py` reconstructs a B-mode from the raw channel data and overlays
|
| 54 |
+
the stored fascicle tracking on it, writing a `.png`. An example output is
|
| 55 |
+
provided. The constants at the top of the script select what is drawn:
|
|
|
|
| 56 |
|
| 57 |
+
- `FRAME` -- index of the acquisition frame to reconstruct
|
| 58 |
+
- `FPS` -- which stored tracking rate to overlay (25, 50 or 125 fps)
|
| 59 |
+
- `TRACK_INDEX` -- index of the tracking sample within that rate
|
| 60 |
|
| 61 |
Per-sample contents of the HDF5:
|
| 62 |
|
twente-microbubblesim/README.md
CHANGED
|
@@ -57,7 +57,7 @@ deep-learning methods for microbubble super-resolution imaging.
|
|
| 57 |
## Dataset Characterization
|
| 58 |
|
| 59 |
- **Data collection method:** Synthetic.
|
| 60 |
-
- **Ground truth:** Simulated 3-D microbubble positions are stored as
|
| 61 |
elements (`bubble_x`, `bubble_y`, and `bubble_z`).
|
| 62 |
- **Bubble populations:** Monodisperse bubbles with a radius of 2.4 micrometres
|
| 63 |
and 5% standard deviation, and a polydisperse SonoVue population.
|
|
@@ -79,7 +79,7 @@ deep-learning methods for microbubble super-resolution imaging.
|
|
| 79 |
|
| 80 |
## Dataset Format
|
| 81 |
|
| 82 |
-
Each bubble distribution is stored in one
|
| 83 |
tracks. The raw channel data in every `tracks/track_i/data/raw_data` dataset
|
| 84 |
have shape `(1, 1, 8446, 96, 1)`: one frame, one transmit, 8,446 time samples,
|
| 85 |
96 receive elements, and one real RF channel. RF values are `float32`; their
|
|
@@ -212,7 +212,7 @@ to one `.hdf5` acquisition file.
|
|
| 212 |
|
| 213 |
## Data Validation
|
| 214 |
|
| 215 |
-
All 500 HDF5 files were checked for the expected
|
| 216 |
ordered and labelled tracks, RF shape `(1, 1, 8446, 96, 1)`, and track-specific
|
| 217 |
pulse metadata. The original submission passed zea 0.1.2 validation. Representative RF traces and pulse
|
| 218 |
waveforms were also compared with their pulse-folder sources with no mismatch.
|
|
|
|
| 57 |
## Dataset Characterization
|
| 58 |
|
| 59 |
- **Data collection method:** Synthetic.
|
| 60 |
+
- **Ground truth:** Simulated 3-D microbubble positions are stored as zea custom
|
| 61 |
elements (`bubble_x`, `bubble_y`, and `bubble_z`).
|
| 62 |
- **Bubble populations:** Monodisperse bubbles with a radius of 2.4 micrometres
|
| 63 |
and 5% standard deviation, and a polydisperse SonoVue population.
|
|
|
|
| 79 |
|
| 80 |
## Dataset Format
|
| 81 |
|
| 82 |
+
Each bubble distribution is stored in one zea HDF5 file containing 12 pulse
|
| 83 |
tracks. The raw channel data in every `tracks/track_i/data/raw_data` dataset
|
| 84 |
have shape `(1, 1, 8446, 96, 1)`: one frame, one transmit, 8,446 time samples,
|
| 85 |
96 receive elements, and one real RF channel. RF values are `float32`; their
|
|
|
|
| 212 |
|
| 213 |
## Data Validation
|
| 214 |
|
| 215 |
+
All 500 HDF5 files were checked for the expected zea container structure, 12
|
| 216 |
ordered and labelled tracks, RF shape `(1, 1, 8446, 96, 1)`, and track-specific
|
| 217 |
pulse metadata. The original submission passed zea 0.1.2 validation. Representative RF traces and pulse
|
| 218 |
waveforms were also compared with their pulse-folder sources with no mismatch.
|
ubc/module_A/README.md
CHANGED
|
@@ -25,13 +25,13 @@ size_categories:
|
|
| 25 |
This submission contains eight 3-D Shear-Wave Absolute Vibro-Elastography
|
| 26 |
(S-WAVE) acquisitions of CIRS model 039 Shear Wave Liver Fibrosis Phantom
|
| 27 |
samples. The source scanner export contains beamformed 64-line RF rather than
|
| 28 |
-
measured pre-beamforming channel capture. Accordingly, every submitted
|
| 29 |
`raw_data` frame (stored at `/tracks/track_0/data/raw_data`) is explicitly
|
| 30 |
labeled **in-silico/synthetic**: a dense
|
| 31 |
point-scatterer field is estimated from one corrected source line-RF frame and
|
| 32 |
forward-simulated through a documented 64-transmit, 128-receive-element model.
|
| 33 |
|
| 34 |
-
The files are physically delay-consistent and reconstruct with
|
| 35 |
scanline delay-and-sum. They are not recovered or measured scanner channel
|
| 36 |
data, and they must not be represented as such.
|
| 37 |
|
|
@@ -45,7 +45,7 @@ Chung Lee, Zongze Li, Patrick Boyan Chen, and Michael Frew.
|
|
| 45 |
|
| 46 |
## Dataset Creation Date
|
| 47 |
|
| 48 |
-
09/01/2026 for this corrected
|
| 49 |
phantom acquisitions predate this packaging.
|
| 50 |
|
| 51 |
## License / Terms of Use
|
|
@@ -69,7 +69,7 @@ factory-rated nominal stiffness, not a derived S-WAVE estimate.
|
|
| 69 |
- Acquisition System: Ultrasonix/Sonix with 4DEC9-5/10 end-firing 3-D probe.
|
| 70 |
- Submitted Data Tier: phantom / simulation.
|
| 71 |
- Simulation Framework: custom deterministic NumPy/SciPy forward simulator;
|
| 72 |
-
files and reconstruction were validated with
|
| 73 |
|
| 74 |
Acquisition and simulation details:
|
| 75 |
|
|
@@ -107,7 +107,7 @@ Acquisition and simulation details:
|
|
| 107 |
## Dataset Format
|
| 108 |
|
| 109 |
There are 8 × 20 × 25 = **4,000** one-frame HDF5 files. One file per source
|
| 110 |
-
frame keeps full
|
| 111 |
For motion analysis, group files by case and motor plane, then order `f00`
|
| 112 |
through `f24`; `/custom/source_provenance/source_timing` retains the source
|
| 113 |
clock index, within-plane temporal offset, and relative plane timestamp.
|
|
@@ -127,8 +127,8 @@ module_A/
|
|
| 127 |
|
| 128 |
Each HDF5 file contains the following per-sample features:
|
| 129 |
|
| 130 |
-
Numeric arrays use
|
| 131 |
-
compression; reading these arrays requires `hdf5plugin`, which is imported by
|
| 132 |
|
| 133 |
| Name | Shape | Dtype | Units | Description |
|
| 134 |
|---|---:|---|---|---|
|
|
@@ -166,14 +166,14 @@ Phantom.
|
|
| 166 |
|
| 167 |
## Data Validation
|
| 168 |
|
| 169 |
-
The contributor reports validation with Python 3.12.3 and
|
| 170 |
-
The contributor's reconstruction reads only the
|
| 171 |
acquisition parameters, not the stored image or preserved source line RF:
|
| 172 |
|
| 173 |
```text
|
| 174 |
Cast to float32
|
| 175 |
-> RF demodulation
|
| 176 |
-
->
|
| 177 |
and enable_aligned_apodization=true
|
| 178 |
-> Envelope detection
|
| 179 |
-> 99.5th-percentile normalization
|
|
@@ -183,7 +183,7 @@ Cast to float32
|
|
| 183 |
```
|
| 184 |
|
| 185 |
In scanline mode the output has 64 angular lines—one per stored focused
|
| 186 |
-
transmit.
|
| 187 |
transmit mask internally; no custom `flat_pfield` or transmit-weight code is
|
| 188 |
used.
|
| 189 |
|
|
@@ -191,7 +191,7 @@ used.
|
|
| 191 |
`zlims: [0.0001, 0.100023]` are line depths from
|
| 192 |
each transmit origin on the curved element surface.
|
| 193 |
|
| 194 |
-
The contributor reports structural checks across all files, plus full
|
| 195 |
schema validation and raw-only reconstruction on three distributed samples
|
| 196 |
from each case (24 samples). For those samples, the preserved source line RF
|
| 197 |
was also compared with the original E-scan events.
|
|
|
|
| 25 |
This submission contains eight 3-D Shear-Wave Absolute Vibro-Elastography
|
| 26 |
(S-WAVE) acquisitions of CIRS model 039 Shear Wave Liver Fibrosis Phantom
|
| 27 |
samples. The source scanner export contains beamformed 64-line RF rather than
|
| 28 |
+
measured pre-beamforming channel capture. Accordingly, every submitted zea
|
| 29 |
`raw_data` frame (stored at `/tracks/track_0/data/raw_data`) is explicitly
|
| 30 |
labeled **in-silico/synthetic**: a dense
|
| 31 |
point-scatterer field is estimated from one corrected source line-RF frame and
|
| 32 |
forward-simulated through a documented 64-transmit, 128-receive-element model.
|
| 33 |
|
| 34 |
+
The files are physically delay-consistent and reconstruct with zea-native
|
| 35 |
scanline delay-and-sum. They are not recovered or measured scanner channel
|
| 36 |
data, and they must not be represented as such.
|
| 37 |
|
|
|
|
| 45 |
|
| 46 |
## Dataset Creation Date
|
| 47 |
|
| 48 |
+
09/01/2026 for this corrected zea-beamformable synthetic-channel package. The source
|
| 49 |
phantom acquisitions predate this packaging.
|
| 50 |
|
| 51 |
## License / Terms of Use
|
|
|
|
| 69 |
- Acquisition System: Ultrasonix/Sonix with 4DEC9-5/10 end-firing 3-D probe.
|
| 70 |
- Submitted Data Tier: phantom / simulation.
|
| 71 |
- Simulation Framework: custom deterministic NumPy/SciPy forward simulator;
|
| 72 |
+
files and reconstruction were validated with zea 0.1.4.
|
| 73 |
|
| 74 |
Acquisition and simulation details:
|
| 75 |
|
|
|
|
| 107 |
## Dataset Format
|
| 108 |
|
| 109 |
There are 8 × 20 × 25 = **4,000** one-frame HDF5 files. One file per source
|
| 110 |
+
frame keeps full zea schema validation and reconstruction memory-bounded.
|
| 111 |
For motion analysis, group files by case and motor plane, then order `f00`
|
| 112 |
through `f24`; `/custom/source_provenance/source_timing` retains the source
|
| 113 |
clock index, within-plane temporal offset, and relative plane timestamp.
|
|
|
|
| 127 |
|
| 128 |
Each HDF5 file contains the following per-sample features:
|
| 129 |
|
| 130 |
+
Numeric arrays use zea 0.1.4's native frame-chunked Blosc/Zstd plus bitshuffle
|
| 131 |
+
compression; reading these arrays requires `hdf5plugin`, which is imported by zea.
|
| 132 |
|
| 133 |
| Name | Shape | Dtype | Units | Description |
|
| 134 |
|---|---:|---|---|---|
|
|
|
|
| 166 |
|
| 167 |
## Data Validation
|
| 168 |
|
| 169 |
+
The contributor reports validation with Python 3.12.3 and zea 0.1.4.
|
| 170 |
+
The contributor's reconstruction reads only the zea `raw_data` field and
|
| 171 |
acquisition parameters, not the stored image or preserved source line RF:
|
| 172 |
|
| 173 |
```text
|
| 174 |
Cast to float32
|
| 175 |
-> RF demodulation
|
| 176 |
+
-> zea delay_and_sum with enable_scanline=true
|
| 177 |
and enable_aligned_apodization=true
|
| 178 |
-> Envelope detection
|
| 179 |
-> 99.5th-percentile normalization
|
|
|
|
| 183 |
```
|
| 184 |
|
| 185 |
In scanline mode the output has 64 angular lines—one per stored focused
|
| 186 |
+
transmit. zea constructs the one-line-per-transmit grid and the one-hot aligned
|
| 187 |
transmit mask internally; no custom `flat_pfield` or transmit-weight code is
|
| 188 |
used.
|
| 189 |
|
|
|
|
| 191 |
`zlims: [0.0001, 0.100023]` are line depths from
|
| 192 |
each transmit origin on the curved element surface.
|
| 193 |
|
| 194 |
+
The contributor reports structural checks across all files, plus full zea
|
| 195 |
schema validation and raw-only reconstruction on three distributed samples
|
| 196 |
from each case (24 samples). For those samples, the preserved source line RF
|
| 197 |
was also compared with the original E-scan events.
|
ubc/module_C/README.md
CHANGED
|
@@ -91,13 +91,13 @@ physical ground truth for the simulated channels.
|
|
| 91 |
| Parameter | Value | Status |
|
| 92 |
|---|---:|---|
|
| 93 |
| Frames | 3,845 | Two sessions; one per matched BK/RealSense frame |
|
| 94 |
-
| Focused transmit events per frame | 248 | Stored in each
|
| 95 |
| Receive elements | 192 | Synthetic assumption |
|
| 96 |
| Axial RF samples per trace | 3,153 | Includes 300 zero-tail samples |
|
| 97 |
| RF components | 1 real component | Stored as `int16` |
|
| 98 |
-
| Sampling frequency | 15 MHz | Stored
|
| 99 |
-
| Center/demodulation frequency | 3.75 MHz | Stored
|
| 100 |
-
| Assumed sound speed | 1,540 m/s | Stored
|
| 101 |
| Assumed element pitch | 0.2 mm | Synthetic geometry assumption |
|
| 102 |
| Assumed nominal aperture | 38.4 mm | 192 elements × 0.2 mm |
|
| 103 |
| Element width / height | 0.18 mm / 5.0 mm | Synthetic model |
|
|
@@ -113,7 +113,7 @@ the proprietary scanner transmit law is unknown.
|
|
| 113 |
|
| 114 |
## Dataset Format
|
| 115 |
|
| 116 |
-
Each
|
| 117 |
The writer-version field describes serialization,
|
| 118 |
not processing speed. Source IQ and its display reference are under
|
| 119 |
`/custom/source_provenance`.
|
|
@@ -145,7 +145,7 @@ are intentionally withheld for de-identification.** IQ, BK viewport, NDI
|
|
| 145 |
reference-tool, and RealSense host times are relative to the first **source** IQ
|
| 146 |
frame of their own session, even when that frame is excluded from the release. RealSense device time is relative to its first camera frame.
|
| 147 |
Negative host-relative camera times can precede the first IQ frame.
|
| 148 |
-
Each one-frame
|
| 149 |
IQ time stored separately in `/custom/synchronization`.
|
| 150 |
|
| 151 |
Use alignment indices and validity flags, not video frame rate alone, to link
|
|
@@ -215,7 +215,7 @@ this does not establish generalization to different phantoms or patients.
|
|
| 215 |
`/custom/synchronization/source_valid_axial_samples`. The synthetic RF tensor
|
| 216 |
has a fixed 3,153 axial samples regardless of source IQ length.
|
| 217 |
|
| 218 |
-
Scalar
|
| 219 |
center and demodulation frequencies, and 1,540-m/s sound speed. Dataset-level
|
| 220 |
attributes provide descriptions and units for individual fields.
|
| 221 |
|
|
@@ -235,13 +235,13 @@ this HF release.
|
|
| 235 |
|
| 236 |
### Reconstruction
|
| 237 |
|
| 238 |
-
The contributor reports validation with Python 3.12,
|
| 239 |
CUDA 12.8 / PyTorch configuration. The retained `pipeline.yaml` records the
|
| 240 |
shared reconstruction configuration; the standalone reconstruction entry
|
| 241 |
point and its dependency file are not included in this HF release.
|
| 242 |
|
| 243 |
-
The contributor's reconstruction reads synthetic `raw_data`,
|
| 244 |
-
imaging depth.
|
| 245 |
scanline, followed by envelope detection, normalization, log compression, and
|
| 246 |
the documented display conversion. Source IQ, stored B-mode, and videos are
|
| 247 |
not reconstruction inputs. Prepared pipelines are reused only for matching
|
|
@@ -258,7 +258,7 @@ comparison. This does not imply that every RF file has been reconstructed.
|
|
| 258 |
|
| 259 |
- Harris, C. R., et al. (2020). [Array programming with NumPy](https://doi.org/10.1038/s41586-020-2649-2). *Nature*, 585, 357–362.
|
| 260 |
- Virtanen, P., et al. (2020). [SciPy 1.0: fundamental algorithms for scientific computing in Python](https://doi.org/10.1038/s41592-019-0686-2). *Nature Methods*, 17, 261–272.
|
| 261 |
-
- Stevens, T. S. W., et al. (2026). [zea: A Toolbox for Cognitive Ultrasound Imaging](https://doi.org/10.21105/joss.09881). *Journal of Open Source Software*, 11(121), 9881. See also the [
|
| 262 |
|
| 263 |
## Subject Metadata
|
| 264 |
|
|
|
|
| 91 |
| Parameter | Value | Status |
|
| 92 |
|---|---:|---|
|
| 93 |
| Frames | 3,845 | Two sessions; one per matched BK/RealSense frame |
|
| 94 |
+
| Focused transmit events per frame | 248 | Stored in each zea file |
|
| 95 |
| Receive elements | 192 | Synthetic assumption |
|
| 96 |
| Axial RF samples per trace | 3,153 | Includes 300 zero-tail samples |
|
| 97 |
| RF components | 1 real component | Stored as `int16` |
|
| 98 |
+
| Sampling frequency | 15 MHz | Stored zea scan parameter |
|
| 99 |
+
| Center/demodulation frequency | 3.75 MHz | Stored zea scan parameter |
|
| 100 |
+
| Assumed sound speed | 1,540 m/s | Stored zea scan parameter |
|
| 101 |
| Assumed element pitch | 0.2 mm | Synthetic geometry assumption |
|
| 102 |
| Assumed nominal aperture | 38.4 mm | 192 elements × 0.2 mm |
|
| 103 |
| Element width / height | 0.18 mm / 5.0 mm | Synthetic model |
|
|
|
|
| 113 |
|
| 114 |
## Dataset Format
|
| 115 |
|
| 116 |
+
Each zea HDF5 file contains one frame and is written with **zea 0.1.5**.
|
| 117 |
The writer-version field describes serialization,
|
| 118 |
not processing speed. Source IQ and its display reference are under
|
| 119 |
`/custom/source_provenance`.
|
|
|
|
| 145 |
reference-tool, and RealSense host times are relative to the first **source** IQ
|
| 146 |
frame of their own session, even when that frame is excluded from the release. RealSense device time is relative to its first camera frame.
|
| 147 |
Negative host-relative camera times can precede the first IQ frame.
|
| 148 |
+
Each one-frame zea probe-pose timestamp is locally zero, with session-relative
|
| 149 |
IQ time stored separately in `/custom/synchronization`.
|
| 150 |
|
| 151 |
Use alignment indices and validity flags, not video frame rate alone, to link
|
|
|
|
| 215 |
`/custom/synchronization/source_valid_axial_samples`. The synthetic RF tensor
|
| 216 |
has a fixed 3,153 axial samples regardless of source IQ length.
|
| 217 |
|
| 218 |
+
Scalar zea fields additionally store the 15-MHz sampling frequency, 3.75-MHz
|
| 219 |
center and demodulation frequencies, and 1,540-m/s sound speed. Dataset-level
|
| 220 |
attributes provide descriptions and units for individual fields.
|
| 221 |
|
|
|
|
| 235 |
|
| 236 |
### Reconstruction
|
| 237 |
|
| 238 |
+
The contributor reports validation with Python 3.12, zea 0.1.5, and a
|
| 239 |
CUDA 12.8 / PyTorch configuration. The retained `pipeline.yaml` records the
|
| 240 |
shared reconstruction configuration; the standalone reconstruction entry
|
| 241 |
point and its dependency file are not included in this HF release.
|
| 242 |
|
| 243 |
+
The contributor's reconstruction reads synthetic `raw_data`, zea scan/probe parameters, and
|
| 244 |
+
imaging depth. zea's native aligned scanline DAS uses exactly one transmit per
|
| 245 |
scanline, followed by envelope detection, normalization, log compression, and
|
| 246 |
the documented display conversion. Source IQ, stored B-mode, and videos are
|
| 247 |
not reconstruction inputs. Prepared pipelines are reused only for matching
|
|
|
|
| 258 |
|
| 259 |
- Harris, C. R., et al. (2020). [Array programming with NumPy](https://doi.org/10.1038/s41586-020-2649-2). *Nature*, 585, 357–362.
|
| 260 |
- Virtanen, P., et al. (2020). [SciPy 1.0: fundamental algorithms for scientific computing in Python](https://doi.org/10.1038/s41592-019-0686-2). *Nature Methods*, 17, 261–272.
|
| 261 |
+
- Stevens, T. S. W., et al. (2026). [zea: A Toolbox for Cognitive Ultrasound Imaging](https://doi.org/10.21105/joss.09881). *Journal of Open Source Software*, 11(121), 9881. See also the [zea operations documentation](https://zea.readthedocs.io/en/stable/_autosummary/zea.ops.html).
|
| 262 |
|
| 263 |
## Subject Metadata
|
| 264 |
|
ubc/module_C/pipeline.yaml
CHANGED
|
@@ -1,6 +1,6 @@
|
|
| 1 |
# Raw-data-to-scanline pipeline used by reconstruct.py. The documented
|
| 2 |
# display-only BK-like scan conversion and uncropped border are applied in
|
| 3 |
-
# reconstruct.py after this
|
| 4 |
pipeline:
|
| 5 |
name: module_c_native_scanline_delay_and_sum
|
| 6 |
operations:
|
|
|
|
| 1 |
# Raw-data-to-scanline pipeline used by reconstruct.py. The documented
|
| 2 |
# display-only BK-like scan conversion and uncropped border are applied in
|
| 3 |
+
# reconstruct.py after this zea pipeline completes.
|
| 4 |
pipeline:
|
| 5 |
name: module_c_native_scanline_delay_and_sum
|
| 6 |
operations:
|
weizmann-sampl/README.md
CHANGED
|
@@ -104,37 +104,11 @@ the frames prior to workspace parameter freezing were removed from the raw chann
|
|
| 104 |
|
| 105 |
## Data Validation
|
| 106 |
|
| 107 |
-
`reconstruct.py` runs the
|
| 108 |
-
|
| 109 |
-
|
| 110 |
-
lens correction) → envelope detect → normalize → log compress.
|
| 111 |
-
|
| 112 |
-
```yaml
|
| 113 |
-
# Beamforming config for the L11-5v thyroid scans (focused ray-line imaging).
|
| 114 |
-
# RF data is real (not IQ/baseband, sampleMode=NS200BW) so it is demodulated
|
| 115 |
-
# before beamforming. grid_size_x/z fix the output resolution; the actual
|
| 116 |
-
# depth mapped onto it comes from this file's own N_AX (D1: 2048 samples,
|
| 117 |
-
# ~50mm one-way in 1540 m/s tissue).
|
| 118 |
-
|
| 119 |
-
parameters:
|
| 120 |
-
grid_size_x: 300
|
| 121 |
-
grid_size_z: 400
|
| 122 |
-
dynamic_range: [-60, 0]
|
| 123 |
-
|
| 124 |
-
pipeline:
|
| 125 |
-
operations:
|
| 126 |
-
- name: keras.ops.cast
|
| 127 |
-
params:
|
| 128 |
-
dtype: float32
|
| 129 |
-
- demodulate
|
| 130 |
-
- name: beamform
|
| 131 |
-
params:
|
| 132 |
-
beamformer: delay_and_sum
|
| 133 |
-
num_patches: 200
|
| 134 |
-
- envelope_detect
|
| 135 |
-
- normalize
|
| 136 |
-
- log_compress
|
| 137 |
-
```
|
| 138 |
|
| 139 |
Example reconstruction, run via `python reconstruct.py --data-dir subjects
|
| 140 |
--n-scans 3 --n-frames 3 --seed 0 --output three_patients_grid.png`
|
|
|
|
| 104 |
|
| 105 |
## Data Validation
|
| 106 |
|
| 107 |
+
`reconstruct.py` runs the `zea.Pipeline` defined in `pipeline.yaml`, alongside
|
| 108 |
+
this README, to reconstruct a B-mode image from the raw channel data: cast →
|
| 109 |
+
apply window → demodulate → DAS beamform (with native, per-element/per-pixel
|
| 110 |
+
lens correction) → envelope detect → normalize → log compress. See that file
|
| 111 |
+
for the grid size, dynamic range and lens-correction parameters.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 112 |
|
| 113 |
Example reconstruction, run via `python reconstruct.py --data-dir subjects
|
| 114 |
--n-scans 3 --n-frames 3 --seed 0 --output three_patients_grid.png`
|