ENH: Add NaN failure mode to CompCor interfaces #2819
Merged
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.
Summary
Following discussion in nipreps/fmriprep#1433, having CompCor interfaces gracefully handle failure states by returning NaN arrays of the appropriate size is preferable to crashing the pipeline.
This PR adds a
failure_mode
input to the interface, which defaults to'error'
and maintains the current behavior. Iffailure_mode == 'nan'
, then exceptions are not raised, and columns of NaNs are returned.List of changes proposed in this PR (pull-request)
failure_mode
input to CompCor interfacesfailure_mode == 'nan'
, return columns of NaNs instead of raising exceptionsAcknowledgment