tristan-deep commited on
Commit
adb2631
·
verified ·
1 Parent(s): 72bb2ee

Rename waterloo-largeartery to waterloo-femoralvein; sync card, pipeline and figures with GitHub

Browse files

Moves the whole dataset folder (15 HDF5 files, server-side copy, unchanged) to waterloo-femoralvein/ and removes waterloo-largeartery/. Card, pipeline.yaml and figures mirror tristan-deep/OpenH-RF#30 and #39.

.gitattributes CHANGED
@@ -23472,3 +23472,18 @@ ubc/module_C/acquisitions/session_02/session_02_f4326.hdf5 filter=lfs diff=lfs m
23472
  ubc/module_C/acquisitions/session_02/session_02_f4328.hdf5 filter=lfs diff=lfs merge=lfs -text
23473
  ubc/module_C/acquisitions/session_02/session_02_f4330.hdf5 filter=lfs diff=lfs merge=lfs -text
23474
  ubc/module_C/acquisitions/session_02/session_02_f4332.hdf5 filter=lfs diff=lfs merge=lfs -text
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23472
  ubc/module_C/acquisitions/session_02/session_02_f4328.hdf5 filter=lfs diff=lfs merge=lfs -text
23473
  ubc/module_C/acquisitions/session_02/session_02_f4330.hdf5 filter=lfs diff=lfs merge=lfs -text
23474
  ubc/module_C/acquisitions/session_02/session_02_f4332.hdf5 filter=lfs diff=lfs merge=lfs -text
23475
+ waterloo-femoralvein/data/Acq0.hdf5 filter=lfs diff=lfs merge=lfs -text
23476
+ waterloo-femoralvein/data/Acq1.hdf5 filter=lfs diff=lfs merge=lfs -text
23477
+ waterloo-femoralvein/data/Acq10.hdf5 filter=lfs diff=lfs merge=lfs -text
23478
+ waterloo-femoralvein/data/Acq11.hdf5 filter=lfs diff=lfs merge=lfs -text
23479
+ waterloo-femoralvein/data/Acq12.hdf5 filter=lfs diff=lfs merge=lfs -text
23480
+ waterloo-femoralvein/data/Acq13.hdf5 filter=lfs diff=lfs merge=lfs -text
23481
+ waterloo-femoralvein/data/Acq14.hdf5 filter=lfs diff=lfs merge=lfs -text
23482
+ waterloo-femoralvein/data/Acq2.hdf5 filter=lfs diff=lfs merge=lfs -text
23483
+ waterloo-femoralvein/data/Acq3.hdf5 filter=lfs diff=lfs merge=lfs -text
23484
+ waterloo-femoralvein/data/Acq4.hdf5 filter=lfs diff=lfs merge=lfs -text
23485
+ waterloo-femoralvein/data/Acq5.hdf5 filter=lfs diff=lfs merge=lfs -text
23486
+ waterloo-femoralvein/data/Acq6.hdf5 filter=lfs diff=lfs merge=lfs -text
23487
+ waterloo-femoralvein/data/Acq7.hdf5 filter=lfs diff=lfs merge=lfs -text
23488
+ waterloo-femoralvein/data/Acq8.hdf5 filter=lfs diff=lfs merge=lfs -text
23489
+ waterloo-femoralvein/data/Acq9.hdf5 filter=lfs diff=lfs merge=lfs -text
{waterloo-largeartery → waterloo-femoralvein}/README.md RENAMED
@@ -1,5 +1,5 @@
1
  ---
2
- name: waterloo-largeartery
3
  pretty_name: UW-FemVeinRF
4
  license: cc-by-4.0
5
  task_categories:
@@ -23,9 +23,9 @@ size_categories:
23
 
24
  # UW-FemVein RF
25
 
26
- ![Reconstructed cineloop from Acq5.hdf5](assets/Acq5.gif)
27
 
28
- *Cine loop of [`data/Acq5.hdf5`](https://huggingface.co/datasets/nvidia/OpenH-RF/blob/main/waterloo-largeartery/data/Acq5.hdf5), reconstructed from the raw channel data with the `pipeline.yaml` in this folder.*
29
 
30
  ## Dataset Description
31
 
@@ -67,13 +67,13 @@ The acquisitions can be processed with the `pipeline.yaml` definition in this fo
67
 
68
  ```bash
69
  zea process \
70
- --dataset hf://nvidia/OpenH-RF/waterloo-largeartery/data/Acq5.hdf5 \
71
- --config hf://nvidia/OpenH-RF/waterloo-largeartery/pipeline.yaml \
72
  --n-frames 1 \
73
  --save-as png
74
  ```
75
 
76
- Alternatively, you can use the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/waterloo-largeartery/reconstruct.py) as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF).
77
 
78
  Swap `--n-frames 1 --save-as png` for `--save-as gif` to get the cine loop. In the script, `ZEA_FILE`, `FRAME`, `POWER_THRESHOLD` (the power-Doppler mask threshold, in dB), `VMAX` (velocity colour-scale maximum) and `NO_DEALIAS` at the top select what is reconstructed and overlaid.
79
 
@@ -110,23 +110,14 @@ Per-sample contents of the converted HDF5:
110
 
111
  All `coordinates` arrays are per-pixel Cartesian positions in meters, last axis `[x, y, z]` (y = 0 for 2-D maps).
112
 
113
- ## Shipped Example Acquisitions
114
 
115
- One example acquisition is included under `hdf5/` as a representative subset of the full dataset:
116
 
117
- | File | Subject | Anatomy | View | Condition | Frames |
118
- |---|---|---|---|---|---|
119
- | `hdf5/Acq0.hdf5` | 1 | Femoral Vein | Longitudinal | Contraction 8Kg HUT 40 | 9000-12000 |
120
-
121
- Each femoral vein acquisition comprises 2 steered plane-wave transmits (`n_tx = 2`), 2048/3072 axial samples, and 192 receive channels. Note that example provided was convrted with start-frame=9000 to get to the interesting part.
122
-
123
- The frame count in these examples is truncated for demonstration; full acquisitions contain the frame counts described below.
124
 
125
  ## Dataset Quantification
126
 
127
  **Current OpenH-RF release:** 15 HDF5 files; 941.96 GB (941,958,804,227 bytes) stored; root `zea_version` **0.1.5**. 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.
128
 
129
- Data was collected from 15 participants and consists of 15 acquisitions (one per participant), containing 12,000 frames of raw RF data per acquisition. Each participant performed isometric plantarflexion contractions at 8 Kg under head up tilt of 40 degrees.
130
 
131
  ## Subject Metadata
132
 
