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	What it documents
Sequence and system limits	pypulseqpp	The sequence container, the system limits a sequence is designed under, and the transforms applied to a finished one.
Reading and writing files	pypulseqpp.io	Reading a file into a sequence that carries the system it describes, and writing one out in either form.
Events and blocks	pypulseqpp	ADC, delay, trigger, label, rotation and RF-shim events, the operations that act on a block, and the conversions an upstream PyPulseq function is called through.

Event design

Page	Module	What it documents
Gradient design	pypulseqpp	Gradient events on one logical axis, from trapezoids and phase encodes to arbitrary and wave-encoding waveforms, and the operations that scale, split and combine them.
RF pulse design	pypulseqpp	RF events, from the basic factories to SLR, slice-encoding, B1-selective, multidimensional and parallel-transmit designs, and the analysis and Bloch simulation of what they produce.
Trajectory design	pypulseqpp	Radial, spiral and rosette k-space trajectories, and the gradient waveforms that trace them.
Timing and rasterization	pypulseqpp	ADC dwell times and acquisition durations solved against both the ADC and the gradient raster, and the quantization of a time to a raster.

Sequence construction

Page	Module	What it documents
Sampling and scan-loop schedules	pypulseqpp	Cartesian sampling support, the ordering of a selected set into loop, shot and echo positions, EPI shot offsets, non-Cartesian orientations, and per-repetition RF schedules.
Sequence modules	pypulseqpp.sequences	The excitation, preparation and readout modules, and the non-Cartesian interleaves a readout plays.
Complete sequences	pypulseqpp.sequences	SequenceApp, which holds a prescription, the sampling order derived from it, and the kernel one repetition plays.
Sequence catalogue	pypulseqpp.sequences	Every complete sequence the package ships, grouped by family, each with its own reference page.

Analysis and tools

Page	Module	What it documents
Gradient, PNS and SAR checks	pypulseqpp.safety	The gradient amplitude, slew-rate, continuity, mechanical-resonance, nerve-stimulation and SAR checks, and the readings they return beside a verdict.
Plotting	pypulseqpp.plot	The SeqEyes view, the publication diagram, and the k-space and RF-profile figures.
Command-line helpers	pypulseqpp.cli	Running a sequence application from the shell, and writing the file it produces.