pypulseq.rst 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  1. pypulseq package
  2. ================
  3. Subpackages
  4. -----------
  5. .. toctree::
  6. :maxdepth: 4
  7. pypulseq.SAR
  8. pypulseq.Sequence
  9. pypulseq.tests
  10. Submodules
  11. ----------
  12. pypulseq.add\_gradients module
  13. ------------------------------
  14. .. automodule:: pypulseq.add_gradients
  15. :members:
  16. :undoc-members:
  17. :show-inheritance:
  18. pypulseq.add\_ramps module
  19. --------------------------
  20. .. automodule:: pypulseq.add_ramps
  21. :members:
  22. :undoc-members:
  23. :show-inheritance:
  24. pypulseq.align module
  25. ---------------------
  26. .. automodule:: pypulseq.align
  27. :members:
  28. :undoc-members:
  29. :show-inheritance:
  30. pypulseq.block\_to\_events module
  31. ---------------------------------
  32. .. automodule:: pypulseq.block_to_events
  33. :members:
  34. :undoc-members:
  35. :show-inheritance:
  36. pypulseq.calc\_duration module
  37. ------------------------------
  38. .. automodule:: pypulseq.calc_duration
  39. :members:
  40. :undoc-members:
  41. :show-inheritance:
  42. pypulseq.calc\_ramp module
  43. --------------------------
  44. .. automodule:: pypulseq.calc_ramp
  45. :members:
  46. :undoc-members:
  47. :show-inheritance:
  48. pypulseq.calc\_rf\_bandwidth module
  49. -----------------------------------
  50. .. automodule:: pypulseq.calc_rf_bandwidth
  51. :members:
  52. :undoc-members:
  53. :show-inheritance:
  54. pypulseq.calc\_rf\_center module
  55. --------------------------------
  56. .. automodule:: pypulseq.calc_rf_center
  57. :members:
  58. :undoc-members:
  59. :show-inheritance:
  60. pypulseq.check\_timing module
  61. -----------------------------
  62. .. automodule:: pypulseq.check_timing
  63. :members:
  64. :undoc-members:
  65. :show-inheritance:
  66. pypulseq.compress\_shape module
  67. -------------------------------
  68. .. automodule:: pypulseq.compress_shape
  69. :members:
  70. :undoc-members:
  71. :show-inheritance:
  72. pypulseq.convert module
  73. -----------------------
  74. .. automodule:: pypulseq.convert
  75. :members:
  76. :undoc-members:
  77. :show-inheritance:
  78. pypulseq.decompress\_shape module
  79. ---------------------------------
  80. .. automodule:: pypulseq.decompress_shape
  81. :members:
  82. :undoc-members:
  83. :show-inheritance:
  84. pypulseq.event\_lib module
  85. --------------------------
  86. .. automodule:: pypulseq.event_lib
  87. :members:
  88. :undoc-members:
  89. :show-inheritance:
  90. pypulseq.make\_adc module
  91. -------------------------
  92. .. automodule:: pypulseq.make_adc
  93. :members:
  94. :undoc-members:
  95. :show-inheritance:
  96. pypulseq.make\_adiabatic\_pulse module
  97. --------------------------------------
  98. .. automodule:: pypulseq.make_adiabatic_pulse
  99. :members:
  100. :undoc-members:
  101. :show-inheritance:
  102. pypulseq.make\_arbitrary\_grad module
  103. -------------------------------------
  104. .. automodule:: pypulseq.make_arbitrary_grad
  105. :members:
  106. :undoc-members:
  107. :show-inheritance:
  108. pypulseq.make\_arbitrary\_rf module
  109. -----------------------------------
  110. .. automodule:: pypulseq.make_arbitrary_rf
  111. :members:
  112. :undoc-members:
  113. :show-inheritance:
  114. pypulseq.make\_block\_pulse module
  115. ----------------------------------
  116. .. automodule:: pypulseq.make_block_pulse
  117. :members:
  118. :undoc-members:
  119. :show-inheritance:
  120. pypulseq.make\_delay module
  121. ---------------------------
  122. .. automodule:: pypulseq.make_delay
  123. :members:
  124. :undoc-members:
  125. :show-inheritance:
  126. pypulseq.make\_digital\_output\_pulse module
  127. --------------------------------------------
  128. .. automodule:: pypulseq.make_digital_output_pulse
  129. :members:
  130. :undoc-members:
  131. :show-inheritance:
  132. pypulseq.make\_extended\_trapezoid module
  133. -----------------------------------------
  134. .. automodule:: pypulseq.make_extended_trapezoid
  135. :members:
  136. :undoc-members:
  137. :show-inheritance:
  138. pypulseq.make\_extended\_trapezoid\_area module
  139. -----------------------------------------------
  140. .. automodule:: pypulseq.make_extended_trapezoid_area
  141. :members:
  142. :undoc-members:
  143. :show-inheritance:
  144. pypulseq.make\_gauss\_pulse module
  145. ----------------------------------
  146. .. automodule:: pypulseq.make_gauss_pulse
  147. :members:
  148. :undoc-members:
  149. :show-inheritance:
  150. pypulseq.make\_label module
  151. ---------------------------
  152. .. automodule:: pypulseq.make_label
  153. :members:
  154. :undoc-members:
  155. :show-inheritance:
  156. pypulseq.make\_sigpy\_pulse module
  157. ----------------------------------
  158. .. automodule:: pypulseq.make_sigpy_pulse
  159. :members:
  160. :undoc-members:
  161. :show-inheritance:
  162. pypulseq.make\_sinc\_pulse module
  163. ---------------------------------
  164. .. automodule:: pypulseq.make_sinc_pulse
  165. :members:
  166. :undoc-members:
  167. :show-inheritance:
  168. pypulseq.make\_trapezoid module
  169. -------------------------------
  170. .. automodule:: pypulseq.make_trapezoid
  171. :members:
  172. :undoc-members:
  173. :show-inheritance:
  174. pypulseq.make\_trigger module
  175. -----------------------------
  176. .. automodule:: pypulseq.make_trigger
  177. :members:
  178. :undoc-members:
  179. :show-inheritance:
  180. pypulseq.opts module
  181. --------------------
  182. .. automodule:: pypulseq.opts
  183. :members:
  184. :undoc-members:
  185. :show-inheritance:
  186. pypulseq.points\_to\_waveform module
  187. ------------------------------------
  188. .. automodule:: pypulseq.points_to_waveform
  189. :members:
  190. :undoc-members:
  191. :show-inheritance:
  192. pypulseq.rotate module
  193. ----------------------
  194. .. automodule:: pypulseq.rotate
  195. :members:
  196. :undoc-members:
  197. :show-inheritance:
  198. pypulseq.scale\_grad module
  199. ---------------------------
  200. .. automodule:: pypulseq.scale_grad
  201. :members:
  202. :undoc-members:
  203. :show-inheritance:
  204. pypulseq.sigpy\_pulse\_opts module
  205. ----------------------------------
  206. .. automodule:: pypulseq.sigpy_pulse_opts
  207. :members:
  208. :undoc-members:
  209. :show-inheritance:
  210. pypulseq.split\_gradient module
  211. -------------------------------
  212. .. automodule:: pypulseq.split_gradient
  213. :members:
  214. :undoc-members:
  215. :show-inheritance:
  216. pypulseq.split\_gradient\_at module
  217. -----------------------------------
  218. .. automodule:: pypulseq.split_gradient_at
  219. :members:
  220. :undoc-members:
  221. :show-inheritance:
  222. pypulseq.supported\_labels\_rf\_use module
  223. ------------------------------------------
  224. .. automodule:: pypulseq.supported_labels_rf_use
  225. :members:
  226. :undoc-members:
  227. :show-inheritance:
  228. pypulseq.traj\_to\_grad module
  229. ------------------------------
  230. .. automodule:: pypulseq.traj_to_grad
  231. :members:
  232. :undoc-members:
  233. :show-inheritance:
  234. Module contents
  235. ---------------
  236. .. automodule:: pypulseq
  237. :members:
  238. :undoc-members:
  239. :show-inheritance: