[ENH] Add the possibility to use ANTsPy
instead of ANTs
for T1Linear
and FlairLinear
#1244
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR proposes to add support for ANTsPy in the
T1Linear
andFlairLinear
pipelines. These two pipelines currently only depend on Clinica's Python dependencies as well as the third partyANTs
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:
The pipeline produces the expected files with correct names:
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...):
Finally, the PR adds some unit tests on the added functionalities.