API reference

Conceptual background is in Explanations and procedures in the user guide.

Page	Module	What it documents
Protocol	pulserver.protocol	The entries of a scanner protocol, their presets, and the text blocks that carry them between the design calls and the interpreter.
Scanner sequences	pulserver.design	SequencePlugin, which binds a function returning sequences to the scanner protocol, and the UI entries it is declared with.
Design calls	pulserver.host	The design calls of the interpreter host processes and the store of the designs they generate.
IR conversion	pulserver.ir	The segmentation of a sequence chain into the IR cache the interpreter loads.
Reconstruction proxy	pulserver.proxy	The reconstruction proxy, the designs it resolves a series to, and the enrichment it applies.
Reconstruction plugins	pulserver.recon	ReconPlugin, the context and buffers its hooks receive, and the results they return.
MRD data	pulserver.mrd	MRD acquisitions, header entries and images, and the definitions and readouts a sequence states.
Validation	pulserver.validate	Checking that a sequence plays as it was written, against a recording of a machine playing it or against its own cache.
Virtual scanner	pulserver.virtual	The virtual scanner: the trajectory a cache plays, a phantom acquired along it, and the virtual reconstruction client.

The C library a scanner interpreter links is documented in its public headers, src/c/include/pulseg/, starting from pulseg.h.