Skip to content

ENH: Include realignment matrices in TOPUP outputs #2084

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
Jun 22, 2017

Conversation

mwaskom
Copy link
Member

@mwaskom mwaskom commented Jun 21, 2017

FSL's topup binary has two undocumented options: --dfout and --rbmout (see here). The Nipype interface exposes the former but not the latter, which writes out transformation matrices that encode the rigid realignment from each frame to the first frame of the input file. These matrices are necessary to properly apply the warpfields to the input images. This PR extends the currently existing logic for --dfout to --rbmout.

@mwaskom mwaskom force-pushed the topup_framewise_matrices branch from e88b36a to eb524e5 Compare June 21, 2017 15:13
@codecov-io
Copy link

codecov-io commented Jun 21, 2017

Codecov Report

Merging #2084 into master will decrease coverage by <.01%.
The diff coverage is 66.66%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2084      +/-   ##
==========================================
- Coverage   72.13%   72.13%   -0.01%     
==========================================
  Files        1138     1138              
  Lines       57268    57271       +3     
  Branches     8206     8207       +1     
==========================================
  Hits        41313    41313              
- Misses      14663    14665       +2     
- Partials     1292     1293       +1
Flag Coverage Δ
#smoketests 72.13% <66.66%> (-0.01%) ⬇️
#unittests 69.75% <66.66%> (-0.01%) ⬇️
Impacted Files Coverage Δ
nipype/interfaces/fsl/tests/test_auto_TOPUP.py 85.71% <ø> (ø) ⬆️
nipype/interfaces/fsl/epi.py 65.67% <66.66%> (ø) ⬆️
nipype/interfaces/base.py 83.62% <0%> (-0.19%) ⬇️

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 5040260...27daccc. Read the comment docs.

@mwaskom mwaskom changed the title Include realignment matrices in TOPUP outputs ENH: Include realignment matrices in TOPUP outputs Jun 21, 2017
@effigies
Copy link
Member

Looks reasonable. Assume you've actually used it and the file names work out correctly?

@mwaskom
Copy link
Member Author

mwaskom commented Jun 22, 2017

Yep I have a workflow that needed this functionality and things look good:

_0x14aebc8e5c8129a8e4e41d37ffd1cedc.json  se_func_sess01_encfile.txt
command.txt                               se_func_sess01_field.nii.gz
_inputs.pklz                              se_func_sess01_topup.log
jac_01.nii.gz                             warpfield_01.nii.gz
jac_02.nii.gz                             warpfield_02.nii.gz
jac_03.nii.gz                             warpfield_03.nii.gz
jac_04.nii.gz                             warpfield_04.nii.gz
jac_05.nii.gz                             warpfield_05.nii.gz
jac_06.nii.gz                             warpfield_06.nii.gz
_node.pklz                                xfm_01.mat
_report/                                  xfm_02.mat
result_estimate_distortions.pklz          xfm_03.mat
se_func_sess01_base_fieldcoef.nii.gz      xfm_04.mat
se_func_sess01_base_movpar.txt            xfm_05.mat
se_func_sess01_corrected.nii.gz           xfm_06.mat

@effigies effigies merged commit 9ac1058 into nipy:master Jun 22, 2017
@mwaskom mwaskom deleted the topup_framewise_matrices branch June 22, 2017 15:18
@satra satra added this to the 0.14.0 milestone Oct 20, 2017
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.

4 participants