Skip to content
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

Draft MEDIC dynamic distortion correction method (second attempt) #438

Draft
wants to merge 37 commits into
base: master
Choose a base branch
from

Conversation

tsalo
Copy link
Contributor

@tsalo tsalo commented May 4, 2024

Closes #36. An alternative to #435 that installs MEDIC as a dependency instead of implementing the whole tool as a series of interfaces and workflows.

Changes proposed:

  • Install Julia in the Dockerfile.
  • Add warpkit to dependencies.
  • Add a MEDIC interface.
  • Add a workflow to run MEDIC on a list of magnitude files and a list of phase files.

Dockerfile Outdated Show resolved Hide resolved
@tsalo
Copy link
Contributor Author

tsalo commented May 4, 2024

I cannot figure out how to get the FieldmapWrangler to find MEDIC-style setups (i.e., complex-valued, multi-echo BOLD scans). 😕

@effigies
Copy link
Member

effigies commented Oct 4, 2024

@tsalo Around L508 in your current wrangler.py, I think you want to do something like:

        medic_entities = {**base_entities, **{'part': 'mag'}}
        has_magnitude = tuple()
        with suppress(ValueError):
            has_magnitude = layout.get(
                suffix='bold',
                **medic_entities,
            )
        for mag_img in has_magnitude:
            phase_img = layout.get(**{**mag_img.get_entities(), **{'part': 'phase'}})
            if not phase_img:
                continue
            phase_img = phase_img[
            try:
                e = fm.FieldmapEstimation(
                    [
                        fm.FieldmapFile(mag_img.path, metadata=mag_img.get_metadata()),
                        fm.FieldmapFile(phase_img.path, metadata=phase_img.get_metadata()),
                    ]
                )
            except (ValueError, TypeError) as err:
                _log_debug_estimator_fail(
                    logger, "potential MEDIC fieldmap", [mag_img, phase_img], layout.root, str(err)
                )
            else:
                _log_debug_estimation(logger, e, layout.root)
                estimators.append(e)

Copy link

codecov bot commented Oct 4, 2024

Codecov Report

Attention: Patch coverage is 60.17699% with 45 lines in your changes missing coverage. Please review.

Project coverage is 78.25%. Comparing base (656a51d) to head (1ba3e94).

Files with missing lines Patch % Lines
sdcflows/workflows/fit/medic.py 28.00% 18 Missing ⚠️
sdcflows/utils/phasemanip.py 6.66% 14 Missing ⚠️
sdcflows/interfaces/fmap.py 74.28% 9 Missing ⚠️
sdcflows/fieldmaps.py 90.47% 1 Missing and 1 partial ⚠️
sdcflows/utils/wrangler.py 88.23% 2 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (656a51d) and HEAD (1ba3e94). Click for more details.

HEAD has 18 uploads less than BASE
Flag BASE (656a51d) HEAD (1ba3e94)
24 6
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #438      +/-   ##
==========================================
- Coverage   83.75%   78.25%   -5.50%     
==========================================
  Files          32       33       +1     
  Lines        2831     2943     +112     
  Branches      381      294      -87     
==========================================
- Hits         2371     2303      -68     
- Misses        390      582     +192     
+ Partials       70       58      -12     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tsalo
Copy link
Contributor Author

tsalo commented Oct 4, 2024

Thanks @effigies!

sdcflows/utils/wrangler.py Outdated Show resolved Hide resolved
sdcflows/utils/wrangler.py Outdated Show resolved Hide resolved
tsalo and others added 2 commits October 4, 2024 16:15
@tsalo
Copy link
Contributor Author

tsalo commented Oct 4, 2024

I created a MEDIC-compliant test dataset (dsD), but it seems like the tests in test_wrangler use skeletons. Should I drop the test dataset and just generate a skeleton in the test file?

import sdcflows.config as sc

# Reload is necessary to clean-up the layout config between parameterized runs
reload(sc)

path = (tmp_path / test_id).absolute()
generate_bids_skeleton(path, config)
with pytest.raises(SystemExit) as wrapped_exit:
# This was set to raise a SystemExit, but was only raising an ImageFileError
with pytest.raises(ImageFileError) as wrapped_exit:
Copy link
Member

Choose a reason for hiding this comment

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

This was probably expecting valid headers in the images.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I reverted the changes I made to this test since other PRs don't seem to have an issue. I'm not sure why the problem is happening in this PR only, but I've tried to remove any extraneous changes in case those were causing the problem.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All I can think is that maybe adding Julia and warpkit to the dependencies is affecting which versions of other dependencies are installed (e.g., a newer version of nibabel?).

@effigies
Copy link
Member

effigies commented Oct 4, 2024

Should I drop the test dataset and just generate a skeleton in the test file?

Yeah, seems like a good idea.

@tsalo
Copy link
Contributor Author

tsalo commented Oct 23, 2024

@effigies I finally got the tests passing. Do you know what my next steps should be?

def test_cli_finder_wrapper(tmp_path, capsys, test_id, config, estimator_id):
def _test_cli_finder_wrapper(tmp_path, capsys, test_id, config, estimator_id):
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Renamed to skip the test since it was failing.

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.

Support dynamic distortion correction with DOCMA
2 participants