API reference#
Exact interfaces, units and defaults, grouped by the layer they belong to. Concepts are in Explanations and complete workflows in the examples.
Sequence representation#
Page |
Module |
Contents |
|---|---|---|
|
Sequence container, system limits and transforms of a finished sequence |
|
|
Reading and writing |
|
|
ADC, delay, trigger, label, rotation and RF-shim events; block operations; PyPulseq interoperability |
Event design#
Page |
Module |
Contents |
|---|---|---|
|
Trapezoid, arbitrary and wave-encoding gradients; scaling, splitting and combining; gradient audio |
|
|
RF pulses from basic to SLR, B1-selective, multidimensional and pTx designs; RF analysis and Bloch simulation |
|
|
Radial, spiral and rosette trajectories and their gradient waveforms |
|
|
ADC dwell times and durations on the ADC and gradient rasters; raster rounding |
Sequence construction#
Page |
Module |
Contents |
|---|---|---|
|
Cartesian masks, view ordering, EPI shot offsets, non-Cartesian orientations and RF schedules |
|
|
Excitation, preparation and readout modules; non-Cartesian interleaves |
|
|
Protocol parsing, labels, writing and timing of sequence functions |
|
|
Every shipped sequence, by family, with its reference page |
Analysis and tools#
Page |
Module |
Contents |
|---|---|---|
|
Gradient, slew-rate, continuity, mechanical-resonance, PNS and SAR checks |
|
|
SeqEyes view, publication diagram, k-space and RF-profile figures |
|
|
Running sequence functions and scripts from the shell |