Skip to content

Bump openlifu to v0.20.0#563

Merged
ebrahimebrahim merged 1 commit into
mainfrom
bump-openlifu
Apr 20, 2026
Merged

Bump openlifu to v0.20.0#563
ebrahimebrahim merged 1 commit into
mainfrom
bump-openlifu

Conversation

@ebrahimebrahim

Copy link
Copy Markdown
Contributor

This version bump will be followed by a SlicerOpenLIFU release v1.19.0, and then a custom app release v1.12.0. Release notes we can use:

This release adds a Python requirements installer with an openlifu version check in the Login module (including git+ dev-install support), surfaces firmware and SDK version labels in Sonication Control with per-TX-module detail, and renames "Reference Numbers" to "Scan IDs". The underlying openlifu library is also bumped to v0.20.0, bringing Meshroom 2025 support for photoscan reconstruction, frequency-dependent transducer sensitivity, new focal-gain and estimated-TX-temperature-rise analysis fields, and firmware I/O updates.

Notable openlifu changes coming in with this bump
  • Photoscan reconstruction updated for Meshroom 2025 compatibility (end users will need Meshroom 2025 rather than 2023.3).
  • Transducer/Element: sensitivity can now be scalar or a frequency-dependent list of (frequency, value) tuples; new crosstalk_frac / crosstalk_dist fields on Transducer; removed impulse_response / impulse_dt (serialized back-compat preserved via from_dict).
  • Protocol.calc_solution refactored: simulation logic moved into new Solution.simulate method; dropped use_gpu kwarg in favor of _force_cpu; added optional params kwarg.
  • SolutionAnalysis gains focal_gain and estimated_tx_temperature_rise_C fields (plus a model_tx_temperature_rise utility).
  • Database: removed the unused systems/ subdirectory and all *_system* methods (write_system, load_system, get_system_ids, etc.).
  • TransducerArray.get_concave_cylinder parameter handling generalized to accept heterogeneous per-module transducers and more flexible gap/dth/roc combinations.
  • LIFU firmware/IO updates (DFU support, user config, OW_CMD->OW_CTRL rename, bulk TX read) — LIFUInterface public API unchanged.
  • New xdc.util helpers for reading transducer test reports and building sensitivity/focal-gain matrices.

Not much review needed; I ran our test suite and everything passed. I tried a small workflow and it's all good.

Notable openlifu changes coming in with this bump:

- Photoscan reconstruction updated for Meshroom 2025 compatibility (end users will need Meshroom 2025 rather than 2023.3).
- Transducer/Element: `sensitivity` can now be scalar or a frequency-dependent list of (frequency, value) tuples; new `crosstalk_frac` / `crosstalk_dist` fields on Transducer; removed `impulse_response` / `impulse_dt` (serialized back-compat preserved via `from_dict`).
- `Protocol.calc_solution` refactored: simulation logic moved into new `Solution.simulate` method; dropped `use_gpu` kwarg in favor of `_force_cpu`; added optional `params` kwarg.
- `SolutionAnalysis` gains `focal_gain` and `estimated_tx_temperature_rise_C` fields (plus a `model_tx_temperature_rise` utility).
- `Database`: removed the unused `systems/` subdirectory and all `*_system*` methods (`write_system`, `load_system`, `get_system_ids`, etc.).
- `TransducerArray.get_concave_cylinder` parameter handling generalized to accept heterogeneous per-module transducers and more flexible gap/dth/roc combinations.
- LIFU firmware/IO updates (DFU support, user config, OW_CMD->OW_CTRL rename, bulk TX read) — `LIFUInterface` public API unchanged.
- New `xdc.util` helpers for reading transducer test reports and building sensitivity/focal-gain matrices.

@sadhana-r sadhana-r left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good!

@ebrahimebrahim ebrahimebrahim merged commit 7f2cb46 into main Apr 20, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants