Reconstruction plugins#

The interface a reconstruction is written against, and the runtime that drives it over an MRD stream.

A plugin file defines a ReconPlugin subclass and a module-level PLUGIN instance of it. The same hooks run over a live MRD stream in a worker of the reconstruction proxy, over an ISMRMRD HDF5 file (ReconPlugin.run()) and over an assembled AcquisitionBucket (calling the instance). The plugin reconstructs one unit of readouts at a time, as ReconData. Writing one is described in Reconstruction plugins. The image a ReconResult becomes takes its geometry from its unit and its values from its array, as Raw-data enrichment and routing states. Coil sensitivity maps, noise prewhitening and coil compression are the subject of Calibration, noise and coil compression.

Plugin#

Object	Description
`ReconPlugin`	Base class for reconstruction plugins.
`Gadget`	One per-acquisition step, run before a readout is placed.
`load_plugin`	Import a plugin file and return its `PLUGIN` instance.

Readout gadgets#

Object	Description
`AsymmetricEcho`	Zero-fill a partial echo to the full echo that is symmetric about its `center_sample`.
`Prewhiten`	Whiten the channels of each readout with the stream’s noise measurement.
`RemoveReadoutOversampling`	Crop a full echo to the readout field of view of the reconstruction.

Scan context#

Object	Description
`ReconContext`	Header, exam cache and configuration passed to every hook.
`ExamCache`	Thread-safe store of artifacts shared by the series of one exam.
`ExamImage`	A map one series measured, with its geometry, resampled onto a later series’ grid.
`B0_MAP`	Where a calibration scan leaves the off-resonance map, in Hz, for the series that follow.
`B1_MAP`	Where a calibration scan leaves the transmit field map, as a fraction of what was asked for.
`COIL_SENSITIVITIES`	Where a calibration scan leaves the receive coil sensitivities, a `CoilSensitivities`.
`NOISE_COVARIANCE`	Where a noise scan leaves the prewhitening of the exam, for the series that follow.
`EXAM_ARTIFACTS`	The maps a context carries as attributes of itself, each its own key in the exam cache.

Calibration#

Object	Description
`coil_maps`	Return the coil sensitivities of a unit from its calibration k-space, the stream or the exam.
`CoilSensitivities`	Receive coil sensitivity maps with the coils, prewhitening, compression and geometry they were estimated in.
`MissingCalibration`	No source holds coil sensitivities the unit can use.
`CoilCompression`	Reduce the receive channels of a unit’s k-space to virtual channels.

Buffers and results#

Object	Description
`ReconData`	The readouts of one reconstruction unit: imaging and calibration k-space, counters and waveforms.
`ReconBuffer`	K-space of one encoding space, filled one acquisition at a time, with the acquisition nearest the k-space centre.
`ReconResult`	Image array the runtime packages as an MRD image or DICOM dataset, with the acquisition its geometry is taken from and the rescale of its DICOM pixels.

Reconstruction plugins

Contents