Taxonomy

DatasetEntry's field names, value vocabularies and units are anchored in the DICOM standard wherever DICOM has an attribute for the concept. A handful of fields have no DICOM equivalent; those are documented extensions, each with a one-line justification. This page is the reference for both, plus the ISMRMRD trajectory crosswalk and the external sources consulted while designing it.

Use dicom_tag/dicom_keyword to look the mapping up programmatically:

julia> dicom_tag(:field_strength)
(0x0018, 0x0087, "MagneticFieldStrength")

julia> dicom_keyword(:receiver_channels)  # an extension — no DICOM tag

Core fields → DICOM attributes

FieldDICOM attributeTag
nameSeries Description(0008,103E)
subject_idClinical Trial Subject ID(0012,0040)
repetitionAcquisition Number(0020,0012)
vendorManufacturer(0008,0070)
scanner_modelManufacturer Model Name(0008,1090)
institutionInstitution Name(0008,0080)
field_strengthMagnetic Field Strength (T)(0018,0087)
coil_dataImage Type, value 1(0008,0008)
anatomyBody Part Examined(0018,0015)
contrastAcquisition Contrast(0008,9209)
orientationView Code Sequence(0054,0220)
sequencePulse Sequence Name(0018,9005)
echo_typeEcho Pulse Sequence(0018,9008)
acquisition_dimMR Acquisition Type(0018,0023)
num_slicesNumber of Frames(0028,0008)
num_framesCardiac Number of Images(0018,1090)
num_averagesNumber of Averages(0018,0083)
fully_sampledPercent Sampling == 100(0018,0093)
partial_fourierPartial Fourier(0018,9081)
has_acsParallel Acquisition(0018,9077)
cardiac_syncCardiac Synchronization Technique(0018,9037)
phase_contrastPhase Contrast(0018,9014)
blood_signal_nullingBlood Signal Nulling(0018,9022)
fat_suppressionSpectrally Selected Suppression(0018,9025)
contrast_agentContrast/Bolus Agent(0018,0010)

source, id, approx_size_bytes, sha256, url, extra and locator are transport or identity fields, not imaging metadata, and are not DICOM-anchored.

extra keys → DICOM attributes

Populated per source (see extra_schema for what each source actually carries):

extra keyDICOM attributeTag
repetition_time_msRepetition Time(0018,0080)
echo_time_msEcho Time(0018,0081)
flip_angle_degFlip Angle(0018,1314)
reconstruction_fov_mmReconstruction Field of View(0018,9317)
acquisition_matrixAcquisition Matrix(0018,1310)
multi_coil_elementsMulti-Coil Definition Sequence (item count)(0018,9045)
acquisition_duration_classAcquisition Duration(0018,9073)
partial_fourier_directionPartial Fourier Direction(0018,9036)
protocol_nameProtocol Name(0018,1030)
parallel_reduction_factor_in_planeParallel Reduction Factor In-plane(0018,9069)

Modality (0008,0060) is MR for every entry in the package — a constant, stored nowhere. That is also why the old free-text modality key was retired: the name is taken by DICOM and means something else (see TAXONOMY_EXTENSIONS and the per-source decomposition into contrast/cardiac_sync/orientation/etc.).

The seven extensions

Each exists because DICOM has no attribute for the concept:

  • receiver_channels — DICOM enumerates coil elements in Multi-Coil Definition Sequence (0018,9045) with Multi-Coil Element Used (0018,9048); there is no count attribute. Anchored on ISMRMRD acquisitionSystemInformation/receiverChannels.
  • split — ML-corpus partition, not an imaging concept.
  • cohort — no DICOM research-subject-class attribute.
  • undersampling_pattern — Parallel Acquisition Technique (0018,9078) names the reconstruction (SENSE/SMASH/GRAPPA), not the sampling mask. VISTA, kt-Gaussian, kt-radial, Poisson-disc have no term.
  • orientation vocabulary — View Code Sequence (0054,0220) is the right container and takes SNOMED codes, but DICOM publishes no Context Group for cardiac MR views (the cardiac view CIDs are echocardiography). Local symbols for now; SNOMED coding is a later refinement, and codes must not be invented.
  • quantitative — DICOM's anchor is the Parametric Map Storage SOP class, an object type rather than an attribute. BIDS T1map/T2map suffix is the practical equivalent.
  • trajectory vocabulary — Geometry of k-Space Traversal (0018,9032) offers only RECTILINEAR/RADIAL/SPIRAL; EPI lives in Scanning Sequence (EP) and golden-angle is a radial ordering with no term. ISMRMRD's enum is strictly more expressive and is the package's output format (crosswalk below).
  • acceleration — Parallel Reduction Factor In-plane (0018,9069) is in-plane and parallel-imaging-specific. acceleration is net R, defined at the source's native frame binning; kept in extra["parallel_reduction_factor_in_plane"] when the DICOM value is separately known.

fully_sampled is not an extension: it is Percent Sampling (0018,0093) == 100. The boolean is kept for query ergonomics.

ISMRMRD trajectoryType crosswalk

DatasetEntry.trajectoryISMRMRD trajectoryTypeDICOM Geometry of k-Space Traversal
:cartesiancartesianRECTILINEAR
:epiepi(Scanning Sequence EP; no k-space-geometry term)
:radialradialRADIAL
:goldenanglegoldenangleRADIAL (ordering not representable)
:spiralspiralSPIRAL
:otherother—

External references consulted

Standards:

Dataset publications (source of the per-source protocol facts — field strength, coil counts, sequence names, sampling — that are not present in any committed CSV):

  • fastMRI Breast — 288 spokes, base readout matrix 512, 83 partitions → 192 slices, 16-channel breast coil, 3 T MAGNETOM TimTrio, golden-angle radial VIBE, partial Fourier 6/8. Nyquist spokes ≈ (π/2)·512 ≈ 804, hence net R ≈ 2.8. https://pmc.ncbi.nlm.nih.gov/articles/PMC11791504/ · https://arxiv.org/abs/2406.05270
  • USC 75-speaker speech rtMRI (Lim et al., Scientific Data 2021) — "The 13 spiral interleaves, when collected together, fulfil the Nyquist sampling rate"; TR 6.004 ms, TE 0.8 ms, FOV 200×200 mm, slice 6 mm, matrix 84×84, flip angle 15°, 8-channel upper-airway array, 1.5 T GE Signa Excite. https://www.nature.com/articles/s41597-021-00976-x
  • M4Raw (Lyu et al., Scientific Data 2023) — 0.3 T Oper-0.3 (Ningbo Xingaoyi), four-channel head coil, 18 axial slices, 5 mm thick, 0.94×1.23 mm in-plane, T1w/T2w TSE and FLAIR, 183 volunteers. https://www.nature.com/articles/s41597-023-02181-4
  • M4Raw GitHub repository / Zenodo record 8056074 — the M4RawV1.5 release notes and dataset card, source for the GRE contrast added after the original paper ("T1w Gradient echo (GRE) data for all 183 subjects are released"). https://github.com/mylyu/M4Raw
  • CMRxRecon2024 dataset paper (Wang et al., Radiology: Artificial Intelligence 2025) — source for the T1/T2 mapping and BlackBlood pulse sequences and views: "the modified Look-Locker inversion recovery-fast low angle shot sequence was used for T1 mapping" / "the T2-prepared-fast low angle shot sequence was used for T2 mapping", both "with SAX view"; "the turbo spin-echo sequence was used for black-blood under breath hold", "black-blood with SAX view"; "'TrueFISP' sequence for cine, phase-contrast (flow2d), and tagging". https://pubs.rsna.org/doi/10.1148/ryai.240443 · https://pmc.ncbi.nlm.nih.gov/articles/PMC11950877/

Notes on a few source-specific field values verified against those publications:

  • CMRxRecon T1/T2 mapping — SAX view for both T1map and T2map. T2 mapping is FLASH-based (spoiled gradient echo), not balanced SSFP.
  • CMRxRecon BlackBlood — the paper gives the sequence (turbo spin echo) and view (SAX) but no T1/T2 weighting (no TE/TR), so contrast = :unknown reflects a genuine gap in the source rather than a guess.
  • M4Raw "T1 GRE" — T1-weighted per the M4RawV1.5 dataset card, which post-dates the original Scientific Data paper.