tue-cardiac: sync data card and gallery figures with GitHub, replace references/ with assets/

#26

Syncs the tue-cardiac card and figures on the Hub with the reviewed state on GitHub (open-h/OpenH-RF).

Adds the twelve figures the card's gallery shows: one still per transmit encoding (focused fundamental and harmonic, wide fundamental and harmonic, plane wave, diverging, Hadamard-coded, random-coded) and four cine loops. None were on the Hub, so the whole gallery was broken here.

Removes references/, which held an earlier pass of the same eight stills at 872x875. The assets/ versions replace them at 1284x907 (503x355 for the Hadamard and random-coded panels, whose grids are smaller), and the card links only assets/, so keeping both would leave the older eight orphaned. Every removed file has a same-named replacement. On GitHub, reconstruct.py now writes into assets/ rather than a separate reference/ directory, which is what let the two drift apart (tristan-deep/OpenH-RF#23).

Removes tue-cardiac/LICENSE. It is byte-identical to the repository's root LICENSE (CC BY 4.0, no team-specific terms), and no other sub-dataset carries its own copy, so it breaks the pattern for no benefit. The root licence continues to cover this data.

The card's licence section linked LICENSE, the file this PR removes; it now links the CC BY 4.0 deed directly. assets/subject-012_focused_fund_frame-000.png is the same focused-fundamental view for a second subject, kept for parity with the GitHub assets folder; the gallery does not embed it.

GitHub PRs:

Files changed: 23.

+ tue-cardiac/assets/subject-002_diverging_frame-000.png
+ tue-cardiac/assets/subject-002_focused_fund_frame-000.png
+ tue-cardiac/assets/subject-002_focused_harm_frame-000.png
+ tue-cardiac/assets/subject-002_hadamard_frame-000.png
+ tue-cardiac/assets/subject-002_planewave_frame-000.png
+ tue-cardiac/assets/subject-002_random_frame-000.png
+ tue-cardiac/assets/subject-002_wide_fund_frame-000.png
+ tue-cardiac/assets/subject-002_wide_harm_frame-000.png
+ tue-cardiac/assets/subject-012_focused_fund_frame-000.png
+ tue-cardiac/assets/subject2_focused_harm_nb80.gif
+ tue-cardiac/assets/subject4_wide_harm_nb80.gif
+ tue-cardiac/assets/subject6_focused_harm_nb80.gif
+ tue-cardiac/assets/subject9_wide_harm_nb80.gif
~ tue-cardiac/README.md
- tue-cardiac/LICENSE
- tue-cardiac/references/subject-002_diverging_frame-000.png
- tue-cardiac/references/subject-002_focused_fund_frame-000.png
- tue-cardiac/references/subject-002_focused_harm_frame-000.png
- tue-cardiac/references/subject-002_hadamard_frame-000.png
- tue-cardiac/references/subject-002_planewave_frame-000.png
- tue-cardiac/references/subject-002_random_frame-000.png
- tue-cardiac/references/subject-002_wide_fund_frame-000.png
- tue-cardiac/references/subject-002_wide_harm_frame-000.png

Update — common card layout. 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 usage example now matches the script (constants instead of CLI flags); the transmit-type gallery moves below Dataset Format.

GitHub PRs:

Files changed: 1.

~ tue-cardiac/README.md

Update — author initials from #29, rebased on main. #29 (merged into main while this PR was open) changed the BibTeX authors to Penninga, Simon W. and van Sloun, Ruud J. G.. It edited the citation in its old place, which the layout update above moves, so the two conflicted. The moved citation now carries #29's initials, and the APA line gets the same (Penninga, S. W., & van Sloun, R. J. G.) so both forms match. The card is byte-identical to datasets/tue-cardiac/README.md on GitHub main.

The PR is squashed into a single commit on top of current main, so the diff shows only the 23 tue-cardiac/ files listed above and nothing else.

GitHub PR:

Files changed: 1.

~ tue-cardiac/README.md
tristan-deep changed pull request title from tue-cardiac: sync data card and gallery figures with GitHub to tue-cardiac: sync data card and gallery figures with GitHub, replace references/ with assets/
NVIDIA org

@tristan-deep The figures are still not properly rendered here: https://huggingface.co/datasets/nvidia/OpenH-RF/blob/refs%2Fpr%2F26/tue-cardiac/README.md

I'm pretty sure they will render once they land on main! A bit annoying that we cannot easily test on the PR branches. It would be possible with a hard link but I prefer the relative paths as those will also work locally without a connection.

I also verified this. You can see an example already on main here.
And the corresponding REAMDE.md links with assets/5_long_bifur_R_0000.gif. This is linked the same way as the example you link.

NVIDIA org

@tristan-deep This PR has a conflict. can you address this?

@tristan-deep This PR has a conflict. can you address this?

Yes! Because https://huggingface.co/datasets/nvidia/OpenH-RF/discussions/29 got merged this caused conflicts. Fixing now!

NVIDIA org

🙏

wsimson changed pull request status to merged

Sign up or log in to comment