ME-ICA / multi-echo-data-analysis

Still a work in progress.
https://me-ica.github.io/multi-echo-data-analysis/
GNU Lesser General Public License v2.1
3 stars 2 forks source link

Bump tedana from 24.0.0 to 24.0.1 #31

Closed dependabot[bot] closed 3 months ago

dependabot[bot] commented 3 months ago

Bumps tedana from 24.0.0 to 24.0.1.

Release notes

Sourced from tedana's releases.

24.0.1

Release Notes

Summary

  • We use bokeh to generate interactive figures in our html report. bokeh v 3.4.0 included some under-documented changes that caused tedana to crash and other problems with interactivity. This is fixed in ME-ICA/tedana#1068
  • We create an adaptive mask that lists the number of "good echoes" in each voxel. This is used so that a voxel with a single good echo is retained, but steps that include fitting values across echoes are limited to voxels with more good echoes. We noticed a few places where our description of how the adpative mask was created didn't match what was actually happening. These are bugs that needed to get fixed, but our underlying threshold are arbitrary. If these fixes are adversely affecting the retained voxels, please please up and we can examine tweaking thresholds or adding other options.
    • The adaptive mask uses percentiles across all voxel values as part of a threshold calculation. Only voxels within a a general or user-supplied mask were supposed to be used, but we were applying that mask after calculating percentiles. This is now fixed (ME-ICA/tedana#1060). In practice this will slightly raise thresholds and reduce the number of voxels that survive the adaptive mask. An example of how this could alter the mask is here.
    • The adapative mask was intended to store the last good echo. That is, a voxel where echoes 1 and 3 are above threshold should be 3 in the adaptive mask even if echo 2 was below threshold. The code was just counting the number of good echoes and storing 2. This is fixed in ME-ICA/tedana#1061
  • As part of the adaptive masking bug fixes we also added another option for calculating an adaptive mask ( ME-ICA/tedana#1057 ) that removes voxels where later echoes have larger values than earlier echoes. This might be useful for typical multi-echo data, but could cause problems if echoes are temporally close and there is a downward trend, but not every value decreases. As part of this addition, there is now a --masktype option where one can input dropout, our current and default method, decay this new method, or both.
  • We have also added several long-requested visualizations to our html report. Descriptions of the new visualizations are in our documentation The additions include:
    • A visualization of the adaptive mask to show which voxels are retained in the optimally combined image and which are used T2* and S0 fits as part of the ICA denoising process. ME-ICA/tedana#1073
    • Mean T2* and S0* fits are calculated and used as weights for the optimal combination of echoes. We were not calculating nor saving the fit quality. The root mean square error (RMSE) for this fits are now saved and presented in our report ME-ICA/tedana#1044
    • As part of previously added visualizations and these new visualizations, we belatedly realized we were using an parameter that was only added to nilearn in v0.10.3 so we've raised the minimum accepted version number for nilearn ME-ICA/tedana#1094

🐛 Bug Fixes

Changes

New Contributors

Full Changelog: https://github.com/ME-ICA/tedana/compare/24.0.0...24.0.1

Commits
  • 12aea7f minimum nilearn 0.10.3 (#1094)
  • 0f6cbe1 Output RMSE map and time series for decay model fit (#1044)
  • af5e99a Identify the last good echo in adaptive mask instead of sum of good echoes (#...
  • 1660435 docs: add mvdoc as a contributor for code, bug, and doc (#1082)
  • 35a26dd DOC desc-optcomDenoised -> desc-denoised (#1080)
  • 461bc38 Load user-defined mask as expected by plot_adaptive_mask (#1079)
  • 5835d3a Update bokeh requirement from <=3.4.0,>=1.0.0 to >=1.0.0,<=3.4.1 (#1078)
  • 953aa65 Update pandas requirement from <=2.2.1,>=2.0 to >=2.0,<=2.2.2 (#1076)
  • 49978ca Update scikit-learn requirement (#1075)
  • ee714f3 Add adaptive mask plot to report (#1073)
  • Additional commits viewable in compare view


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)