Skip to content

[ENH] Enable cnr_maps and residuals outputs for FSL eddy #2750

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 4 commits into from
Dec 10, 2018

Conversation

divetea
Copy link

@divetea divetea commented Oct 24, 2018

Summary

Add the parameters 'cnr_maps' and 'residuals' to FSL eddy interface.

Fixes #2744 .

List of changes proposed in this PR (pull-request)

  • add parameter 'cnr_maps' to Eddy with the corresponding output 'out_cnr_maps'
  • add parameter 'residuals' to Eddy with the corresponding output 'out_residuals'

The outputs are only listed in _list_outputs if the input flags are defined and set to True.

The tests do not run on my work system since i cannot install all requirements.
I added the parameters to the test_auto_Eddy anyway since they are similar to --repol

I tested this manually with FSL version 5.0.10 .
--cnr_maps and --residuals do not show up in eddy's usage page but they work and are explained in the UserGuide:
https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/eddy/UsersGuide

Acknowledgment

  • (Mandatory) I acknowledge that this contribution will be available under the Apache 2 license.

@@ -659,6 +659,8 @@ class EddyInputSpec(FSLCommandInputSpec):
"the field specified by --field and first volume "
"in file --imain")
use_cuda = traits.Bool(False, desc="Run eddy using cuda gpu")
cnr_maps = traits.Bool(False, desc='Output CNR-Maps', argstr='--cnr_maps')
residuals = traits.Bool(False, desc='Output Residuals', argstr='--residuals')
Copy link
Member

Choose a reason for hiding this comment

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

Do we know if these were introduced in a particular version? If so, we should set the min_ver flag.

Copy link
Author

Choose a reason for hiding this comment

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

I added 5.0.10 as the minimum version since this is the one i am using and that is working (despite the parameters not showing in the usage page). I messaged eddy's developers and they said that these parameters are actually planned to be released with eddy 6.0.1, they did not yet answer why the parameters are already usable in lower versions.

@effigies effigies added this to the 1.1.5 milestone Oct 26, 2018
@effigies
Copy link
Member

Please merge master to fix tests.

@effigies effigies modified the milestones: 1.1.5, 1.1.6 Nov 7, 2018
@effigies
Copy link
Member

Just a heads up: We're looking to make the next release on Nov 26, if you want to try to get this in this month.

@effigies effigies modified the milestones: 1.1.6, 1.1.7 Nov 26, 2018
@codecov-io
Copy link

codecov-io commented Nov 28, 2018

Codecov Report

Merging #2750 into master will increase coverage by 0.01%.
The diff coverage is 33.33%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2750      +/-   ##
==========================================
+ Coverage   67.46%   67.48%   +0.01%     
==========================================
  Files         341      341              
  Lines       43331    43343      +12     
  Branches     5371     5375       +4     
==========================================
+ Hits        29235    29248      +13     
+ Misses      13396    13388       -8     
- Partials      700      707       +7
Flag Coverage Δ
#smoketests 50.55% <33.33%> (-0.01%) ⬇️
#unittests 64.89% <33.33%> (+0.02%) ⬆️
Impacted Files Coverage Δ
nipype/interfaces/fsl/epi.py 64.2% <33.33%> (-0.92%) ⬇️
nipype/interfaces/dynamic_slicer.py 17.47% <0%> (ø) ⬆️
nipype/interfaces/nipy/preprocess.py 45.79% <0%> (ø) ⬆️
nipype/interfaces/io.py 53.99% <0%> (ø) ⬆️
nipype/interfaces/freesurfer/preprocess.py 66.11% <0%> (ø) ⬆️
nipype/pipeline/plugins/legacymultiproc.py 66% <0%> (+4.5%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1eeabd3...66ea26f. Read the comment docs.

@effigies effigies changed the title ENH: Add new parameters 'cnr_maps' and 'residuals' to FSL eddy interface [ENH] Enable cnr_maps and residuals outputs for FSL eddy Dec 10, 2018
Copy link
Member

@effigies effigies left a comment

Choose a reason for hiding this comment

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

Looks good.

Want to add your name, affiliation and ORCID to the .zenodo.json file?

@divetea
Copy link
Author

divetea commented Dec 10, 2018

No thanks, maybe when i contribute something bigger than a couple of lines ;)

@effigies effigies merged commit 35b58cd into nipy:master Dec 10, 2018
yarikoptic added a commit to yarikoptic/nipype that referenced this pull request Jan 11, 2019
1.1.7 (December 17, 2018)

* FIX: Copy node list before generating a flat graph (nipy#2828)
* FIX: Update pytest req'd version to 3.6 (nipy#2827)
* FIX: Set ResourceMonitor.fname to an absolute path (nipy#2824)
* FIX: Order of SPM.NewSegment channel_info boolean tuple is (Field, Corrected) (nipy#2817)
* FIX: Indices were swapped for memory and cpu profile data (nipy#2816)
* FIX: ``status_callback`` not called with ``stop_on_first_crash`` (nipy#2810)
* FIX: Change undefined ScriptError on LFS plugin to IOError (nipy#2803)
* ENH: Add NaN failure mode to CompCor interfaces (nipy#2819)
* ENH: Enable cnr_maps and residuals outputs for FSL eddy (nipy#2750)
* ENH: Improve ``str2bool`` + doctests (nipy#2807)
* TST: Improve py.test configuration of doctests (nipy#2802)
* DOC: Update DOI badge to point to all versions (nipy#2804)
* MAINT: Offload interfaces with help formatting (nipy#2797)
* MAINT: Reduce minimal code redundancy in filemanip.get_dependencies (nipy#2782)
* MAINT: Delayed imports to reduce import time (nipy#2809)
...
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.

Additional parameters for FSL Eddy
4 participants