@@ -154,9 +145,9 @@ Data was collected from 15 participants and consists of 15 acquisitions (one per
154
  - **Reconstruction Grid:** Cartesian coordinates mapped by a `PixelMap` representing a lateral range of $[-19, 19]\text{ mm}$ and axial depth of $[10, 60]\text{ mm}$ at $0.1\text{ mm}$ spatial resolution.
155
  3. **Clutter Filtering:** Clutter filtering is performed on the beamformed ensemble using a high-pass wall filter (normalized cut-off frequencies of 0.05 and 0.1, attenuation of 100 dB).
156
  4. **Multi-Angle Doppler Frequency Estimation:** Angle-specific Doppler frequencies are computed using an ensemble size of 64 frames with a step size of 1.
157
- - For conventional vector velocity estimation, we used the following Tx-Rx angles: Tx: [-10, -10, 10, 10]; Rx: [-10, 10, -10, 10]
158
- - For dealiased vector velocity estimation, we used the following Tx-Rx angles: Tx: [-10, -10, -10,-10, 10, 10]; Rx: [-10, -3, 6, 10, -6, 3,10]
159
- - Color Doppler map is selected as the first of these (Tx: -10, Rx = -10)
160
  5. **Vector Doppler Velocity Estimation:** Lateral ($v_x$) and axial ($v_z$) velocity components are computed from the multi-angle Doppler frequency estimates using GPU-accelerated least-squares estimation. Lateral ($v_x$) and axial ($v_z$) dealiased velocity components are computed from the multi-angle Doppler frequency estimates using GPU-accelerated extended least-squares estimation.
161
 
162
  The full LITMUS processing pipeline (GPU DAS beamforming + multi-angle vector Doppler) is documented by the contributors. That documentation is provided for provenance and reproducibility; it depends on the LITMUS core Python package and the raw acquisition frames, so it is not runnable from this folder alone.
@@ -173,7 +164,7 @@ B. Y. S. Yiu and A. C. H. Yu, "Least-Squares Multi-Angle Doppler Estimators for
173
 
174
  `reconstruct.py` builds a `zea.Pipeline` of DAS beamforming → envelope detection → normalization → log-compression **in code** and reconstructs a B-mode directly from `raw_data`, showing the raw-to-image flow without any config file. It also saves the pipeline to `pipeline.yaml` as a shareable recipe. Comparing the reconstruction against the stored (LITMUS) B-mode is a sanity check that the acquisition parameters and probe geometry are recorded correctly, and serves as a reproducible reference reconstruction.
175
 
176
- When the vector-flow fields (`vector_velocity_x/z`/`vector_velocity_x/z_deal` + `power_doppler`) are present, a third panel overlays the vector velocity field on the stored B-mode. The overlay uses `draw_velocity_field`, a single self-contained (numpy + matplotlib) helper reproduced inside `reconstruct.py` from the LITMUS core Python package (`litmus.core_py.visualization`), so the script has no dependency on the full LITMUS GPU stack.
177
 
178
  The result is written to `reconstruct_output.png`:
179
 
 
1
  ---
2
+ name: waterloo-femoralvein
3
  pretty_name: UW-FemVeinRF
4
  license: cc-by-4.0
5
  task_categories:
 
23
 
24
  # UW-FemVein RF
25
 
26
+ ![Vector flow cineloop from Acq0.hdf5](assets/Acq0.gif)
27
 
28
+ *Cine loop of [`data/Acq0.hdf5`](https://huggingface.co/datasets/nvidia/OpenH-RF/blob/main/waterloo-femoralvein/data/Acq0.hdf5), rendered from provided velocity fields.*
29
 
30
  ## Dataset Description
31
 
 
67
 
68
  ```bash
69
  zea process \
70
+ --dataset hf://nvidia/OpenH-RF/waterloo-femoralvein/data/Acq0.hdf5 \
71
+ --config hf://nvidia/OpenH-RF/waterloo-femoralvein/pipeline.yaml \
72
  --n-frames 1 \
73
  --save-as png
74
  ```
75
 
76
+ Alternatively, you can use the `reconstruct.py` [script](https://github.com/open-h/OpenH-RF/blob/main/datasets/waterloo-femoralvein/reconstruct.py) as provided in the [OpenH-RF GitHub repository](https://github.com/open-h/OpenH-RF).
77
 
78
  Swap `--n-frames 1 --save-as png` for `--save-as gif` to get the cine loop. In the script, `ZEA_FILE`, `FRAME`, `POWER_THRESHOLD` (the power-Doppler mask threshold, in dB), `VMAX` (velocity colour-scale maximum) and `NO_DEALIAS` at the top select what is reconstructed and overlaid.
79
 
 
110
 
111
  All `coordinates` arrays are per-pixel Cartesian positions in meters, last axis `[x, y, z]` (y = 0 for 2-D maps).
112
 
 
113
 
 
114
 
 
 
 
 
 
 
 
115
 
116
  ## Dataset Quantification
117
 
118
  **Current OpenH-RF release:** 15 HDF5 files; 941.96 GB (941,958,804,227 bytes) stored; root `zea_version` **0.1.5**. 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.
119
 
120
+ Data was collected from 15 participants and consists of 15 acquisitions (one per participant), containing 12,000 frames of raw RF data per acquisition. Each participant performed isometric plantarflexion contractions at 8 Kg under head up tilt of 40 degrees. Each femoral vein acquisition comprises 2 steered plane-wave transmits (`n_tx = 2`), 2048/3072 axial samples, and 192 receive channels.
121
 
122
  ## Subject Metadata
123
 
 
145
  - **Reconstruction Grid:** Cartesian coordinates mapped by a `PixelMap` representing a lateral range of $[-19, 19]\text{ mm}$ and axial depth of $[10, 60]\text{ mm}$ at $0.1\text{ mm}$ spatial resolution.
146
  3. **Clutter Filtering:** Clutter filtering is performed on the beamformed ensemble using a high-pass wall filter (normalized cut-off frequencies of 0.05 and 0.1, attenuation of 100 dB).
147
  4. **Multi-Angle Doppler Frequency Estimation:** Angle-specific Doppler frequencies are computed using an ensemble size of 64 frames with a step size of 1.
148
+ - For conventional vector velocity estimation, we used the following Tx-Rx angles: Tx: [-10°, -10°, 10°, 10°]; Rx: [-10°, 10°, -10°, 10°]
149
+ - For dealiased vector velocity estimation, we used the following Tx-Rx angles: Tx: [-10°, -10°, -10°,-10°, 10°, 10°]; Rx: [-10°, -3°, 6°, 10°, -6°, 3°,10°]
150
+ - Color Doppler map is selected as the first of these (Tx: -10°, Rx = -10°)
151
  5. **Vector Doppler Velocity Estimation:** Lateral ($v_x$) and axial ($v_z$) velocity components are computed from the multi-angle Doppler frequency estimates using GPU-accelerated least-squares estimation. Lateral ($v_x$) and axial ($v_z$) dealiased velocity components are computed from the multi-angle Doppler frequency estimates using GPU-accelerated extended least-squares estimation.
152
 
153
  The full LITMUS processing pipeline (GPU DAS beamforming + multi-angle vector Doppler) is documented by the contributors. That documentation is provided for provenance and reproducibility; it depends on the LITMUS core Python package and the raw acquisition frames, so it is not runnable from this folder alone.
 
164
 
165
  `reconstruct.py` builds a `zea.Pipeline` of DAS beamforming → envelope detection → normalization → log-compression **in code** and reconstructs a B-mode directly from `raw_data`, showing the raw-to-image flow without any config file. It also saves the pipeline to `pipeline.yaml` as a shareable recipe. Comparing the reconstruction against the stored (LITMUS) B-mode is a sanity check that the acquisition parameters and probe geometry are recorded correctly, and serves as a reproducible reference reconstruction.
166
 
167
+ When the vector-flow fields (`vector_velocity_x/z`/`vector_velocity_x/z_deal` + `power_doppler`) are present, the vector velocity field is overlayed on the stored B-mode. The overlay uses `draw_velocity_field`, a single self-contained (numpy + matplotlib) helper reproduced inside `reconstruct.py` from the LITMUS core Python package (`litmus.core_py.visualization`), so the script has no dependency on the full LITMUS GPU stack.
168
 
169
  The result is written to `reconstruct_output.png`:
170
 
waterloo-femoralvein/assets/Acq0.gif ADDED

Git LFS Details

  • SHA256: c82f220cada475b0fb384c1b34b173cf18ccf7bb45e5b28d81879edb4aa279e8
  • Pointer size: 133 Bytes
  • Size of remote file: 15.2 MB
waterloo-largeartery/assets/Acq5.gif → waterloo-femoralvein/assets/main.png RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/assets/reconstruct_output.png RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq0.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq1.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq10.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq11.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq12.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq13.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq14.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq2.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq3.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq4.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq5.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq6.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq7.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq8.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/data/Acq9.hdf5 RENAMED
File without changes
{waterloo-largeartery → waterloo-femoralvein}/pipeline.yaml RENAMED
@@ -23,9 +23,9 @@ parameters:
23
  - 0.019
24
  zlims:
25
  - 0.01
26
- - 0.045
27
  grid_size_x: 381
28
- grid_size_z: 451
29
  dynamic_range:
30
  - -50
31
  - 0
 
23
  - 0.019
24
  zlims:
25
  - 0.01
26
+ - 0.06
27
  grid_size_x: 381
28
+ grid_size_z: 501
29
  dynamic_range:
30
  - -50
31
  - 0