Skip to content

New extension "EVARSim", a positioning simulator for endovascular devices. #2190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 3, 2025

Conversation

rwic
Copy link
Contributor

@rwic rwic commented Jul 27, 2025

New extension

Tier 1

Any extension that is listed in the Extensions Catalog must fulfill these requirements.

  • Repository name is Slicer+ExtensionName (except if the repository that hosts the extension can be also used without Slicer)
  • Repository is associated with 3d-slicer-extension GitHub topic so that it is listed here. To edit topics, click the settings icon in the right side of "About" section header and enter 3d-slicer-extension in "Topics" and click "Save changes". To learn more about topics, read https://help.github.com/en/articles/about-topics
  • Extension description summarizes in 1-2 sentences what the extension is usable (should be understandable for non-experts)
  • Any known related patents must be mentioned in the extension description.
  • LICENSE.txt is present in the repository root and the name of the license is mentioned in extension homepage. We suggest you use a permissive license that includes patent and contribution clauses. This will help protect developers and ensure the code remains freely available. MIT (https://choosealicense.com/licenses/mit/) or Apache (https://choosealicense.com/licenses/apache-2.0/) license is recommended. Read here to learn more about licenses. If source code license is more restrictive for users than MIT, BSD, Apache, or 3D Slicer license then describe the reason for the license choice and include the name of the used license in the extension description.
  • Extension URL and revision (scmurl, scmrevision) is correct, consider using a branch name (main, release, ...) instead of a specific git hash to avoid re-submitting pull request whenever the extension is updated
  • Extension icon URL is correct (do not use the icon's webpage but the raw data download URL that you get from the download button - it should look something like this: https://raw.githubusercontent.com/user/repo/main/SomeIcon.png)
  • Screenshot URLs (screenshoturls) are correct, contains at least one
  • Content of submitted json file is consistent with the top-level CMakeLists.txt file in the repository (dependencies, etc. are the same)
  • Homepage URL points to valid webpage containing the following:
    • Extension name
    • Short description: 1-2 sentences, which summarizes what the extension is usable for
    • At least one nice, informative image, that illustrates what the extension can do. It may be a screenshot.
    • Description of contained modules: at one sentence for each module
    • Publication: link to publication and/or to PubMed reference (if available)
  • Hide unused github features (such as Wiki, Projects, and Discussions, Releases, Packages) in the repository to reduce noise/irrelevant information:
    • Click Settings and in repository settings uncheck Wiki, Projects, and Discussions (if they are currently not used).
    • Click the settings icon next to About in the top-right corner of the repository main page and uncheck Releases and Packages (if they are currently not used)
  • The extension is safe:
    • Does not include or download binaries from unreliable sources
    • Does not send any information anywhere without user consent (explicit opt-in is required)

Tier 3

Community-supported extensions.

  • Extension has a reasonable name (not too general, not too narrow, suggests what the extension is for)
  • Documentation, tutorial, and test data are provided for most modules. A tutorial provides step-by-step description of at least the most typical use case, include a few screenshots. Any sample data sets that is used in tutorials must be registered with the Sample Data module to provide easy access to the user.
  • Follows programming and user interface conventions of 3D Slicer (e.g., GUI and logic are separated, usage of popups is minimized, no unnecessary custom GUI styling, etc.)
  • The extension can be successfully built and packaged on all supported platforms (Windows, macOS, Linux)
  • Maintainers respond to issues and pull request submitted to the extension's repository.
  • Maintainers respond to questions directly addressed to him/her via @mention on the Slicer Forum.
  • Permissive license is used for the main functions of the extension (recommended Apache or MIT). The extension can provide additional functionality in optional components that are distributed with non-permissive license, but the user has to explicitly approve those before using them (e.g., a pop-up can be displayed that explains the licensing terms and the user has to acknowledge them to proceed).
  • All requirements of tiers < 3.

Tier 5

Critically important extensions, supported by Slicer core developers. New Slicer Stable Release is released only if all Tier 5 extension packages are successfully created on all supported platforms.

  • Slicer core developers accept the responsibility of fixing any issues caused by Slicer core changes; at least one Slicer core developer (anyone who has commit right to Slicer core) must be granted commit right to the extension's repository.
  • Automated tests for all critical features.
  • Maintainers respond to questions related to the extension on the Slicer Forum.
  • All requirements of tiers < 5.

rwic added 3 commits July 27, 2025 10:28
Slicer 3D extension to simulate endovascular devices in endocascular aortic repair (EVAR).
scm_revision updated
Copy link
Member

@pieper pieper left a comment

Choose a reason for hiding this comment

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

From a quick look I think this is good.

I used to work in this field, so I can think of lots of features you might want to add, but I don't think they are needed at this point. Do you plan to develop this module further? If so I'd be happy to discuss.

@rwic
Copy link
Contributor Author

rwic commented Jul 31, 2025 via email

@pieper
Copy link
Member

pieper commented Jul 31, 2025

Great, yes, working with manufacturers to get designs accurately included in the module makes sense if they are willing to cooperate.

In terms of other features to consider, integrating this with VMTK could be very helpful for things like iliac
tortuosity calculations would be good. Also there's a lot of potential for using the various segmentation tools to automatically identify anatomy of interest, such as renal arteries, but also training custom models that could identify plaques and thrombus or even identifying leaks in follow up scans. It might also make sense to use the SOFA extension to model the compliance of the device with respect to the vessel walls.

@lassoan
Copy link
Contributor

lassoan commented Aug 3, 2025

Nice work. There are lots of similarities with VMTK and SlicerHeart extensions, so there could be a lot of synergies.

VMTK can do very sophisticated centerline extraction, smoothing, branching analysis, various vessel quantifications.

SlicerHeart provides a lot of tools for device placement: snap and slide along centerline, parametric device generation for 10+ different devices (not EVAR so far), device fit assessment, export for simulation in FEBio (simulation takes several minutes, so SOFA could be very interesting), extensive c-arm fluoro simulation coming soon (will be released when the corresponding paper gets published; the paper got through the first round of reviews, so it should not take very long).

We can merge the PR and explore all these opportunities later.

I just had a quick look at the extensions code, and the only comment I have at this point is that the widget class is a bit heavy, because it contains functionalities that belong to the logic class. Always have in mind that your module should be fully usable without a GUI, just by a script using the logic class. The only role of the widget class is just to expose the logic to the user via a GUI.

@lassoan lassoan merged commit 9c638ea into Slicer:main Aug 3, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants