ENH: Allow Jacobian correction to be toggled on/off #462
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #462 +/- ##
==========================================
+ Coverage 83.66% 83.67% +0.01%
==========================================
Files 32 32
Lines 2816 2818 +2
Branches 377 378 +1
==========================================
+ Hits 2356 2358 +2
Misses 390 390
Partials 70 70 ☔ View full report in Codecov by Sentry. |
effigies
force-pushed
the
fix/optional-jacobian
branch
from
baf7bd8 to
8dfbccf
Compare
mgxd
previously approved these changes
Oct 3, 2024
| @@ -73,6 +73,7 @@ def _sdc_unwarp( | |||
| coordinates: np.ndarray, | |||
| pe_info: Tuple[int, float], | |||
| hmc_xfm: np.ndarray | None, | |||
| jacobian: bool, | |||
There was a problem hiding this comment.
Assuming you've checked all instances - inserting a new parameter in the middle of a non keyword only function makes me nervous
There was a problem hiding this comment.
That's what testing's for. And yes, I've checked.
Co-authored-by: Mathias Goncalves <goncalves.mathias@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Jacobian correction is optional in fMRIPrep, but it can't be toggled when calling SDCFlows resampling, as in SDCFlows workflows. This:
ApplyCoeffsFieldandinit_unwarp_wfto take a booleanjacobianargument that determine whether the Jacobian will be applied.init_unwarp_wftoTrueto avoid changing behavior in downstream tools that do not upgrade and decide to disable it.FalseforApplyCoeffsField. This seems the more conservative option for an interface.jacobian=Truewhen addingApplyCoeffsFieldto theinit_topup_wfworkflow andjacobian=Falsein theinit_syn_sdc_wfThe main thing this enables is fixing nipreps/fmriprep#3366.