Skip to main content

Tools for Magnetic Resonance Fingerprinting

Project description

mrftools

Python / pip package for managing MRF sequence definitions, dictionary definitions, bloch simulation results, and more. Utilizes HDF5 interchange format (.mrf files).

Features

  1. MRF Sequence definitions
    • Intended to define a sequence for execution on the scanner or within a bloch simulation
    • Supports timepoints with varying TR, TE, and FA
    • Supports multiple "beats" with varying RRTime, PrepTime, and PrepID
    • Can be defined programatically via Python, via .txt import, or via .mrf import
    • Can be exported to .txt format or .mrf format (** txt export not implemented fully **)
  2. MRF Dictionary definitions
    • Intended to define a set of dictionary entries to be used by a bloch simulation
    • Supports entries with varying T1, T2, and B0 values
    • Can be defined programatically via Python, via .txt import, or via .mrf import
    • Can be exported to .txt format or .mrf format
  3. MRF Simulation definitions
    • Intended to specify and execute a bloch simulation of a specific sequence over a specific dictionary set
    • Configurable phase range and number of isochromat spins
    • Can either store all isochromat results or perform averaging before saving dictionary
    • Results and configuration can be exported to .mrf format

Installation from pip

  1. pip install mrftools

Installation from source

  1. git clone https://gitlab.casemri.com/common-resources/mrftools
  2. cd mrftools
  3. pip install .

Building and Publishing pip Package

  1. python3 setup.py sdist bdist_wheel
  2. twine upload dist/*

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

mrftools-0.0.7.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

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

mrftools-0.0.7-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file mrftools-0.0.7.tar.gz.

File metadata

  • Download URL: mrftools-0.0.7.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for mrftools-0.0.7.tar.gz
Algorithm Hash digest
SHA256 403302de43bb273f17c76da05d5a3945851063d5630dc0934e8639b687d3a641
MD5 c009c20e319c63876a1e4e36ba13787a
BLAKE2b-256 1b04c44f3d1b9dbe59cc53f23c2f7ec14c9d734a84b55bac024fae02cce86aed

See more details on using hashes here.

File details

Details for the file mrftools-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: mrftools-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 21.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for mrftools-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f13782f04d167dd9620b04cc956db7d9128fb69c28499743158c9838fc3f34af
MD5 4f2ce77e114b4803163ab37997b01efb
BLAKE2b-256 61296c7838186c233c984fa57926d0c20ef6c8435fa06d9540db5644363f5e12

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