Skip to content
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

[ENH] Add the possibility to use ANTsPy instead of ANTs for T1Linear and FlairLinear #1244

Merged

Conversation

NicolasGensollen
Copy link
Member

@NicolasGensollen NicolasGensollen commented Jul 26, 2024

This PR proposes to add support for ANTsPy in the T1Linear and FlairLinear pipelines. These two pipelines currently only depend on Clinica's Python dependencies as well as the third party ANTs software which can be problematic to install for some users.

If this PR is merged, it would mean that users without an installation of ANTs on their machine would be able to run these two pipelines if they have installed the Python core of Clinica.

The price to pay on our side is the addition of the ANTsPy Python dependency to our list of dependencies.
I think this is something we can live with, and we could very well have it as an optional dependency such that users only interested on other functionalities would not need to install it.

I tried to propose an implementation that should give results close to the original way of running the pipeline, but I think we should gather user inputs on whether the pipeline produce sensible results.

For these reasons, I added a --use-antspy option to the CLI such that it is very easy to try out and the original way of running the pipeline is still the default.
Note that a warning is given to the users to say that the functionality is still experimental:

Capture d’écran 2024-07-26 à 12 18 42

The pipeline produces the expected files with correct names:

Capture d’écran 2024-07-26 à 12 24 47

This PR also updates the documentation of these two pipelines to expose this new functionality to the users (again, with a warning saying that it is experimental...):

Capture d’écran 2024-07-26 à 12 47 53 (2)

Finally, the PR adds some unit tests on the added functionalities.

@NicolasGensollen NicolasGensollen self-assigned this Jul 26, 2024
@NicolasGensollen NicolasGensollen added pipeline dependencies Pull requests that update a dependency file labels Jul 26, 2024
@NicolasGensollen NicolasGensollen added this to the v0.9.0 milestone Jul 26, 2024
@NicolasGensollen NicolasGensollen marked this pull request as ready for review July 26, 2024 11:00
Copy link
Contributor

@AliceJoubert AliceJoubert left a comment

Choose a reason for hiding this comment

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

LGTM ! I guess we can merge and see what users say overtime.

@NicolasGensollen
Copy link
Member Author

Thanks for the review @AliceJoubert !
I agree, everything is marked as "experimental", so let's merge and see what users think.

@NicolasGensollen NicolasGensollen merged commit c8c64e0 into aramis-lab:dev Aug 2, 2024
14 of 15 checks passed
@NicolasGensollen NicolasGensollen deleted the use-antspy-in-t1-linear branch August 2, 2024 06:13
AliceJoubert pushed a commit to AliceJoubert/clinica that referenced this pull request Aug 22, 2024
…near` and `FlairLinear` (aramis-lab#1244)

* add antspy to dependencies

* try replacing n4biasfieldcorrection

* implement the use-antspy option for t1-linear and flair-linear

* update documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file pipeline
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants