MIRTorch

GitHub release (latest by date including pre-releases) Read the Docs

A differentiable PyTorch toolbox for medical imaging reconstruction, developed at the University of Michigan. MIRTorch provides composable linear maps, proximal operators, iterative solvers, and MRI and SPECT system models.

Documentation · Examples · API

New

FINUFFT/cuFINUFFT now accelerate non-Cartesian and B0-informed MRI; warm NVIDIA A10 benchmarks measured up to 5.2× faster NUFFT, 9.4× faster Toeplitz, and 12.3× faster iterative solvers (workload-dependent). Both NUFFT backends also support efficient first-order trajectory gradients, enabling SNOPY-style sampling-pattern optimization directly in MIRTorch (Wang and Fessler, 2023).

Install

Install PyTorch for your platform, then:

pip install MIRTorch

CUDA users can install cuFINUFFT with:

pip install "MIRTorch[cufinufft]"

For local development:

pip install -e ".[dev]"

Backends and compilation

NuSense, NuSenseGram, Gmri, and GmriGram use an installed FINUFFT or cuFINUFFT library when the device supports it, then fall back to torchkbnufft. Base macOS, Apple Metal, and Linux ARM installs therefore work without a native library. Set backend="torchkbnufft" or backend="finufft" to override the automatic choice.

Real-valued CUDA runs of Diff2dgram, FISTA, and POGM use torch.compile automatically when PyTorch provides it. Other inputs stay eager; pass compile=False to disable compilation explicitly.

Examples

The notebooks choose CUDA, Apple Metal, or CPU at runtime:

Citation and acknowledgments

MIRTorch is inspired by MIRT, MIRT.jl, SigPy, and PyLops.

If MIRTorch is useful in your work, please cite:

@inproceedings{wang:22:mirtorch,
  title={{MIRTorch}: A {PyTorch}-powered Differentiable Toolbox for Fast Image
         Reconstruction and Scan Protocol Optimization},
  author={Wang, Guanhua and Shah, Neel and Zhu, Keyue and Noll, Douglas C. and
          Fessler, Jeffrey A.},
  booktitle={Proceedings of the International Society for Magnetic Resonance
             in Medicine (ISMRM)},
  pages={4982},
  year={2022}
}

See the documentation for the BJORK and SPECT citations.

MIRTorch is distributed under the BSD 3-Clause License.

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for guanhuaw from gravatar.com guanhuaw

Credits

Author: Guanhua Wang

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

BSD-3-Clause
View SPDX License List

Requires

Python >=3.10

Provides Extra

examples cufinufft finufft docs test dev

Tags

signal processing inverse problems

Classifiers

Report project as malware

Download files

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

Source Distribution

mirtorch-0.3.0.tar.gz (88.2 kB view details)

Uploaded Source

Built Distribution

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

mirtorch-0.3.0-py3-none-any.whl (106.4 kB view details)

Uploaded Python 3

File details

Details for the file mirtorch-0.3.0.tar.gz.

File metadata

  • Download URL: mirtorch-0.3.0.tar.gz
  • Upload date:
  • Size: 88.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mirtorch-0.3.0.tar.gz
Algorithm Hash digest
SHA256 301c3c72dda6b28e67ce243ae851ccfc383e03ab8cf0c0b59110776226a7162b
MD5 e3608121c5ae826c69f62777ae9472db
BLAKE2b-256 e031996180a50ba57505aee778e14bd94a3cfebd6acfb264efb781cc3a08d264

See more details on using hashes here.

Provenance

The following attestation bundles were made for mirtorch-0.3.0.tar.gz:

Publisher: python-release.yml on guanhuaw/MIRTorch

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mirtorch-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: mirtorch-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 106.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mirtorch-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2dd85fa6578d6b2179555c0e371881d8bc0d02c3a131ac6313fc2f5b3569928
MD5 e69c3ddf9af1755e1856a61af21d88ad
BLAKE2b-256 3c03e28ebfd129730f84907453ba4378e38dea3d8a55913c3007ff0f05e31bda

See more details on using hashes here.

Provenance

The following attestation bundles were made for mirtorch-0.3.0-py3-none-any.whl:

Publisher: python-release.yml on guanhuaw/MIRTorch

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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