API
===

 Author : Jaime Barranco

bmArrayUtility
--------------
.. automodule:: bmArrayUtility
    :members:
    :undoc-members:
    :show-inheritance:

bmCoilSense
-----------
automatic
^^^^^^^^^
.. automodule:: bmCoilSense.automatic
    :members:
    :undoc-members:
    :show-inheritance:

from_prescan
^^^^^^^^^^^^
.. automodule:: bmCoilSense.from_prescan
    :members:
    :undoc-members:
    :show-inheritance:

map
^^^
.. automodule:: bmCoilSense.map
    :members:
    :undoc-members:
    :show-inheritance:

nonCart
^^^^^^^
.. automodule:: bmCoilSense.nonCart
    :members:
    :undoc-members:
    :show-inheritance:

bmDialog
--------
.. automodule:: bmDialog
    :members:
    :undoc-members:
    :show-inheritance:

bmDicom
-------
.. automodule:: bmDicom
    :members:
    :undoc-members:
    :show-inheritance:

bmElastix
---------
.. automodule:: bmElastix
    :members:
    :undoc-members:
    :show-inheritance:

bmFieldDisp2
------------
.. automodule:: bmFieldDisp2
    :members:
    :undoc-members:
    :show-inheritance:

bmFieldDisp3
------------
.. automodule:: bmFieldDisp3
    :members:
    :undoc-members:
    :show-inheritance:

bmFit1
------
.. automodule:: bmFit1
    :members:
    :undoc-members:
    :show-inheritance:

bmFourier1
----------
.. automodule:: bmFourier1
    :members:
    :undoc-members:
    :show-inheritance:

bmFourier123
------------
map_function
^^^^^^^^^^^^
cartesian
~~~~~~~~~
.. automodule:: bmFourier123.map_function.cartesian
    :members:
    :undoc-members:
    :show-inheritance:

nonCartesian
~~~~~~~~~~~~
.. automodule:: bmFourier123.map_function.nonCartesian
    :members:
    :undoc-members:
    :show-inheritance:

partialCartesian
~~~~~~~~~~~~~~~~
.. automodule:: bmFourier123.map_function.partialCartesian
    :members:
    :undoc-members:
    :show-inheritance:

other_function
^^^^^^^^^^^^^^
.. automodule:: bmFourier123.other_function
    :members:
    :undoc-members:
    :show-inheritance:

prep_function
^^^^^^^^^^^^^
.. automodule:: bmFourier123.prep_function
    :members:
    :undoc-members:
    :show-inheritance:

solver_function
^^^^^^^^^^^^^^^
imDim
~~~~~
nonCartesian
~~~~~~~~~~~~
.. automodule:: bmFourier123.solver_function.imDim.nonCartesian
    :members:
    :undoc-members:
    :show-inheritance:

partialCartesian
~~~~~~~~~~~~~~~~
.. automodule:: bmFourier123.solver_function.imDim.partialCartesian
    :members:
    :undoc-members:
    :show-inheritance:

imDim_morphosia
~~~~~~~~~~~~~~~
nonCartesian
~~~~~~~~~~~~
.. automodule:: bmFourier123.solver_function.imDim_morphosia.nonCartesian
    :members:
    :undoc-members:
    :show-inheritance:

partialCartesian
~~~~~~~~~~~~~~~~
.. automodule:: bmFourier123.solver_function.imDim_morphosia.partialCartesian
    :members:
    :undoc-members:
    :show-inheritance:

bmFourier2
----------
.. automodule:: bmFourier2
    :members:
    :undoc-members:
    :show-inheritance:

bmFourier3
----------
.. automodule:: bmFourier3
    :members:
    :undoc-members:
    :show-inheritance:

bmFourierN
----------
.. automodule:: bmFourierN
    :members:
    :undoc-members:
    :show-inheritance:

bmFunction1
-----------
.. automodule:: bmFunction1
    :members:
    :undoc-members:
    :show-inheritance:

bmGeom1
-------
.. automodule:: bmGeom1
    :members:
    :undoc-members:
    :show-inheritance:

bmGeom123
---------
.. automodule:: bmGeom123
    :members:
    :undoc-members:
    :show-inheritance:

bmGeom2
-------
.. automodule:: bmGeom2
    :members:
    :undoc-members:
    :show-inheritance:

bmGeom3
-------
.. automodule:: bmGeom3
    :members:
    :undoc-members:
    :show-inheritance:

bmGeomN
-------
.. automodule:: bmGeomN
    :members:
    :undoc-members:
    :show-inheritance:

bmGridding123
-------------
m
^^^
.. automodule:: bmGridding123.m
    :members:
    :undoc-members:
    :show-inheritance:

mex
^^^
bmImage1
--------
m
^^^
.. automodule:: bmImage1.m
    :members:
    :undoc-members:
    :show-inheritance:

mex
^^^
bmImage123
----------
.. automodule:: bmImage123
    :members:
    :undoc-members:
    :show-inheritance:

bmImage2
--------
m
^^^
.. automodule:: bmImage2.m
    :members:
    :undoc-members:
    :show-inheritance:

mex
^^^
bmImage3
--------
m
^^^
.. automodule:: bmImage3.m
    :members:
    :undoc-members:
    :show-inheritance:

mex
^^^
bmImageN
--------
.. automodule:: bmImageN
    :members:
    :undoc-members:
    :show-inheritance:

bmImDisp
--------
.. automodule:: bmImDisp
    :members:
    :undoc-members:
    :show-inheritance:

bmImReg
-------
class
^^^^^
.. automodule:: bmImReg.class
    :members:
    :undoc-members:
    :show-inheritance:

m
^^^
.. automodule:: bmImReg.m
    :members:
    :undoc-members:
    :show-inheritance:

bmInterp1
---------
.. automodule:: bmInterp1
    :members:
    :undoc-members:
    :show-inheritance:

bmInterp2
---------
.. automodule:: bmInterp2
    :members:
    :undoc-members:
    :show-inheritance:

bmInterp3
---------
.. automodule:: bmInterp3
    :members:
    :undoc-members:
    :show-inheritance:

bmLinAlg2
---------
.. automodule:: bmLinAlg2
    :members:
    :undoc-members:
    :show-inheritance:

bmLinAlg3
---------
.. automodule:: bmLinAlg3
    :members:
    :undoc-members:
    :show-inheritance:

bmLinSpace
----------
.. automodule:: bmLinSpace
    :members:
    :undoc-members:
    :show-inheritance:

bmMask123
---------
.. automodule:: bmMask123
    :members:
    :undoc-members:
    :show-inheritance:

bmMask2
-------
.. automodule:: bmMask2
    :members:
    :undoc-members:
    :show-inheritance:

bmMask3
-------
.. automodule:: bmMask3
    :members:
    :undoc-members:
    :show-inheritance:

bmMaskN
-------
.. automodule:: bmMaskN
    :members:
    :undoc-members:
    :show-inheritance:

bmMathDisp
----------
.. automodule:: bmMathDisp
    :members:
    :undoc-members:
    :show-inheritance:

bmMathOp
--------
.. automodule:: bmMathOp
    :members:
    :undoc-members:
    :show-inheritance:

bmMex
-----
m
^^^
.. automodule:: bmMex.m
    :members:
    :undoc-members:
    :show-inheritance:

mex
^^^
bmMitosius
----------
.. automodule:: bmMitosius
    :members:
    :undoc-members:
    :show-inheritance:

bmMriPhi
--------
.. automodule:: bmMriPhi
    :members:
    :undoc-members:
    :show-inheritance:

bmMriRecon
----------
class
^^^^^
.. automodule:: bmMriRecon.class
    :members:
    :undoc-members:
    :show-inheritance:

function
^^^^^^^^
.. automodule:: bmMriRecon.function
    :members:
    :undoc-members:
    :show-inheritance:

bmOptim
-------
.. automodule:: bmOptim
    :members:
    :undoc-members:
    :show-inheritance:

bmPartition
-----------
.. automodule:: bmPartition
    :members:
    :undoc-members:
    :show-inheritance:

bmPhaseLift
-----------
.. automodule:: bmPhaseLift
    :members:
    :undoc-members:
    :show-inheritance:

bmPhysicNum
-----------
.. automodule:: bmPhysicNum
    :members:
    :undoc-members:
    :show-inheritance:

bmQuickSolve
------------
.. automodule:: bmQuickSolve
    :members:
    :undoc-members:
    :show-inheritance:

bmReadWrite
-----------
.. automodule:: bmReadWrite
    :members:
    :undoc-members:
    :show-inheritance:

bmSparseMat
-----------
m
^^^
.. automodule:: bmSparseMat.m
    :members:
    :undoc-members:
    :show-inheritance:

mex
^^^
bmSparseMat_help_function
~~~~~~~~~~~~~~~~~~~~~~~~~
bmSparseMat_vec
~~~~~~~~~~~~~~~
bmTime
------
.. automodule:: bmTime
    :members:
    :undoc-members:
    :show-inheritance:

bmTraj1
-------
.. automodule:: bmTraj1
    :members:
    :undoc-members:
    :show-inheritance:

bmTraj123
---------
.. automodule:: bmTraj123
    :members:
    :undoc-members:
    :show-inheritance:

bmTraj2
-------
.. automodule:: bmTraj2
    :members:
    :undoc-members:
    :show-inheritance:

bmTraj3
-------
.. automodule:: bmTraj3
    :members:
    :undoc-members:
    :show-inheritance:

bmTrajN
-------
.. automodule:: bmTrajN
    :members:
    :undoc-members:
    :show-inheritance:

bmTwix
------
.. automodule:: bmTwix
    :members:
    :undoc-members:
    :show-inheritance:

bmVarargin
----------
.. automodule:: bmVarargin
    :members:
    :undoc-members:
    :show-inheritance:

ISMRMRD
-------
.. automodule:: ISMRMRD
    :members:
    :undoc-members:
    :show-inheritance:

rawDataReader
-------------
.. automodule:: rawDataReader
    :members:
    :undoc-members:
    :show-inheritance:

ismrmrd
^^^^^^^
.. automodule:: rawDataReader.ismrmrd
    :members:
    :undoc-members:
    :show-inheritance:

siemens
^^^^^^^
.. automodule:: rawDataReader.siemens
    :members:
    :undoc-members:
    :show-inheritance: