Skip to content

Appendix IV: Entity table

This section compiles the entities (key-value pairs) described throughout this specification, and establishes a common order within a filename.  For example, if a file has an acquisition and reconstruction label, the acquisition entity must precede the reconstruction entity. REQUIRED and OPTIONAL entities for a given file type are denoted. Entity formats indicate whether the value is alphanumeric (<label>) or numeric (<index>).

A general introduction to entities is given in the section on file name structure, while entity definitions are in Appendix IX.

Magnetic Resonance Imaging

Entity Subject Session Task Acquisition Contrast Enhancing Agent Reconstruction Phase-Encoding Direction Run Corresponding Modality Echo Flip Angle Inversion Time Magnetization Transfer Part Recording
Format sub-<label> ses-<label> task-<label> acq-<label> ce-<label> rec-<label> dir-<label> run-<index> mod-<label> echo-<index> flip-<index> inv-<index> mt-<label> part-<label> recording-<label>
anat
(T1w T2w PDw T2starw FLAIR inplaneT1 inplaneT2 PDT2 angio)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
anat
(T1map T2map T2starmap R1map R2map R2starmap PDmap MTRmap MTsat UNIT1 T1rho MWFmap MTVmap PDT2map Chimap TB1map RB1map S0map M0map)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
anat
(defacemask)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
anat
(MESE MEGRE)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL REQUIRED OPTIONAL
anat
(VFA)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL REQUIRED OPTIONAL
anat
(IRT1)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL REQUIRED OPTIONAL
anat
(MP2RAGE)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL REQUIRED REQUIRED OPTIONAL
anat
(MPM MTS)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL REQUIRED REQUIRED OPTIONAL
anat
(MTR)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL REQUIRED OPTIONAL
dwi
(dwi sbref)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
fmap
(phasediff phase1 phase2 magnitude1 magnitude2 magnitude fieldmap)
REQUIRED OPTIONAL OPTIONAL OPTIONAL
fmap
(epi m0scan)
REQUIRED OPTIONAL OPTIONAL OPTIONAL REQUIRED OPTIONAL
fmap
(TB1DAM)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL REQUIRED OPTIONAL
fmap
(TB1EPI)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL REQUIRED REQUIRED OPTIONAL
func
(bold cbv sbref)
REQUIRED OPTIONAL REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
func
(phase events)
REQUIRED OPTIONAL REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
func
(physio stim)
REQUIRED OPTIONAL REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL
perf
(asl m0scan aslcontext)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
perf
(asllabeling)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL

Encephalography (EEG, iEEG, and MEG)

Entity Subject Session Task Acquisition Run Processed (on device) Space Split
Format sub-<label> ses-<label> task-<label> acq-<label> run-<index> proc-<label> space-<label> split-<index>
eeg
(eeg)
REQUIRED OPTIONAL REQUIRED OPTIONAL OPTIONAL
ieeg
(ieeg)
REQUIRED OPTIONAL REQUIRED OPTIONAL OPTIONAL
meg
(meg)
REQUIRED OPTIONAL REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL
meg
(headshape)
REQUIRED OPTIONAL OPTIONAL OPTIONAL
meg
(markers)
REQUIRED OPTIONAL OPTIONAL OPTIONAL OPTIONAL
channels
(meg eeg ieeg)
REQUIRED OPTIONAL REQUIRED OPTIONAL OPTIONAL
electrodes
(eeg ieeg)
REQUIRED OPTIONAL OPTIONAL OPTIONAL
events
(meg eeg ieeg)
REQUIRED OPTIONAL REQUIRED OPTIONAL OPTIONAL
photo
(meg eeg ieeg)
REQUIRED OPTIONAL OPTIONAL

Behavioral Data

Entity Subject Session Task Acquisition Run Recording
Format sub-<label> ses-<label> task-<label> acq-<label> run-<index> recording-<label>
beh
(stim physio)
REQUIRED OPTIONAL REQUIRED OPTIONAL OPTIONAL OPTIONAL
beh
(events beh)
REQUIRED OPTIONAL REQUIRED OPTIONAL OPTIONAL