Metadata-Version: 2.1
Name: virtcoilphase
Version: 0.1.0
Summary: Virtual reference coil method to determine phase distribution
Home-page: https://github.com/mckib2/virtcoilphase
Author: Nicholas McKibben
Author-email: nicholas.bgp@gmail.com
License: GPLv3
Platform: UNKNOWN
Requires-Python: >=3.6
Requires-Dist: numpy (>=1.17.2)
Requires-Dist: scipy (>=1.3.1)
Requires-Dist: matplotlib (>=3.1.1)
Requires-Dist: tqdm (>=4.36.1)

Virtual Reference Coil
======================

Python implementation of the algorithm described in [1]_ for finding
optimal phase map estimates using a constructed virtual coil.

Installation
============

Should be as easy as a pip install:

.. code-block:: bash

    pip install virtcoilphase

Usage
=====

Examples can be called from the command line, for example:

.. code-block:: bash

    python -m virtcoilphase.examples.simple

Given a number of coil images, you can find the absolute phase
estimate like this:

.. code-block:: python

    from virtcoilphase import virtcoilphase
    phase = virtcoilphase(x, coil_axis=-1)

References
==========
.. [1] Parker, Dennis L., et al. "Phase reconstruction from
       multiple coil data using a virtual reference coil."
       Magnetic resonance in medicine 72.2 (2014): 563-569.


