OpenH-RF early access

Co-authored-by: tristan-deep <tristan-deep@users.noreply.huggingface.co>
Co-authored-by: swpenninga <swpenninga@users.noreply.huggingface.co>

LICENSE

@@ -0,0 +1,395 @@
+Attribution 4.0 International
+
+=======================================================================
+
+Creative Commons Corporation ("Creative Commons") is not a law firm and
+does not provide legal services or legal advice. Distribution of
+Creative Commons public licenses does not create a lawyer-client or
+other relationship. Creative Commons makes its licenses and related
+information available on an "as-is" basis. Creative Commons gives no
+warranties regarding its licenses, any material licensed under their
+terms and conditions, or any related information. Creative Commons
+disclaims all liability for damages resulting from their use to the
+fullest extent possible.
+
+Using Creative Commons Public Licenses
+
+Creative Commons public licenses provide a standard set of terms and
+conditions that creators and other rights holders may use to share
+original works of authorship and other material subject to copyright
+and certain other rights specified in the public license below. The
+following considerations are for informational purposes only, are not
+exhaustive, and do not form part of our licenses.
+
+     Considerations for licensors: Our public licenses are
+     intended for use by those authorized to give the public
+     permission to use material in ways otherwise restricted by
+     copyright and certain other rights. Our licenses are
+     irrevocable. Licensors should read and understand the terms
+     and conditions of the license they choose before applying it.
+     Licensors should also secure all rights necessary before
+     applying our licenses so that the public can reuse the
+     material as expected. Licensors should clearly mark any
+     material not subject to the license. This includes other CC-
+     licensed material, or material used under an exception or
+     limitation to copyright. More considerations for licensors:
+    wiki.creativecommons.org/Considerations_for_licensors
+
+     Considerations for the public: By using one of our public
+     licenses, a licensor grants the public permission to use the
+     licensed material under specified terms and conditions. If
+     the licensor's permission is not necessary for any reason--for
+     example, because of any applicable exception or limitation to
+     copyright--then that use is not regulated by the license. Our
+     licenses grant only permissions under copyright and certain
+     other rights that a licensor has authority to grant. Use of
+     the licensed material may still be restricted for other
+     reasons, including because others have copyright or other
+     rights in the material. A licensor may make special requests,
+     such as asking that all changes be marked or described.
+     Although not required by our licenses, you are encouraged to
+     respect those requests where reasonable. More considerations
+     for the public:
+    wiki.creativecommons.org/Considerations_for_licensees
+
+=======================================================================
+
+Creative Commons Attribution 4.0 International Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree
+to be bound by the terms and conditions of this Creative Commons
+Attribution 4.0 International Public License ("Public License"). To the
+extent this Public License may be interpreted as a contract, You are
+granted the Licensed Rights in consideration of Your acceptance of
+these terms and conditions, and the Licensor grants You such rights in
+consideration of benefits the Licensor receives from making the
+Licensed Material available under these terms and conditions.
+
+
+Section 1 -- Definitions.
+
+  a. Adapted Material means material subject to Copyright and Similar
+     Rights that is derived from or based upon the Licensed Material
+     and in which the Licensed Material is translated, altered,
+     arranged, transformed, or otherwise modified in a manner requiring
+     permission under the Copyright and Similar Rights held by the
+     Licensor. For purposes of this Public License, where the Licensed
+     Material is a musical work, performance, or sound recording,
+     Adapted Material is always produced where the Licensed Material is
+     synched in timed relation with a moving image.
+
+  b. Adapter's License means the license You apply to Your Copyright
+     and Similar Rights in Your contributions to Adapted Material in
+     accordance with the terms and conditions of this Public License.
+
+  c. Copyright and Similar Rights means copyright and/or similar rights
+     closely related to copyright including, without limitation,
+     performance, broadcast, sound recording, and Sui Generis Database
+     Rights, without regard to how the rights are labeled or
+     categorized. For purposes of this Public License, the rights
+     specified in Section 2(b)(1)-(2) are not Copyright and Similar
+     Rights.
+
+  d. Effective Technological Measures means those measures that, in the
+     absence of proper authority, may not be circumvented under laws
+     fulfilling obligations under Article 11 of the WIPO Copyright
+     Treaty adopted on December 20, 1996, and/or similar international
+     agreements.
+
+  e. Exceptions and Limitations means fair use, fair dealing, and/or
+     any other exception or limitation to Copyright and Similar Rights
+     that applies to Your use of the Licensed Material.
+
+  f. Licensed Material means the artistic or literary work, database,
+     or other material to which the Licensor applied this Public
+     License.
+
+  g. Licensed Rights means the rights granted to You subject to the
+     terms and conditions of this Public License, which are limited to
+     all Copyright and Similar Rights that apply to Your use of the
+     Licensed Material and that the Licensor has authority to license.
+
+  h. Licensor means the individual(s) or entity(ies) granting rights
+     under this Public License.
+
+  i. Share means to provide material to the public by any means or
+     process that requires permission under the Licensed Rights, such
+     as reproduction, public display, public performance, distribution,
+     dissemination, communication, or importation, and to make material
+     available to the public including in ways that members of the
+     public may access the material from a place and at a time
+     individually chosen by them.
+
+  j. Sui Generis Database Rights means rights other than copyright
+     resulting from Directive 96/9/EC of the European Parliament and of
+     the Council of 11 March 1996 on the legal protection of databases,
+     as amended and/or succeeded, as well as other essentially
+     equivalent rights anywhere in the world.
+
+  k. You means the individual or entity exercising the Licensed Rights
+     under this Public License. Your has a corresponding meaning.
+
+
+Section 2 -- Scope.
+
+  a. License grant.
+
+       1. Subject to the terms and conditions of this Public License,
+          the Licensor hereby grants You a worldwide, royalty-free,
+          non-sublicensable, non-exclusive, irrevocable license to
+          exercise the Licensed Rights in the Licensed Material to:
+
+            a. reproduce and Share the Licensed Material, in whole or
+               in part; and
+
+            b. produce, reproduce, and Share Adapted Material.
+
+       2. Exceptions and Limitations. For the avoidance of doubt, where
+          Exceptions and Limitations apply to Your use, this Public
+          License does not apply, and You do not need to comply with
+          its terms and conditions.
+
+       3. Term. The term of this Public License is specified in Section
+          6(a).
+
+       4. Media and formats; technical modifications allowed. The
+          Licensor authorizes You to exercise the Licensed Rights in
+          all media and formats whether now known or hereafter created,
+          and to make technical modifications necessary to do so. The
+          Licensor waives and/or agrees not to assert any right or
+          authority to forbid You from making technical modifications
+          necessary to exercise the Licensed Rights, including
+          technical modifications necessary to circumvent Effective
+          Technological Measures. For purposes of this Public License,
+          simply making modifications authorized by this Section 2(a)
+          (4) never produces Adapted Material.
+
+       5. Downstream recipients.
+
+            a. Offer from the Licensor -- Licensed Material. Every
+               recipient of the Licensed Material automatically
+               receives an offer from the Licensor to exercise the
+               Licensed Rights under the terms and conditions of this
+               Public License.
+
+            b. No downstream restrictions. You may not offer or impose
+               any additional or different terms or conditions on, or
+               apply any Effective Technological Measures to, the
+               Licensed Material if doing so restricts exercise of the
+               Licensed Rights by any recipient of the Licensed
+               Material.
+
+       6. No endorsement. Nothing in this Public License constitutes or
+          may be construed as permission to assert or imply that You
+          are, or that Your use of the Licensed Material is, connected
+          with, or sponsored, endorsed, or granted official status by,
+          the Licensor or others designated to receive attribution as
+          provided in Section 3(a)(1)(A)(i).
+
+  b. Other rights.
+
+       1. Moral rights, such as the right of integrity, are not
+          licensed under this Public License, nor are publicity,
+          privacy, and/or other similar personality rights; however, to
+          the extent possible, the Licensor waives and/or agrees not to
+          assert any such rights held by the Licensor to the limited
+          extent necessary to allow You to exercise the Licensed
+          Rights, but not otherwise.
+
+       2. Patent and trademark rights are not licensed under this
+          Public License.
+
+       3. To the extent possible, the Licensor waives any right to
+          collect royalties from You for the exercise of the Licensed
+          Rights, whether directly or through a collecting society
+          under any voluntary or waivable statutory or compulsory
+          licensing scheme. In all other cases the Licensor expressly
+          reserves any right to collect such royalties.
+
+
+Section 3 -- License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the
+following conditions.
+
+  a. Attribution.
+
+       1. If You Share the Licensed Material (including in modified
+          form), You must:
+
+            a. retain the following if it is supplied by the Licensor
+               with the Licensed Material:
+
+                 i. identification of the creator(s) of the Licensed
+                    Material and any others designated to receive
+                    attribution, in any reasonable manner requested by
+                    the Licensor (including by pseudonym if
+                    designated);
+
+                ii. a copyright notice;
+
+               iii. a notice that refers to this Public License;
+
+                iv. a notice that refers to the disclaimer of
+                    warranties;
+
+                 v. a URI or hyperlink to the Licensed Material to the
+                    extent reasonably practicable;
+
+            b. indicate if You modified the Licensed Material and
+               retain an indication of any previous modifications; and
+
+            c. indicate the Licensed Material is licensed under this
+               Public License, and include the text of, or the URI or
+               hyperlink to, this Public License.
+
+       2. You may satisfy the conditions in Section 3(a)(1) in any
+          reasonable manner based on the medium, means, and context in
+          which You Share the Licensed Material. For example, it may be
+          reasonable to satisfy the conditions by providing a URI or
+          hyperlink to a resource that includes the required
+          information.
+
+       3. If requested by the Licensor, You must remove any of the
+          information required by Section 3(a)(1)(A) to the extent
+          reasonably practicable.
+
+       4. If You Share Adapted Material You produce, the Adapter's
+          License You apply must not prevent recipients of the Adapted
+          Material from complying with this Public License.
+
+
+Section 4 -- Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that
+apply to Your use of the Licensed Material:
+
+  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
+     to extract, reuse, reproduce, and Share all or a substantial
+     portion of the contents of the database;
+
+  b. if You include all or a substantial portion of the database
+     contents in a database in which You have Sui Generis Database
+     Rights, then the database in which You have Sui Generis Database
+     Rights (but not its individual contents) is Adapted Material; and
+
+  c. You must comply with the conditions in Section 3(a) if You Share
+     all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not
+replace Your obligations under this Public License where the Licensed
+Rights include other Copyright and Similar Rights.
+
+
+Section 5 -- Disclaimer of Warranties and Limitation of Liability.
+
+  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
+     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
+     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
+     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
+     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
+     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
+     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
+     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
+     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
+
+  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
+     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
+     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
+     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
+     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
+     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
+     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
+     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
+     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
+
+  c. The disclaimer of warranties and limitation of liability provided
+     above shall be interpreted in a manner that, to the extent
+     possible, most closely approximates an absolute disclaimer and
+     waiver of all liability.
+
+
+Section 6 -- Term and Termination.
+
+  a. This Public License applies for the term of the Copyright and
+     Similar Rights licensed here. However, if You fail to comply with
+     this Public License, then Your rights under this Public License
+     terminate automatically.
+
+  b. Where Your right to use the Licensed Material has terminated under
+     Section 6(a), it reinstates:
+
+       1. automatically as of the date the violation is cured, provided
+          it is cured within 30 days of Your discovery of the
+          violation; or
+
+       2. upon express reinstatement by the Licensor.
+
+     For the avoidance of doubt, this Section 6(b) does not affect any
+     right the Licensor may have to seek remedies for Your violations
+     of this Public License.
+
+  c. For the avoidance of doubt, the Licensor may also offer the
+     Licensed Material under separate terms or conditions or stop
+     distributing the Licensed Material at any time; however, doing so
+     will not terminate this Public License.
+
+  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
+     License.
+
+
+Section 7 -- Other Terms and Conditions.
+
+  a. The Licensor shall not be bound by any additional or different
+     terms or conditions communicated by You unless expressly agreed.
+
+  b. Any arrangements, understandings, or agreements regarding the
+     Licensed Material not stated herein are separate from and
+     independent of the terms and conditions of this Public License.
+
+
+Section 8 -- Interpretation.
+
+  a. For the avoidance of doubt, this Public License does not, and
+     shall not be interpreted to, reduce, limit, restrict, or impose
+     conditions on any use of the Licensed Material that could lawfully
+     be made without permission under this Public License.
+
+  b. To the extent possible, if any provision of this Public License is
+     deemed unenforceable, it shall be automatically reformed to the
+     minimum extent necessary to make it enforceable. If the provision
+     cannot be reformed, it shall be severed from this Public License
+     without affecting the enforceability of the remaining terms and
+     conditions.
+
+  c. No term or condition of this Public License will be waived and no
+     failure to comply consented to unless expressly agreed to by the
+     Licensor.
+
+  d. Nothing in this Public License constitutes or may be interpreted
+     as a limitation upon, or waiver of, any privileges and immunities
+     that apply to the Licensor or You, including from the legal
+     processes of any jurisdiction or authority.
+
+
+=======================================================================
+
+Creative Commons is not a party to its public
+licenses. Notwithstanding, Creative Commons may elect to apply one of
+its public licenses to material it publishes and in those instances
+will be considered the “Licensor.” The text of the Creative Commons
+public licenses is dedicated to the public domain under the CC0 Public
+Domain Dedication. Except for the limited purpose of indicating that
+material is shared under a Creative Commons public license or as
+otherwise permitted by the Creative Commons policies published at
+creativecommons.org/policies, Creative Commons does not authorize the
+use of the trademark "Creative Commons" or any other trademark or logo
+of Creative Commons without its prior written consent including,
+without limitation, in connection with any unauthorized modifications
+to any of its public licenses or any other arrangements,
+understandings, or agreements concerning use of licensed material. For
+the avoidance of doubt, this paragraph does not form part of the
+public licenses.
+
+Creative Commons may be contacted at creativecommons.org.

