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 and system limits

pypulseqpp

Sequence container, system limits and transforms of a finished sequence

Reading and writing files

pypulseqpp.io

Reading and writing .seq files, text and binary

Events and blocks

pypulseqpp

ADC, delay, trigger, label, rotation and RF-shim events; block operations; PyPulseq interoperability

Event design#

Page

Module

Contents

Gradient design

pypulseqpp

Trapezoid, arbitrary and wave-encoding gradients; scaling, splitting and combining; gradient audio

RF pulse design

pypulseqpp

RF pulses from basic to SLR, B1-selective, multidimensional and pTx designs; RF analysis and Bloch simulation

Trajectory design

pypulseqpp

Radial, spiral and rosette trajectories and their gradient waveforms

Timing and rasterization

pypulseqpp

ADC dwell times and durations on the ADC and gradient rasters; raster rounding

Sequence construction#

Page

Module

Contents

Sampling and scan-loop schedules

pypulseqpp

Cartesian masks, view ordering, EPI shot offsets, non-Cartesian orientations and RF schedules

Sequence modules

pypulseqpp.sequences

Excitation, preparation and readout modules; non-Cartesian interleaves

Sequence functions

pypulseqpp.sequences

Protocol parsing, labels, writing and timing of sequence functions

Sequence catalogue

pypulseqpp.sequences

Every shipped sequence, by family, with its reference page

Analysis and tools#

Page

Module

Contents

Gradient, PNS, acoustic and SAR checks

pypulseqpp.safety

Gradient, slew-rate, continuity, mechanical-resonance, PNS and SAR checks

Plotting

pypulseqpp.plot

SeqEyes view, publication diagram, k-space and RF-profile figures

Command-line helpers

pypulseqpp.cli

Running sequence functions and scripts from the shell