Skip to main content

MRI algorithms for fat-water separation based on chemical shift with B0-correction

Project description

Copyright (c) 2016–2026 Johan Berglund

mri-fatwater is distributed under the terms of the GNU General Public License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

ABOUT

mri-fatwater is a command-line tool for MRI chemical shift based fat-water separation with B0-correction based on QPBO graph cuts . Input paramaters are provided by human readable configuration files. See example configuration files provided with mri-fatwater for details. Input data can be in DICOM format, or MATLAB format according to the ISMRM 2012 challenge. mri-fatwater is written in Python.

⚠️ This repository was previously named fwqpbo. The repository was renamed for clarity. Existing links remain valid.

HOW TO USE

First install required packages, see dependencies. To use the command-line tool, type

python -m mri_fatwater.cli -h

To use as a Python script, see example file ./scripts/demo.py. The demo reconstructs data from the ISMRM 2012 challenge (data download required).

HOW TO CITE

Berglund J and Skorpil M. Multi-scale graph-cut algorithm for efficient water- fat separation. Magn Reson Med, 78(3):941-949, 2017. [doi: 10.1002/mrm.26479]

DEPENDENCIES

See ./pyproject.toml.

CONTACT INFORMATION

Johan Berglund, Ph.D.
Uppsala University Hospital,
Uppsala, Sweden
johan.berglund@akademiska.se

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mri_fatwater-1.0.0.tar.gz (44.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mri_fatwater-1.0.0-py3-none-any.whl (32.2 kB view details)

Uploaded Python 3

File details

Details for the file mri_fatwater-1.0.0.tar.gz.

File metadata

  • Download URL: mri_fatwater-1.0.0.tar.gz
  • Upload date:
  • Size: 44.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mri_fatwater-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b41c8d736ff3b26a4003cfda77900f5b1f19975688f7ede09583872c9f487592
MD5 57e0a38df899fc5cb90e0e8b8425bde0
BLAKE2b-256 65a63788e4dbe85ee7ed223a439655146733f2347f24ff7d603b4c47b98426d5

See more details on using hashes here.

File details

Details for the file mri_fatwater-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: mri_fatwater-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 32.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mri_fatwater-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aae67fefcf53da84e9c0109d956d93bd7bd92a5278242a77b7ead8b928e917d5
MD5 11d6e94e71bafb64c508c4b349a090b6
BLAKE2b-256 8f5326c7027ee647fd69fbbd822954189ad89d009729fa30ec1cdf56bf3c7a8a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page