MRD data

Acquisitions, header entries and images as a reconstruction plugin reads them, and the definitions and readouts a Pulseq sequence states.

The acquisition and header objects are those of the ismrmrd package; the functions here read flags, counters and user parameters from them by their MRD names. ReadoutTable and SequenceDefinitions are read from the sequence files of a design and are what the reconstruction proxy enriches a stream from (see Raw-data enrichment and routing).

Acquisitions

Object	Description
AcquisitionFlag	ISMRMRD acquisition flags as bit masks, combinable with |.
has_acquisition_flag	Whether an acquisition carries a flag.
acquisition_label	One encoding counter of an acquisition, by MRD field name.
acquisition_labels	The encoding space reference and every encoding counter of an acquisition.
AcquisitionBucket	Acquisitions accumulated up to a boundary, split as Gadgetron splits them.
AcquisitionBucketStats	Distinct values of each encoding counter in a bucket.

Header

Object	Description
MrdMetadata	Accessors over a parsed MRD XML header.
EncodingSpace	Buffer layout of one encoding space.
LOOP_COUNTERS	Encoding counters that become buffer axes when they vary, outermost first.
user_parameter	A header user parameter by name.
max_stored_value	Largest pixel value of the header’s stored bit depth.

Images

Object	Description
coil_combine	Combine the coil axis of a stack of coil images.
center_crop	Crop the trailing axes of an image to a centred window.
as_numpy	An array as NumPy on the host; Torch tensors are detached first.

Sequence definitions and readouts

Object	Description
read_chain	Read a sequence file and every file its NextSequence definitions name, in play order.
SequenceDefinitions	Definitions describing what a sequence acquires, in Pulseq units.
ReadoutTable	Every ADC readout of a sequence, in play order.