OpenwaterHealth / OpenwaterHealth/openlifu-python

Need tools to resample and transform things into simulation space

Open
#151 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
27
Forks
21
Avg merge
1d 20m
Merged PRs (30d)
6

Description

After the merging of #146 the Protocol.calc_solution function assumes that everything has been transformed and resampled into the simulation space.

We currently do this resampling and transforming in SlicerOpenLIFU.

However the user of the pure openlifu-python library will face a huge inconvenience because they compute a solution without finding some way to resample and transform things into the simulation coords. Therefore we should provide the tools to do it here, and we should consider either changing calc_solution or creating a higher level version of calc_solution that accepts volumes and targets in their native coordinates.

The transformation tools could be added as standalone tools, and then they can be called in SimSetup.setup_sim_scene since this is the function that is meant to create the the simulation scene

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading Protocol.calc_solution and SimSetup.setup_sim_scene, then review how SlicerOpenLIFU currently resamples and transforms inputs. Define whether the change belongs in standalone transformation tools or a higher-level calc_solution API. Done means native-coordinate volumes and targets can be prepared for simulation without requiring SlicerOpenLIFU.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.