Metadata-Version: 2.3
Name: mssfp
Version: 0.0.6
Summary: mSSFP is library for image reconstuction for multi-acqusition SSFP
Project-URL: Homepage, https://github.com/michaelmendoza/mssfp
Project-URL: Bug Tracker, https://github.com/michaelmendoza/mssfp/issues
Author-email: Michael Mendoza <askmichaelmendoza@gmail.com>
License-Expression: MIT
Keywords: grappa,mri,sense
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: elasticdeform
Requires-Dist: ellipsinator
Requires-Dist: gdown
Requires-Dist: imageio
Requires-Dist: imageio-ffmpeg
Requires-Dist: jupyterlab==3.5.3
Requires-Dist: matplotlib==3.6.3
Requires-Dist: nibabel
Requires-Dist: numpy==1.23.5
Requires-Dist: scikit-image
Requires-Dist: scipy==1.10.0
Requires-Dist: tqdm==4.64.1
Provides-Extra: examples
Requires-Dist: jupyterlab; extra == 'examples'
Requires-Dist: matplotlib; extra == 'examples'
Description-Content-Type: text/markdown


# mSSFP (Multi-SSFP Reconstruction Library)

mSSFP is library for image reconstuction for multi-acqusition SSFP. This library supports ssfp simulations, various phantom generators, and various ssfp recontructions using muliple phase-cycled ssfp images. 

Steady-Stead Free Precession (SSFP) MRI is class of fast pulse sequence capable of generating high SNR images. However, SSFP is highly-sensitive to off-resonance effects, which cause banding artifacts. Multiple SSFP images with different phase cycle amounts can be combined to suppress banding artifacts and for the estimation of quantitative biomarker like T1/T2 relaxation parameter mappings. Multiple methods for band suppression have been developed over the years, and this library gives working code and notebook examples for a variety of these reconstrcution techniques.

## Notebooks

Jupyter notebooks for examples of how to use the mSSFP library.

- Basic SSFP Simulations ([notebook](https://github.com/michaelmendoza/mssfp/blob/master/notebooks/1_sspf_simulations.ipynb))
- Phantom Examples ([notebook](https://github.com/michaelmendoza/mssfp/blob/master/notebooks/2_phantoms.ipynb))
- SSFP Banding Artifact Removal ([notebook](https://github.com/michaelmendoza/mssfp/blob/master/notebooks/3_ssfp_band_removal.ipynb))
- PLANET for T2/T1 Mapping of SSFP ([notebook](https://github.com/michaelmendoza/mssfp/blob/master/notebooks/4_ssfp_brain_planet.ipynb))
- SuperFOV for accelerated SSFP ([simple notebook](https://github.com/michaelmendoza/mssfp/blob/master/notebooks/5_superFOV.ipynb), [detailed notebook](notebooks/5a_superFOV_detailed.ipynb))

## Features

### Simultations
  - SSFP

### Phantoms
  - Shepp-Logan phantom
  - Simple block phantoms
  - Brain phantom
### Banding Artifact Removal Recons
  - Sum of squares 
  - Eliptical singal model 
  - Super field of view (superFOV)
### Quantitative MR Recons
  - PLANET for T2/T1 mapping

## Development

This project requires python 3.8+ and has the dependancies in requirement.txt

To setup a python enviroment with conda:

> ```
> conda create -n mssfp python=3.8 
> conda activate mssfp
> ```
> Then install packages with pip using requirements file 
> ```
> pip install -r requirements.txt
> ```
