Merge pull request #56 from jonbmartin/master

rf pulse design functionality
mikgroup · Jun 16, 2020 · a44d3d3 · a44d3d3
2 parents c3efa3d + f448ed8
commit a44d3d3
Show file tree

Hide file tree

Showing 25 changed files with 3,167 additions and 230 deletions.
diff --git a/docs/core_alg.rst b/docs/core_alg.rst
@@ -23,6 +23,7 @@ First-order Gradient Methods
    sigpy.alg.ConjugateGradient
    sigpy.alg.PrimalDualHybridGradient
    sigpy.alg.ADMM
+   sigpy.alg.SDMM
 
 
 Other Methods

diff --git a/docs/mri_rf.rst b/docs/mri_rf.rst
@@ -4,17 +4,71 @@ MRI RF Design (`sigpy.mri.rf`)
 .. automodule::
    sigpy.mri.rf
 
-SLR Pulse Design
+Adiabatic Pulse Design Functions
+--------------------------------
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    sigpy.mri.rf.adiabatic.bir4
+    sigpy.mri.rf.adiabatic.hypsec
+    sigpy.mri.rf.adiabatic.wurst
+    sigpy.mri.rf.adiabatic.goia_wurst
+    sigpy.mri.rf.adiabatic.bloch_siegert_fm
+
+B1-Selective Pulse Design Functions
+-----------------------------------
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    sigpy.mri.rf.b1sel.dz_b1_rf
+    sigpy.mri.rf.b1sel.dz_b1_gslider_rf
+    sigpy.mri.rf.b1sel.dz_b1_hadamard_rf
+
+RF Linear Operators
 --------------------------
 .. autosummary::
     :toctree: generated
     :nosignatures:
 
-    sigpy.mri.rf.slr.dzrf
-    sigpy.mri.rf.slr.root_flip
-    sigpy.mri.rf.slr.dz_gslider_rf
-    sigpy.mri.rf.slr.dz_gslider_b
-    sigpy.mri.rf.slr.dz_hadamard_b
+    sigpy.mri.rf.linop.PtxSpatialExplicit
+
+Pulse Multibanding Functions
+----------------------------
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    sigpy.mri.rf.multiband.mb_rf
+    sigpy.mri.rf.multiband.dz_pins
+
+Optimal Control Design Functions
+--------------------------------
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    sigpy.mri.rf.optcont.blochsim
+    sigpy.mri.rf.optcont.deriv
+
+Parallel Transmit Pulse Designers
+---------------------------------
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    sigpy.mri.rf.ptx.stspa
+
+RF Shimming Functions
+--------------------------
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    sigpy.mri.rf.shim.calc_shims
+    sigpy.mri.rf.shim.init_optimal_spectral
+    sigpy.mri.rf.shim.init_circ_polar
 
 RF Pulse Simulation
 --------------------------
@@ -25,6 +79,35 @@ RF Pulse Simulation
     sigpy.mri.rf.sim.abrm
     sigpy.mri.rf.sim.abrm_nd
     sigpy.mri.rf.sim.abrm_hp
+    sigpy.mri.rf.sim.abrm_ptx
+
+SLR Pulse Design Functions
+--------------------------------
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    sigpy.mri.rf.slr.dzrf
+    sigpy.mri.rf.slr.root_flip
+    sigpy.mri.rf.slr.dz_gslider_rf
+    sigpy.mri.rf.slr.dz_gslider_b
+    sigpy.mri.rf.slr.dz_hadamard_b
+    sigpy.mri.rf.slr.dz_recursive_rf
+
+Trajectory and Gradient Design Functions
+----------------------------------------
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    sigpy.mri.rf.trajgrad.trap_grad
+    sigpy.mri.rf.trajgrad.spiral_varden
+    sigpy.mri.rf.trajgrad.spiral_arch
+    sigpy.mri.rf.trajgrad.epi
+    sigpy.mri.rf.trajgrad.rosette
+    sigpy.mri.rf.trajgrad.stack_of
+    sigpy.mri.rf.traj_complex_to_array
+    sigpy.mri.rf.traj_array_to_complex
 
 RF Utility
 --------------------------
@@ -34,3 +117,12 @@ RF Utility
 
     sigpy.mri.rf.util.dinf
 
+I/O
+--------------------------
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    sigpy.mri.rf.io.signa
+    sigpy.mri.rf.io.ge_rf_params
+    sigpy.mri.rf.io.philips_rf_params