README.md

@@ -0,0 +1,73 @@
+---
+license: cc-by-4.0
+---
+
+# OpenH-RF
+
+## Dataset Description
+
+OpenH-RF is a community-driven dataset initiative building the open, shared foundation needed to train and evaluate AI models built on pre-beamformed (channel capture) medical ultrasound measurements.
+
+This dataset is a collection of RF samples and metadata in the [`zea` file format](https://github.com/tue-bmd/zea) from a variety of tasks and applications, including ultrasound localization microscopy, ultrasound computer tomography, b-mode, flow imaging and more.
+
+This dataset is ready for commercial or non-commercial uses.
+
+## Dataset Owner
+
+NVIDIA Corporation
+
+## Contributing Organizations
+
+NVIDIA, Stanford University, Eindhoven University of Technology, Tel Aviv University, Siemens Healthineers, Resolve Stroke, University of British Columbia, KAIST, Barreleye Inc., Seoul National University Bundang Hospital, us4us Ltd., University of Colorado Boulder, Vanderbilt University, University of North Carolina at Chapel Hill, Weizmann Institute of Science, University of Oslo, Technical University of Munich, Politecnico di Torino, University of Twente, Weill Cornell Medicine, Worcester Polytechnic Institute, University of Strasbourg, Concordia University, Mosaic Intelligence, PATH Lab - Technion - Israel Institute of Technology, University of Waterloo, Dartmouth College, Provost Ultrasound Lab
+
+## Dataset Stewardship
+
+OpenH-RF community & Steering Group
+
+## Dataset Creation Date
+
+September 2026
+
+## Versioning
+
+v1.0.0
+
+**Previous Version(s):** no previous version
+
+## License/Terms of Use
+
+CC-BY-4.0
+
+## Intended Usage
+
+Researchers and builders interested in training ultrasound reconstruction models, RF world foundation models, or RF language models.
+
+## Dataset Characterization
+
+### Data Collection Method
+
+Hybrid: Manually-Collected, Automatic/Sensors, Synthetic
+
+### Labeling Method
+
+Hybrid: Manually-Labeled, Automatic/Sensors, Synthetic
+
+## Dataset Format
+
+`zea` HDF5 format >= 0.1.4. This release contains files with `zea_version` 0.1.4, 0.1.5, and 0.1.6.
+
+Channel capture data and related meta data are saved in HDF5 data files using a specification defined for the `zea` library.
+
+## Dataset Quantification
+
+32 sub-datasets contain 11,491 HDF5 files totaling 38.4 TB (38,366,766,058,064 bytes; 34.9 TiB) of stored HDF5 data. These sizes count the stored files, including metadata and other embedded arrays; they are not decoded RF array sizes or original-source download sizes. TB uses decimal units (10^12 bytes), and TiB uses binary units (2^40 bytes).
+
+## Reference(s)
+
+https://github.com/open-h/OpenH-RF
+
+## Ethical Considerations
+
+NVIDIA believes Trustworthy AI is a shared responsibility and we have established policies and practices to enable development for a wide array of AI applications. Developers should work with their internal developer teams to ensure this dataset meets requirements for the relevant industry and use case and addresses unforeseen product misuse.
+
+Please report quality, risk, security vulnerabilities or NVIDIA AI Concerns [here](https://www.nvidia.com/en-us/support/submit-security-vulnerability/).

colorado-boulder/README.md

@@ -0,0 +1,174 @@
+---
+pretty_name: "OpenH-RF — Tracked Swept Synthetic Aperture 3D Phantom Dataset"
+license: cc-by-4.0
+task_categories:
+  - generalized-reconstruction
+tags:
+  - ultrasound
+  - rf
+  - openh-rf
+  - 3d
+language:
+  - en
+size_categories:
+  - n<1K
+---
+
+# Tracked Swept Synthetic Aperture 3D Phantom Ultrasound Dataset
+
+## Dataset Description
+
+This dataset contains tracked swept synthetic aperture (SSA) ultrasound acquisitions of a 3D ultrasound imaging phantom. The data were acquired using a Verasonics Vantage research ultrasound system with a P4-2 phased array transducer.
+
+The dataset includes raw RF channel data, acquisition parameters, probe geometry, transmit information, and frame-wise tracked probe pose metadata. Its purpose is to provide a reproducible example of motion-compensated SSA reconstruction from raw channel data using the zea/OpenH-RF data format.
+
+This dataset contains phantom data only. It does not contain human subject data, animal data, or protected health information (PHI).
+
+## Dataset Contributor(s)
+
+**Contributing organization:** University of Colorado Boulder, Bottenus Lab
+
+**Contributors:**
+
+- Anet Sanchez
+- Nick Bottenus
+
+## Dataset Creation Date
+
+06/24/2025
+
+## License / Terms of Use
+
+This dataset is released under the Creative Commons Attribution 4.0 International License (CC BY 4.0).
+
+The contributed data consist exclusively of phantom ultrasound acquisitions and are cleared for release under CC BY 4.0. Patient consent, clinical data-use agreements, and PHI de-identification are not applicable because the dataset does not contain human subject data.
+
+## Intended Usage
+
+This dataset is intended for research on generalized ultrasound reconstruction, with a particular focus on tracked swept synthetic aperture imaging, motion-compensated beamforming, coherent compounding, and ultrasound image-quality evaluation.
+
+For SSA reconstruction, each raw RF frame is beamformed using its corresponding tracked transducer pose. The resulting beamformed IQ frames are placed on a common reconstruction grid and coherently summed to synthesize a larger effective aperture. Because the reconstruction relies on coherent compounding, summation is performed before envelope detection, normalization, and log compression.
+
+## Dataset Characterization
+
+- **Data Collection Method:** Phantom ultrasound acquisition
+- **Labeling Method:** N/A; no manual labels or segmentation masks are provided
+- **Acquisition System:** Verasonics Vantage research ultrasound scanner with a Verasonics P4-2 phased array transducer
+
+### Acquisition Details
+
+The transducer was manually swept over the phantom field of view while diverging-wave transmissions were acquired at 400 Hz. All 64 array elements were used on receive.
+
+Diverging waves were generated using a negative virtual source with the 20 central array elements active on transmit.
+
+The transducer was optically tracked using an NDI Polaris Vega® XT optical tracking system manufactured by Northern Digital Inc., Ontario, Canada.
+
+### Probe and Geometry
+
+The acquisition used a Verasonics P4-2 phased array transducer with 64 elements. The center frequency stored in the acquisition and used for reconstruction is 2.5 MHz.
+
+The probe geometry, transmit origins, transmit delays, transmit apodization, and other acquisition parameters are stored in the zea/OpenH-RF file. Frame-wise probe translations and rotations are stored using the native `metadata/probe_pose` structure.
+
+## Dataset Format
+
+The dataset is distributed in the zea/OpenH-RF HDF5 format.
+
+Each file includes:
+
+- Raw RF channel data
+- Sampling and center frequencies
+- Transmit delays and apodization
+- Transmit origins
+- Probe geometry
+- Sound-speed information
+- Frame-wise tracked probe translations
+- Frame-wise tracked probe rotations
+
+The stored RF channel data have not been beamformed, envelope detected, normalized, or log compressed. The accompanying reconstruction pipeline performs these processing steps.
+
+## Dataset Quantification
+
+**Current OpenH-RF release:** 62 HDF5 files; 16.04 GB (16,037,117,952 bytes) stored; root `zea_version` **0.1.6**. 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.
+
+- **Number of phantom objects:** 1
+- **Number of acquisitions:** 10
+- **Number of RF frames per acquisition:** 1200
+- **Number of transmit events per frame:** 1
+- **Number of receive elements:** 64
+- **Number of active transmit elements:** 20
+
+### Per-File Feature Summary
+
+| Feature | Shape | Data type | Units | Description |
+|---|---:|---|---|---|
+| Raw RF data | `n_frames × n_tx × n_ax × n_elements × n_channels` | `float32` | acquisition units | Raw RF channel measurements |
+| Probe translation | `n_frames × 3` | `float32` | m | Frame-wise tracked probe position |
+| Probe rotation | `n_frames × 4` | `float32` | unit quaternion | Frame-wise tracked probe orientation in `xyzw` order |
+| Probe geometry | `64 × 3` | `float32` | m | Array-element coordinates |
+| Transmit origins | `n_tx × 3` | `float32` | m | Diverging-wave virtual-source coordinates |
+| Transmit delays | `n_tx × 64` | `float32` | s | Per-element transmit delays |
+| Transmit apodization | `n_tx × 64` | `float32` | unitless | Per-element transmit activation and weighting |
+
+## Subject Metadata
+
+### Metadata Schema Migration
+
+The zea 0.1.6 migration uses these approved metadata locations:
+
+| Legacy location | Canonical location |
+|---|---|
+| Dataset `metadata/subject_id` | Dataset `metadata/subject/id` |
+| Dataset `metadata/subject_type` | Dataset `metadata/subject/type` |
+| Dataset `metadata/us_machine` | Root HDF5 attribute `us_machine` |
+
+Read the machine name with `f.attrs["us_machine"]`, not `f["us_machine"]`.
+Subject values and their existing attributes are preserved. The machine
+string is preserved; migration stops for review if its legacy dataset has
+attributes that cannot be represented without loss. No numerical arrays are
+rescaled or otherwise changed by these relocations.
+
+The three-field pilot passed full array and metadata parity checks with the
+approved description changes and `transmit_only=False` default. Full-release
+migration is still pending. Replacement files are uploaded only after
+per-file validation; readers supporting both revisions should check the
+canonical locations first, then the legacy locations.
+
+
+This dataset contains one 3D ultrasound imaging phantom.
+
+- **Subject type:** 3D phantom
+- **Anatomical region:** Not applicable
+- **Human participants:** None
+- **Animal subjects:** None
+- **Protected health information:** None
+- **Scanner:** Verasonics Vantage
+- **Probe:** Verasonics P4-2 phased array
+
+## Data Validation
+
+The submission includes a `zea.Pipeline` that reconstructs a representative tracked SSA B-mode image from the raw RF channel data.
+
+The pipeline performs:
+
+1. Frame-wise demodulation
+2. Application of the tracked probe pose
+3. Delay-and-sum beamforming onto a common reconstruction grid
+4. Coherent summation of the beamformed IQ frames
+5. Envelope detection
+6. Normalization
+7. Log compression
+
+The reconstruction is defined in `pipeline.yaml` and executed using `reconstruct.py`. A representative reconstructed B-mode image is included with the dataset.
+
+## Known Issues
+
+- Optical tracking measurements may contain small position and orientation uncertainties.
+- Reconstruction quality depends on tracking calibration accuracy and coherent alignment between frames.
+
+
+## Ethical Considerations
+
+This dataset contains phantom ultrasound data only. It does not contain human participants, animal subjects, personal identifiers, clinical records, or protected health information.
+
+Human-subject consent and institutional review board approval are therefore not applicable.
+

colorado-boulder/Sub-dataset-1/sub-phantom2d_01_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9cb8a50f80303ca7bdc1698cd80d824f50c983a12f91203ccf56a915dbe83d7f
+size 236257280

colorado-boulder/Sub-dataset-1/sub-phantom2d_02_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b5a7a8e5cb083d9684f3a010b743a75367d5dc5e710e16691bf574a41a79dea8
+size 236257280

colorado-boulder/Sub-dataset-1/sub-phantom2d_03_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:aadf5e7e03154c750c3ae28722d5fe709153d915ba32bac6f3b7d145991c2650
+size 236257280

colorado-boulder/Sub-dataset-1/sub-phantom2d_04_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0e5b2c3fcac94a661023d9a94fd6cfa827b1396e4bb2cae0a501f35fead45554
+size 236257280

colorado-boulder/Sub-dataset-1/sub-phantom2d_05_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:76822939fb19f469d3706ac9a294f9aa1e4c99c9afe5a4c32778daa5cbd1b0ec
+size 236257280

colorado-boulder/Sub-dataset-1/sub-phantom2d_06_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:14c2fbd927ce3d8abd8a2ea46e692a31f8bc335c0d008a8555d80de1545066ce
+size 252248064

colorado-boulder/Sub-dataset-1/sub-phantom2d_07_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fd57d5971e7a7fe9a7dd9bef46f02cdc00ee6f975ed07d4f20eb4d7a1ea9dd46
+size 258670592

colorado-boulder/Sub-dataset-1/sub-phantom2d_08_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:af0dbec89c0c927229c1e1ff34db1f76680dbd34a7f476757a19d0e3b0505741
+size 250281984

colorado-boulder/Sub-dataset-1/sub-phantom2d_09_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b8a7d38ee5ebce2c72ca01e453bf22333baa112210229c3cf6278f2f5dc7b94f
+size 236257280

colorado-boulder/Sub-dataset-1/sub-phantom2d_10_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7498192067c47824384189917711167e37c0d76a657d05f678ec87792cc16b0d
+size 419758080

colorado-boulder/Sub-dataset-2/sub-phantom3d_01_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:65b7d52339e806421988de85eb71bed8b37b22e5670f170e934420d5a892a83d
+size 236257280

colorado-boulder/Sub-dataset-2/sub-phantom3d_02_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a59c683e85cfeb978f3a4634973b5a94304fed8f292424d26f05d312e141c304
+size 236257280

colorado-boulder/Sub-dataset-2/sub-phantom3d_03_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6d28489774b2e700322bd14adc18ab6ab89ca3cef6e97cc8c891224d003612f2
+size 236257280

colorado-boulder/Sub-dataset-2/sub-phantom3d_04_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:90cbaa0e0d9a7cc30920f11d1507bbcc40e58e91dd2a5f16a72177bc9572ff65
+size 236257280

colorado-boulder/Sub-dataset-2/sub-phantom3d_05_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:51cfff5cc6cfbd10331a6295fd3b81d82563f8a0c8f55666a3a6e3f71b049b9b
+size 236257280

colorado-boulder/Sub-dataset-2/sub-phantom3d_06_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0e26bde33eb021678c6a61a81f4b7afe6bc473c4a7a36da8a511cb2b2546973c
+size 236257280

colorado-boulder/Sub-dataset-2/sub-phantom3d_07_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7c7259ec1a2738d9286da33a15a4a52bf76f5fde08cad62006f40b2264093881
+size 236257280

colorado-boulder/Sub-dataset-2/sub-phantom3d_08_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0118eda1acc7fa3657ff3e884e5f625abd9614d4cb776195e18107b2f0e9427f
+size 236257280

colorado-boulder/Sub-dataset-2/sub-phantom3d_09_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6c39c1da6ebe4cc7f7b6fe5882ada6fbf31c214c261f6b6818b2f7fa74b6c039
+size 236257280

colorado-boulder/Sub-dataset-2/sub-phantom3d_10_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:af89af25ab1b18ff1bc4df9b7c3fb565ca700565c88576d2913477a25240cf3a
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_01_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:64f5a6944a619135a02a96c8485a99cea019f6a522a2036766e2ae99043ebe3b
+size 314900480

colorado-boulder/Sub-dataset-3/sub-invivo_02_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d1ed4d8436c6a8cd6cd71e3e70e3dc61e121f38de8ef793bb56ac8ac32a9ebde
+size 314900480

colorado-boulder/Sub-dataset-3/sub-invivo_03_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8ac023f06e4af69304e5859f5acddba75135895244c10c69ec5c7059dadd34ad
+size 314900480

colorado-boulder/Sub-dataset-3/sub-invivo_04_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d17afcc097be998c50d796549c5c5b7128d07e167e55baeaa7478731ec806993
+size 293339136

colorado-boulder/Sub-dataset-3/sub-invivo_05_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:92601e96792c535a8f89f7adc2211ab52cacf1daec82c54c9bb50db14a9a6e26
+size 274726912

colorado-boulder/Sub-dataset-3/sub-invivo_06_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bd92e63ae48f3bb78da9fc170df56b02bb558274808ca088d6e50e211672b11c
+size 301268992

colorado-boulder/Sub-dataset-3/sub-invivo_07_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5f795ef4da44f1d5156fd8fb18ba6ac2af43213a6d9652c16b7ba4d8e7175157
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_08_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:baa59370791bd031e8bc5e92a65cfc9cf09ff46500c3856e9ae63605e55f161f
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_09_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4fe7db4d3a2348b1172717bc63226ffc01ded12de4c4670c66581b4a959bf10a
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_10_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a3d9cafc988967635c51700f1137a9cf494db44ab24786b567b27d220da6c283
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_11_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5446ae705a1337889dcce4be08c5b97c7bbbce8c7ebafe9f455d34fbb5b935da
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_12_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:57b61241ad7becd146ed3510760b8702bff464a51dfcda72cb1280ac49fc3e44
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_13_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2204aad0f059817978600f1c02c8e5ceb51b1bf37e836ca6f983a513b062d323
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_14_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fb2cad4892fca51a4ae85741bbf82eef3029140dfaf4af908c1938c1cb4423c1
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_15_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b75bdd3c1a5f8f2f0f025983d8201d89eefd08e95174245c7f2e1c6b9da51c1a
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_16_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fe721d362b6ef5958001a9bb78c0f17fbc70492bf836051017ee300110697f09
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_17_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4ac0a73568139be7580921355a6c6b92aedf75b23d89d058b37bca3141bb8851
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_18_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5a5ba53e5ea5421a88f212cb7a0b9f4bd142d981d3a6a5782568cc31e366b2ca
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_19_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:73c03b097dd70b0f4da5c8fcfe411e581bb7b698936a2295c304b8f72a87352e
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_20_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7c1707e1ef23567eeb86931b57cfc155f06a41cfb2977097a05ec50c35130b9d
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_21_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:dcb1f2123b5889367af2d2f4aff2b13a1cab9da05642df67eb241207a0ca3e03
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_22_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2899251027e90d250e4ee76a567642faae3e5db0b0ce782f0ec4c6c413e0e6aa
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_23_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:16280baeb921e02908b3ed7651fa78c672b8445175a8e1d6a9b7c04717ccfaae
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_24_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1435848a89b8fddcfdfc07fc443373e6b6a2c2c5dfe3d52d56739420307dd12a
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_25_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6192adf9c73c104766ed1cf4ba7532ef492b1cdd681ceff92c633d54527fb168
+size 236257280

colorado-boulder/Sub-dataset-3/sub-invivo_26_tracked-ssa.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5d920b1fa63392aaa4dcf066240f066868f38080a978d73c9a2bedf0bc73454e
+size 236257280