Appendix XIV: Glossary of schema objects
This section compiles the object definitions in the schema.
Acknowledgements (metadata)
name: Acknowledgements
description:
Text acknowledging contributions of individuals or institutions beyond those listed in Authors or Funding.
schema information:
{'display_name': 'Acknowledgements', 'type': 'string'}
AcquisitionDuration (metadata)
name: Acquisition Duration
description:
Duration (in seconds) of volume acquisition. Corresponds to DICOM Tag 0018, 9073
Acquisition Duration
. This field is mutually exclusive with"RepetitionTime"
.
schema information:
{'display_name': 'Acquisition Duration', 'type': 'number', 'exclusiveMinimum': 0, 'unit': 's'}
AcquisitionMode (metadata)
name: Acquisition Mode
description:
Type of acquisition of the PET data (for example,
"list mode"
).
schema information:
{'display_name': 'Acquisition Mode', 'type': 'string'}
AcquisitionVoxelSize (metadata)
name: Acquisition Voxel Size
description:
An array of numbers with a length of 3, in millimeters. This parameter denotes the original acquisition voxel size, excluding any inter-slice gaps and before any interpolation or resampling within reconstruction or image processing. Any point spread function effects, for example due to T2-blurring, that would decrease the effective resolution are not considered here.
schema information:
{'display_name': 'Acquisition Voxel Size', 'type': 'array', 'minItems': 3, 'maxItems': 3, 'items': {'type': 'number', 'exclusiveMinimum': 0, 'unit': 'mm'}}
Anaesthesia (metadata)
name: Anaesthesia
description:
Details of anaesthesia used, if any.
schema information:
{'display_name': 'Anaesthesia', 'type': 'string'}
AnalyticalApproach (metadata)
name: Analytical Approach
description:
Methodology or methodologies used to analyse the
"GeneticLevel"
. Values MUST be taken from the database of Genotypes and Phenotypes (dbGaP) under /Study/Molecular Data Type (for example, SNP Genotypes (Array) or Methylation (CpG).
schema information:
{'display_name': 'Analytical Approach', 'anyOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}]}
AnatomicalLandmarkCoordinateSystem (metadata)
name: Anatomical Landmark Coordinate System
description:
Defines the coordinate system for the anatomical landmarks. See Appendix VIII for a list of restricted keywords for coordinate systems. If
"Other"
, provide definition of the coordinate system in"AnatomicalLandmarkCoordinateSystemDescription"
.
schema information:
{'display_name': 'Anatomical Landmark Coordinate System', 'type': 'string', 'enum': ['CTF', 'ElektaNeuromag', '4DBti', 'KitYokogawa', 'ChietiItab', 'Other', 'CapTrak', 'EEGLAB', 'EEGLAB-HJ', 'Other', 'ICBM452AirSpace', 'ICBM452Warp5Space', 'IXI549Space', 'fsaverage', 'fsaverageSym', 'fsLR', 'MNIColin27', 'MNI152Lin', 'MNI152NLin2009aSym', 'MNI152NLin2009bSym', 'MNI152NLin2009cSym', 'MNI152NLin2009aAsym', 'MNI152NLin2009bAsym', 'MNI152NLin2009cAsym', 'MNI152NLin6Sym', 'MNI152NLin6ASym', 'MNI305', 'NIHPD', 'OASIS30AntsOASISAnts', 'OASIS30Atropos', 'Talairach', 'UNCInfant', 'fsaverage3', 'fsaverage4', 'fsaverage5', 'fsaverage6', 'fsaveragesym', 'UNCInfant0V21', 'UNCInfant1V21', 'UNCInfant2V21', 'UNCInfant0V22', 'UNCInfant1V22', 'UNCInfant2V22', 'UNCInfant0V23', 'UNCInfant1V23', 'UNCInfant2V23']}
AnatomicalLandmarkCoordinateSystemDescription (metadata)
name: Anatomical Landmark Coordinate System Description
description:
Free-form text description of the coordinate system. May also include a link to a documentation page or paper describing the system in greater detail.
schema information:
{'display_name': 'Anatomical Landmark Coordinate System Description', 'type': 'string'}
AnatomicalLandmarkCoordinateUnits (metadata)
name: Anatomical Landmark Coordinate Units
description:
Units of the coordinates of
"AnatomicalLandmarkCoordinateSystem"
.
schema information:
{'display_name': 'Anatomical Landmark Coordinate Units', 'type': 'string', 'enum': ['m', 'mm', 'cm', 'n/a']}
AnatomicalLandmarkCoordinates sense 1 (metadata)
name: Anatomical Landmark Coordinates
description:
Key-value pairs of the labels and 3-D digitized locations of anatomical landmarks, interpreted following the
"AnatomicalLandmarkCoordinateSystem"
(for example,{"NAS": [12.7,21.3,13.9], "LPA": [5.2,11.3,9.6], "RPA": [20.2,11.3,9.1]}
. Each array MUST contain three numeric values corresponding to x, y, and z axis of the coordinate system in that exact order.
schema information:
{'display_name': 'Anatomical Landmark Coordinates', 'type': 'object', 'additionalProperties': {'type': 'array', 'items': {'type': 'number'}, 'minItems': 3, 'maxItems': 3}}
AnatomicalLandmarkCoordinates sense 2 (metadata)
name: Anatomical Landmark Coordinates
description:
Key-value pairs of any number of additional anatomical landmarks and their coordinates in voxel units (where first voxel has index 0,0,0) relative to the associated anatomical MRI (for example,
{"AC": [127,119,149], "PC": [128,93,141], "IH": [131,114,206]}
, or{"NAS": [127,213,139], "LPA": [52,113,96], "RPA": [202,113,91]}
). Each array MUST contain three numeric values corresponding to x, y, and z axis of the coordinate system in that exact order.
schema information:
{'display_name': 'Anatomical Landmark Coordinates', 'type': 'object', 'additionalProperties': {'type': 'array', 'items': {'type': 'number'}, 'minItems': 3, 'maxItems': 3}}
Any (extensions)
name: Any Extension
description:
Any extension is allowed.
schema information:
{'value': '.*', 'display_name': 'Any Extension'}
ArterialSpinLabelingType (metadata)
name: Arterial Spin Labeling Type
description:
The arterial spin labeling type.
schema information:
{'display_name': 'Arterial Spin Labeling Type', 'type': 'string', 'enum': ['CASL', 'PCASL', 'PASL']}
AssociatedEmptyRoom (metadata)
name: Associated Empty Room
description:
A path pointing to an empty-room file associated with the subject's MEG recording. The path is relative to the BIDS dataset root. The path needs to use forward slashes instead of backward slashes (for example, "sub-emptyroom/ses-rest/meg/sub-emptyroom_ses-rest_task-noise_run-01_meg.ds"). Supplying a list of several paths to empty-room files is possible.
schema information:
{'display_name': 'Associated Empty Room', 'anyOf': [{'type': 'array', 'items': {'type': 'string', 'format': 'dataset_relative'}}, {'type': 'string', 'format': 'dataset_relative'}]}
Atlas (metadata)
name: Atlas
description:
Which atlas (if any) was used to generate the mask.
schema information:
{'display_name': 'Atlas', 'type': 'string'}
AttenuationCorrection (metadata)
name: Attenuation Correction
description:
Short description of the attenuation correction method used.
schema information:
{'display_name': 'Attenuation Correction', 'type': 'string'}
AttenuationCorrectionMethodReference (metadata)
name: Attenuation Correction Method Reference
description:
Reference paper for the attenuation correction method used.
schema information:
{'display_name': 'Attenuation Correction Method Reference', 'type': 'string'}
Authors (metadata)
name: Authors
description:
List of individuals who contributed to the creation/curation of the dataset.
schema information:
{'display_name': 'Authors', 'type': 'array', 'items': {'type': 'string'}}
B0FieldIdentifier (metadata)
name: B0 Field Identifier
description:
The presence of this key states that this particular 3D or 4D image MAY be used for fieldmap estimation purposes. Each
"B0FieldIdentifier"
MUST be a unique string within one participant's tree, shared only by the images meant to be used as inputs for the estimation of a particular instance of the B0 field estimation. It is RECOMMENDED to derive this identifier from DICOM Tags, for example, DICOM tag 0018, 1030Protocol Name
, or DICOM tag 0018, 0024Sequence Name
when the former is not defined (for example, in GE devices.)
schema information:
{'display_name': 'B0 Field Identifier', 'anyOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}]}
B0FieldSource (metadata)
name: B0 Field Source
description:
At least one existing
"B0FieldIdentifier"
defined by images in the participant's tree. This field states the B0 field estimation designated by the"B0FieldIdentifier"
that may be used to correct the dataset for distortions caused by B0 inhomogeneities."B0FieldSource"
and"B0FieldIdentifier"
MAY both be present for images that are used to estimate their own B0 field, for example, in "pepolar" acquisitions.
schema information:
{'display_name': 'B0 Field Source', 'anyOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}]}
BF (suffixes)
name: Bright-field microscopy
description:
Bright-field microscopy imaging data
schema information:
{'value': 'BF', 'display_name': 'Bright-field microscopy'}
BIDSVersion (metadata)
name: BIDS Version
description:
The version of the BIDS standard that was used.
schema information:
{'display_name': 'BIDS Version', 'type': 'string'}
BackgroundSuppression (metadata)
name: Background Suppression
description:
Boolean indicating if background suppression is used.
schema information:
{'display_name': 'Background Suppression', 'type': 'boolean'}
BackgroundSuppressionNumberPulses (metadata)
name: Background Suppression Number Pulses
description:
The number of background suppression pulses used. Note that this excludes any effect of background suppression pulses applied before the labeling.
schema information:
{'display_name': 'Background Suppression Number Pulses', 'type': 'number', 'minimum': 0}
BackgroundSuppressionPulseTime (metadata)
name: Background Suppression Pulse Time
description:
Array of numbers containing timing, in seconds, of the background suppression pulses with respect to the start of the labeling. In case of multi-PLD with different background suppression pulse times, only the pulse time of the first PLD should be defined.
schema information:
{'display_name': 'Background Suppression Pulse Time', 'type': 'array', 'items': {'type': 'number', 'minimum': 0, 'unit': 's'}}
BasedOn (metadata)
name: Based On
description:
List of files in a file collection to generate the map. Fieldmaps are also listed, if involved in the processing.
schema information:
{'display_name': 'Based On', 'anyOf': [{'type': 'string', 'format': 'participant_relative'}, {'type': 'array', 'items': {'type': 'string', 'format': 'participant_relative'}}]}
BloodDensity (metadata)
name: Blood Density
description:
Measured blood density. Unit of blood density should be in
"g/mL"
.
schema information:
{'display_name': 'Blood Density', 'type': 'number', 'unit': 'g/mL'}
BodyPart (metadata)
name: Body Part
description:
Body part of the organ / body region scanned.
schema information:
{'display_name': 'Body Part', 'type': 'string'}
BodyPartDetails (metadata)
name: Body Part Details
description:
Additional details about body part or location (for example:
"corpus callosum"
).
schema information:
{'display_name': 'Body Part Details', 'type': 'string'}
BodyPartDetailsOntology (metadata)
name: Body Part Details Ontology
description:
URI of ontology used for BodyPartDetails (for example:
"https://www.ebi.ac.uk/ols/ontologies/uberon"
).
schema information:
{'display_name': 'Body Part Details Ontology', 'type': 'string', 'format': 'uri'}
BolusCutOffDelayTime (metadata)
name: Bolus Cut Off Delay Time
description:
Duration between the end of the labeling and the start of the bolus cut-off saturation pulse(s), in seconds. This can be a number or array of numbers, of which the values must be non-negative and monotonically increasing, depending on the number of bolus cut-off saturation pulses. For Q2TIPS, only the values for the first and last bolus cut-off saturation pulses are provided. Based on DICOM Tag 0018, 925F
ASL Bolus Cut-off Delay Time
.
schema information:
{'display_name': 'Bolus Cut Off Delay Time', 'anyOf': [{'type': 'number', 'minimum': 0, 'unit': 's'}, {'type': 'array', 'items': {'type': 'number', 'unit': 's', 'minimum': 0}}]}
BolusCutOffFlag (metadata)
name: Bolus Cut Off Flag
description:
Boolean indicating if a bolus cut-off technique is used. Corresponds to DICOM Tag 0018, 925C
ASL Bolus Cut-off Flag
.
schema information:
{'display_name': 'Bolus Cut Off Flag', 'type': 'boolean'}
BolusCutOffTechnique (metadata)
name: Bolus Cut Off Technique
description:
Name of the technique used, for example
"Q2TIPS"
,"QUIPSS"
,"QUIPSSII"
. Corresponds to DICOM Tag 0018, 925EASL Bolus Cut-off Technique
.
schema information:
{'display_name': 'Bolus Cut Off Technique', 'type': 'string'}
BrainLocation (metadata)
name: Brain Location
description:
Refers to the location in space of the
"TissueOrigin"
. Values may be an MNI coordinate, a label taken from the Allen Brain Atlas, or layer to refer to layer-specific gene expression, which can also tie up with laminar fMRI.
schema information:
{'display_name': 'Brain Location', 'type': 'string'}
CARS (suffixes)
name: Coherent anti-Stokes Raman spectroscopy
description:
Coherent anti-Stokes Raman spectroscopy imaging data
schema information:
{'value': 'CARS', 'display_name': 'Coherent anti-Stokes Raman spectroscopy'}
CASLType (metadata)
name: CASL Type
description:
Describes if a separate coil is used for labeling.
schema information:
{'display_name': 'CASL Type', 'type': 'string', 'enum': ['single-coil', 'double-coil']}
CHANGES (top_level_files)
name: Change log
description:
Version history of the dataset (describing changes, updates and corrections) MAY be provided in the form of a
CHANGES
text file. This file MUST follow the CPAN Changelog convention. TheCHANGES
file MUST be either in ASCII or UTF-8 encoding.
schema information:
{'display_name': 'Change log'}
CONF (suffixes)
name: Confocal microscopy
description:
Confocal microscopy imaging data
schema information:
{'value': 'CONF', 'display_name': 'Confocal microscopy'}
CTF (extensions)
name: CTF MEG Dataset Folder
description:
A folder for MEG data, typically containing a
.meg4
file for the data and a.res4
file for the resources.
schema information:
{'value': '.ds/', 'display_name': 'CTF MEG Dataset Folder'}
CapManufacturer (metadata)
name: Cap Manufacturer
description:
Name of the cap manufacturer (for example,
"EasyCap"
).
schema information:
{'display_name': 'Cap Manufacturer', 'type': 'string'}
CapManufacturersModelName (metadata)
name: Cap Manufacturers Model Name
description:
Manufacturer's designation of the EEG cap model (for example,
"actiCAP 64 Ch Standard-2"
).
schema information:
{'display_name': 'Cap Manufacturers Model Name', 'type': 'string'}
CellType (metadata)
name: Cell Type
description:
Describes the type of cell analyzed. Values SHOULD come from the cell ontology.
schema information:
{'display_name': 'Cell Type', 'type': 'string'}
Chimap (suffixes)
name: Quantitative susceptibility map (QSM)
description:
In parts per million (ppm). QSM allows for determining the underlying magnetic susceptibility of tissue (Chi) (Wang & Liu, 2014). Chi maps are REQUIRED to use this suffix regardless of the method used to generate them.
schema information:
{'value': 'Chimap', 'display_name': 'Quantitative susceptibility map (QSM)', 'unit': 'ppm'}
ChunkTransformationMatrix (metadata)
name: Chunk Transformation Matrix
description:
3x3 or 4x4 affine transformation matrix describing spatial chunk transformation, for 2D and 3D respectively (for examples:
[[2, 0, 0], [0, 3, 0], [0, 0, 1]]
in 2D for 2x and 3x scaling along the first and second axis respectively; or[[1, 0, 0, 0], [0, 2, 0, 0], [0, 0, 3, 0], [0, 0, 0, 1]]
in 3D for 2x and 3x scaling along the second and third axis respectively). Note that non-spatial dimensions like time and channel are not included in the transformation matrix.
schema information:
{'display_name': 'Chunk Transformation Matrix', 'anyOf': [{'type': 'array', 'minItems': 3, 'maxItems': 3, 'items': {'type': 'array', 'minItems': 3, 'maxItems': 3, 'items': {'type': 'number'}}}, {'type': 'array', 'minItems': 4, 'maxItems': 4, 'items': {'type': 'array', 'minItems': 4, 'maxItems': 4, 'items': {'type': 'number'}}}]}
ChunkTransformationMatrixAxis (metadata)
name: Chunk Transformation Matrix Axis
description:
Describe the axis of the ChunkTransformationMatrix (for examples:
["X", "Y"]
or["Z", "Y", "X"]
).
schema information:
{'display_name': 'Chunk Transformation Matrix Axis', 'type': 'array', 'items': {'type': 'string', 'minItems': 2, 'maxItems': 3}}
Code (metadata)
name: Code
description:
URI of the code used to present the stimuli. Persistent identifiers such as DOIs are preferred. If multiple versions of code may be hosted at the same location, revision-specific URIs are recommended.
schema information:
{'display_name': 'Code', 'type': 'string', 'format': 'uri'}
CogAtlasID (metadata)
name: Cognitive Atlas ID
description:
URI of the corresponding Cognitive Atlas Task term.
schema information:
{'display_name': 'Cognitive Atlas ID', 'type': 'string', 'format': 'uri'}
CogPOID (metadata)
name: Cognitive Paradigm Ontology ID
description:
schema information:
{'display_name': 'Cognitive Paradigm Ontology ID', 'type': 'string', 'format': 'uri'}
CoilCombinationMethod (metadata)
name: Coil Combination Method
description:
Almost all fMRI studies using phased-array coils use root-sum-of-squares (rSOS) combination, but other methods exist. The image reconstruction is changed by the coil combination method (as for the matrix coil mode above), so anything non-standard should be reported.
schema information:
{'display_name': 'Coil Combination Method', 'type': 'string'}
Columns (metadata)
name: Columns
description:
Names of columns in file.
schema information:
{'display_name': 'Columns', 'type': 'array', 'items': {'type': 'string'}}
ContinuousHeadLocalization (metadata)
name: Continuous Head Localization
description:
true
orfalse
value indicating whether continuous head localisation was performed.
schema information:
{'display_name': 'Continuous Head Localization', 'type': 'boolean'}
ContrastBolusIngredient (metadata)
name: Contrast Bolus Ingredient
description:
Active ingredient of agent. Corresponds to DICOM Tag 0018, 1048
Contrast/Bolus Ingredient
.
schema information:
{'display_name': 'Contrast Bolus Ingredient', 'type': 'string', 'enum': ['IODINE', 'GADOLINIUM', 'CARBON DIOXIDE', 'BARIUM', 'XENON']}
DCOffsetCorrection (metadata)
name: DC Offset Correction
description:
A description of the method (if any) used to correct for a DC offset. If the method used was subtracting the mean value for each channel, use "mean".
schema information:
{'display_name': 'DC Offset Correction', 'type': 'string'}
DF (suffixes)
name: Dark-field microscopy
description:
Dark-field microscopy imaging data
schema information:
{'value': 'DF', 'display_name': 'Dark-field microscopy'}
DIC (suffixes)
name: Differential interference contrast microscopy
description:
Differential interference contrast microscopy imaging data
schema information:
{'value': 'DIC', 'display_name': 'Differential interference contrast microscopy'}
DatasetDOI (metadata)
name: DatasetDOI
description:
The Digital Object Identifier of the dataset (not the corresponding paper). DOIs SHOULD be expressed as a valid URI; bare DOIs such as
10.0.2.3/dfjj.10
are DEPRECATED.
schema information:
{'display_name': 'DatasetDOI', 'type': 'string', 'format': 'uri'}
DatasetType (metadata)
name: Dataset Type
description:
The interpretation of the dataset. For backwards compatibility, the default value is
"raw"
.
schema information:
{'display_name': 'Dataset Type', 'type': 'string', 'enum': ['raw', 'derivative']}
DecayCorrectionFactor (metadata)
name: Decay Correction Factor
description:
Decay correction factor for each frame.
schema information:
{'display_name': 'Decay Correction Factor', 'type': 'array', 'items': {'type': 'number'}}
DelayAfterTrigger (metadata)
name: Delay After Trigger
description:
Duration (in seconds) from trigger delivery to scan onset. This delay is commonly caused by adjustments and loading times. This specification is entirely independent of
"NumberOfVolumesDiscardedByScanner"
or"NumberOfVolumesDiscardedByUser"
, as the delay precedes the acquisition.
schema information:
{'display_name': 'Delay After Trigger', 'type': 'number', 'unit': 's'}
DelayTime (metadata)
name: Delay Time
description:
User specified time (in seconds) to delay the acquisition of data for the following volume. If the field is not present it is assumed to be set to zero. Corresponds to Siemens CSA header field
lDelayTimeInTR
. This field is REQUIRED for sparse sequences using the"RepetitionTime"
field that do not have the"SliceTiming"
field set to allowed for accurate calculation of "acquisition time". This field is mutually exclusive with"VolumeTiming"
.
schema information:
{'display_name': 'Delay Time', 'type': 'number', 'unit': 's'}
Density (metadata)
name: Density
description:
Specifies the interpretation of the density keyword. If an object is used, then the keys should be values for the
den
entity and values should be descriptions of thoseden
values.
schema information:
{'display_name': 'Density', 'anyOf': [{'type': 'string'}, {'type': 'object', 'additionalProperties': {'type': 'string'}}]}
Derivative (metadata)
name: Derivative
description:
Indicates that values in the corresponding column are transformations of values from other columns (for example a summary score based on a subset of items in a questionnaire).
schema information:
{'display_name': 'Derivative', 'type': 'boolean'}
Description (metadata)
name: Description
description:
Free-form natural language description.
schema information:
{'display_name': 'Description', 'type': 'string'}
DeviceSerialNumber (metadata)
name: Device Serial Number
description:
The serial number of the equipment that produced the measurements. A pseudonym can also be used to prevent the equipment from being identifiable, so long as each pseudonym is unique within the dataset.
schema information:
{'display_name': 'Device Serial Number', 'type': 'string'}
DewarPosition (metadata)
name: Dewar Position
description:
Position of the dewar during the MEG scan:
"upright"
,"supine"
or"degrees"
of angle from vertical: for example on CTF systems,"upright=15°, supine=90°"
.
schema information:
{'display_name': 'Dewar Position', 'type': 'string'}
DigitizedHeadPoints sense 1 (metadata)
name: Digitized Head Points
description:
true
orfalse
value indicating whether head points outlining the scalp/face surface are contained within this recording.
schema information:
{'display_name': 'Digitized Head Points', 'type': 'boolean'}
DigitizedHeadPoints sense 2 (metadata)
name: Digitized Head Points
description:
Relative path to the file containing the locations of digitized head points collected during the session (for example,
"sub-01_headshape.pos"
). RECOMMENDED for all MEG systems, especially for CTF and BTi/4D. For Elekta/Neuromag the head points will be stored in the fif file.
schema information:
{'display_name': 'Digitized Head Points', 'type': 'string', 'format': 'file_relative'}
DigitizedHeadPointsCoordinateSystem (metadata)
name: Digitized Head Points Coordinate System
description:
Defines the coordinate system for the digitized head points. See Appendix VIII for a list of restricted keywords for coordinate systems. If
"Other"
, provide definition of the coordinate system in"DigitizedHeadPointsCoordinateSystemDescription"
.
schema information:
{'display_name': 'Digitized Head Points Coordinate System', 'type': 'string', 'enum': ['CTF', 'ElektaNeuromag', '4DBti', 'KitYokogawa', 'ChietiItab', 'Other', 'CapTrak', 'EEGLAB', 'EEGLAB-HJ', 'Other', 'ICBM452AirSpace', 'ICBM452Warp5Space', 'IXI549Space', 'fsaverage', 'fsaverageSym', 'fsLR', 'MNIColin27', 'MNI152Lin', 'MNI152NLin2009aSym', 'MNI152NLin2009bSym', 'MNI152NLin2009cSym', 'MNI152NLin2009aAsym', 'MNI152NLin2009bAsym', 'MNI152NLin2009cAsym', 'MNI152NLin6Sym', 'MNI152NLin6ASym', 'MNI305', 'NIHPD', 'OASIS30AntsOASISAnts', 'OASIS30Atropos', 'Talairach', 'UNCInfant', 'fsaverage3', 'fsaverage4', 'fsaverage5', 'fsaverage6', 'fsaveragesym', 'UNCInfant0V21', 'UNCInfant1V21', 'UNCInfant2V21', 'UNCInfant0V22', 'UNCInfant1V22', 'UNCInfant2V22', 'UNCInfant0V23', 'UNCInfant1V23', 'UNCInfant2V23']}
DigitizedHeadPointsCoordinateSystemDescription (metadata)
name: Digitized Head Points Coordinate System Description
description:
Free-form text description of the coordinate system. May also include a link to a documentation page or paper describing the system in greater detail.
schema information:
{'display_name': 'Digitized Head Points Coordinate System Description', 'type': 'string'}
DigitizedHeadPointsCoordinateUnits (metadata)
name: Digitized Head Points Coordinate Units
description:
Units of the coordinates of
"DigitizedHeadPointsCoordinateSystem"
.
schema information:
{'display_name': 'Digitized Head Points Coordinate Units', 'type': 'string', 'enum': ['m', 'mm', 'cm', 'n/a']}
DigitizedLandmarks (metadata)
name: Digitized Landmarks
description:
true
orfalse
value indicating whether anatomical landmark points (fiducials) are contained within this recording.
schema information:
{'display_name': 'Digitized Landmarks', 'type': 'boolean'}
Directory (extensions)
name: Folder
description:
A folder with no extension. Corresponds to BTi/4D data.
schema information:
{'value': '/', 'display_name': 'Folder'}
DispersionConstant (metadata)
name: Dispersion Constant
description:
External dispersion time constant resulting from tubing in default unit seconds.
schema information:
{'display_name': 'Dispersion Constant', 'type': 'number', 'unit': 's'}
DispersionCorrected (metadata)
name: Dispersion Corrected
description:
Boolean flag specifying whether the blood data have been dispersion-corrected. NOTE: not customary for manual samples, and hence should be set to
false
.
schema information:
{'display_name': 'Dispersion Corrected', 'type': 'boolean'}
DoseCalibrationFactor (metadata)
name: Dose Calibration Factor
description:
Multiplication factor used to transform raw data (in counts/sec) to meaningful unit (Bq/ml). Corresponds to DICOM Tag 0054, 1322
Dose Calibration Factor
.
schema information:
{'display_name': 'Dose Calibration Factor', 'type': 'number'}
DwellTime (metadata)
name: Dwell Time
description:
Actual dwell time (in seconds) of the receiver per point in the readout direction, including any oversampling. For Siemens, this corresponds to DICOM field 0019, 1018 (in ns). This value is necessary for the optional readout distortion correction of anatomicals in the HCP Pipelines. It also usefully provides a handle on the readout bandwidth, which isn't captured in the other metadata tags. Not to be confused with
"EffectiveEchoSpacing"
, and the frequent mislabeling of echo spacing (which is spacing in the phase encoding direction) as "dwell time" (which is spacing in the readout direction).
schema information:
{'display_name': 'Dwell Time', 'type': 'number', 'unit': 's'}
ECGChannelCount (metadata)
name: ECG Channel Count
description:
Number of ECG channels.
schema information:
{'display_name': 'ECG Channel Count', 'type': 'integer', 'minimum': 0}
ECOGChannelCount (metadata)
name: ECOG Channel Count
description:
Number of ECoG channels.
schema information:
{'display_name': 'ECOG Channel Count', 'type': 'integer', 'minimum': 0}
EEGChannelCount (metadata)
name: EEG Channel Count
description:
Number of EEG channels recorded simultaneously (for example,
21
).
schema information:
{'display_name': 'EEG Channel Count', 'type': 'integer', 'minimum': 0}
EEGCoordinateSystem (metadata)
name: EEG Coordinate System
description:
Defines the coordinate system for the EEG sensors.
See Appendix VIII for a list of restricted keywords for coordinate systems. If"Other"
, provide definition of the coordinate system inEEGCoordinateSystemDescription
.
schema information:
{'display_name': 'EEG Coordinate System', 'type': 'string', 'enum': ['CTF', 'ElektaNeuromag', '4DBti', 'KitYokogawa', 'ChietiItab', 'Other', 'CapTrak', 'EEGLAB', 'EEGLAB-HJ', 'Other', 'ICBM452AirSpace', 'ICBM452Warp5Space', 'IXI549Space', 'fsaverage', 'fsaverageSym', 'fsLR', 'MNIColin27', 'MNI152Lin', 'MNI152NLin2009aSym', 'MNI152NLin2009bSym', 'MNI152NLin2009cSym', 'MNI152NLin2009aAsym', 'MNI152NLin2009bAsym', 'MNI152NLin2009cAsym', 'MNI152NLin6Sym', 'MNI152NLin6ASym', 'MNI305', 'NIHPD', 'OASIS30AntsOASISAnts', 'OASIS30Atropos', 'Talairach', 'UNCInfant', 'fsaverage3', 'fsaverage4', 'fsaverage5', 'fsaverage6', 'fsaveragesym', 'UNCInfant0V21', 'UNCInfant1V21', 'UNCInfant2V21', 'UNCInfant0V22', 'UNCInfant1V22', 'UNCInfant2V22', 'UNCInfant0V23', 'UNCInfant1V23', 'UNCInfant2V23']}
EEGCoordinateSystemDescription (metadata)
name: EEG Coordinate System Description
description:
Free-form text description of the coordinate system. May also include a link to a documentation page or paper describing the system in greater detail.
schema information:
{'display_name': 'EEG Coordinate System Description', 'type': 'string'}
EEGCoordinateUnits (metadata)
name: EEG Coordinate Units
description:
Units of the coordinates of
EEGCoordinateSystem
.
schema information:
{'display_name': 'EEG Coordinate Units', 'type': 'string', 'enum': ['m', 'mm', 'cm', 'n/a']}
EEGGround (metadata)
name: EEG Ground
description:
Description of the location of the ground electrode (for example,
"placed on right mastoid (M2)"
).
schema information:
{'display_name': 'EEG Ground', 'type': 'string'}
EEGPlacementScheme (metadata)
name: EEG Placement Scheme
description:
Placement scheme of EEG electrodes. Either the name of a standardized placement system (for example,
"10-20"
) or a list of standardized electrode names (for example,["Cz", "Pz"]
).
schema information:
{'display_name': 'EEG Placement Scheme', 'type': 'string'}
EEGReference (metadata)
name: EEG Reference
description:
General description of the reference scheme used and (when applicable) of location of the reference electrode in the raw recordings (for example,
"left mastoid"
,"Cz"
,"CMS"
). If different channels have a different reference, this field should have a general description and the channel specific reference should be defined in thechannels.tsv
file.
schema information:
{'display_name': 'EEG Reference', 'type': 'string'}
EMGChannelCount (metadata)
name: EMG Channel Count
description:
Number of EMG channels.
schema information:
{'display_name': 'EMG Channel Count', 'type': 'integer', 'minimum': 0}
EOGChannelCount (metadata)
name: EOG Channel Count
description:
Number of EOG channels.
schema information:
{'display_name': 'EOG Channel Count', 'type': 'integer', 'minimum': 0}
EchoTime sense 1 (metadata)
name: Echo Time
description:
The echo time (TE) for the acquisition, specified in seconds. Corresponds to DICOM Tag 0018, 0081
Echo Time
(please note that the DICOM term is in milliseconds not seconds). The data type number may apply to files from any MRI modality concerned with a single value for this field, or to the files in a file collection where the value of this field is iterated using theecho
entity. The data type array provides a value for each volume in a 4D dataset and should only be used when the volume timing is critical for interpretation of the data, such as in ASL or variable echo time fMRI sequences.
schema information:
{'display_name': 'Echo Time', 'anyOf': [{'type': 'number', 'unit': 's', 'exclusiveMinimum': 0}, {'type': 'array', 'items': {'type': 'number', 'unit': 's', 'exclusiveMinimum': 0}}]}
EchoTime sense 2 (metadata)
name: Echo Time
description:
The time (in seconds) when the echo corresponding to this map was acquired.
schema information:
{'display_name': 'Echo Time', 'type': 'number', 'unit': 's', 'exclusiveMinimum': 0}
EchoTime1 (metadata)
name: Echo Time1
description:
The time (in seconds) when the first (shorter) echo occurs.
schema information:
{'display_name': 'Echo Time1', 'type': 'number', 'unit': 's', 'exclusiveMinimum': 0}
EchoTime2 (metadata)
name: Echo Time2
description:
The time (in seconds) when the second (longer) echo occurs.
schema information:
{'display_name': 'Echo Time2', 'type': 'number', 'unit': 's', 'exclusiveMinimum': 0}
EffectiveEchoSpacing (metadata)
name: Effective Echo Spacing
description:
The "effective" sampling interval, specified in seconds, between lines in the phase-encoding direction, defined based on the size of the reconstructed image in the phase direction. It is frequently, but incorrectly, referred to as "dwell time" (see the
"DwellTime"
parameter for actual dwell time). It is required for unwarping distortions using field maps. Note that beyond just in-plane acceleration, a variety of other manipulations to the phase encoding need to be accounted for properly, including partial fourier, phase oversampling, phase resolution, phase field-of-view and interpolation.
schema information:
{'display_name': 'Effective Echo Spacing', 'type': 'number', 'exclusiveMinimum': 0, 'unit': 's'}
ElectricalStimulation (metadata)
name: Electrical Stimulation
description:
Boolean field to specify if electrical stimulation was done during the recording (options are
true
orfalse
). Parameters for event-like stimulation should be specified in theevents.tsv
file.
schema information:
{'display_name': 'Electrical Stimulation', 'type': 'boolean'}
ElectricalStimulationParameters (metadata)
name: Electrical Stimulation Parameters
description:
Free form description of stimulation parameters, such as frequency or shape. Specific onsets can be specified in the events.tsv file. Specific shapes can be described here in freeform text.
schema information:
{'display_name': 'Electrical Stimulation Parameters', 'type': 'string'}
ElectrodeManufacturer (metadata)
name: Electrode Manufacturer
description:
Can be used if all electrodes are of the same manufacturer (for example,
"AD-TECH"
,"DIXI"
). If electrodes of different manufacturers are used, please use the corresponding table in the_electrodes.tsv
file.
schema information:
{'display_name': 'Electrode Manufacturer', 'type': 'string'}
ElectrodeManufacturersModelName (metadata)
name: Electrode Manufacturers Model Name
description:
If different electrode types are used, please use the corresponding table in the
_electrodes.tsv
file.
schema information:
{'display_name': 'Electrode Manufacturers Model Name', 'type': 'string'}
EpochLength (metadata)
name: Epoch Length
description:
Duration of individual epochs in seconds (for example,
1
) in case of epoched data. If recording was continuous or discontinuous, leave out the field.
schema information:
{'display_name': 'Epoch Length', 'type': 'number', 'minimum': 0}
EstimationAlgorithm (metadata)
name: Estimation Algorithm
description:
Type of algorithm used to perform fitting (for example,
"linear"
,"non-linear"
,"LM"
and such).
schema information:
{'display_name': 'Estimation Algorithm', 'type': 'string'}
EstimationReference (metadata)
name: Estimation Reference
description:
Reference to the study/studies on which the implementation is based.
schema information:
{'display_name': 'Estimation Reference', 'type': 'string'}
EthicsApprovals (metadata)
name: Ethics Approvals
description:
List of ethics committee approvals of the research protocols and/or protocol identifiers.
schema information:
{'display_name': 'Ethics Approvals', 'type': 'array', 'items': {'type': 'string'}}
FLAIR (suffixes)
name: Fluid attenuated inversion recovery image
description:
In arbitrary units (arbitrary). Structural images with predominant T2 contribution (also known as T2-FLAIR), in which signal from fluids (for example, CSF) is nulled out by adjusting inversion time, coupled with notably long repetition and echo times.
schema information:
{'value': 'FLAIR', 'display_name': 'Fluid attenuated inversion recovery image', 'unit': 'arbitrary'}
FLASH (suffixes)
name: Fast-Low-Angle-Shot image
description:
FLASH (Fast-Low-Angle-Shot) is a vendor-specific implementation for spoiled gradient echo acquisition. It is commonly used for rapid anatomical imaging and also for many different qMRI applications. When used for a single file, it does not convey any information about the image contrast. When used in a file collection, it may result in conflicts across filenames of different applications. Change: Removed from suffixes.
schema information:
{'value': 'FLASH', 'display_name': 'Fast-Low-Angle-Shot image'}
FLUO (suffixes)
name: Fluorescence microscopy
description:
Fluorescence microscopy imaging data
schema information:
{'value': 'FLUO', 'display_name': 'Fluorescence microscopy'}
FiducialsCoordinateSystem (metadata)
name: Fiducials Coordinate System
description:
Defines the coordinate system for the fiducials. Preferably the same as the
"EEGCoordinateSystem"
. See Appendix VIII for a list of restricted keywords for coordinate systems. If"Other"
, provide definition of the coordinate system in"FiducialsCoordinateSystemDescription"
.
schema information:
{'display_name': 'Fiducials Coordinate System', 'type': 'string', 'enum': ['CTF', 'ElektaNeuromag', '4DBti', 'KitYokogawa', 'ChietiItab', 'Other', 'CapTrak', 'EEGLAB', 'EEGLAB-HJ', 'Other', 'ICBM452AirSpace', 'ICBM452Warp5Space', 'IXI549Space', 'fsaverage', 'fsaverageSym', 'fsLR', 'MNIColin27', 'MNI152Lin', 'MNI152NLin2009aSym', 'MNI152NLin2009bSym', 'MNI152NLin2009cSym', 'MNI152NLin2009aAsym', 'MNI152NLin2009bAsym', 'MNI152NLin2009cAsym', 'MNI152NLin6Sym', 'MNI152NLin6ASym', 'MNI305', 'NIHPD', 'OASIS30AntsOASISAnts', 'OASIS30Atropos', 'Talairach', 'UNCInfant', 'fsaverage3', 'fsaverage4', 'fsaverage5', 'fsaverage6', 'fsaveragesym', 'UNCInfant0V21', 'UNCInfant1V21', 'UNCInfant2V21', 'UNCInfant0V22', 'UNCInfant1V22', 'UNCInfant2V22', 'UNCInfant0V23', 'UNCInfant1V23', 'UNCInfant2V23']}
FiducialsCoordinateSystemDescription (metadata)
name: Fiducials Coordinate System Description
description:
Free-form text description of the coordinate system. May also include a link to a documentation page or paper describing the system in greater detail.
schema information:
{'display_name': 'Fiducials Coordinate System Description', 'type': 'string'}
FiducialsCoordinateUnits (metadata)
name: Fiducials Coordinate Units
description:
Units in which the coordinates that are listed in the field
"FiducialsCoordinateSystem"
are represented.
schema information:
{'display_name': 'Fiducials Coordinate Units', 'type': 'string', 'enum': ['m', 'mm', 'cm', 'n/a']}
FiducialsCoordinates (metadata)
name: Fiducials Coordinates
description:
Key-value pairs of the labels and 3-D digitized position of anatomical landmarks, interpreted following the
"FiducialsCoordinateSystem"
(for example,{"NAS": [12.7,21.3,13.9], "LPA": [5.2,11.3,9.6], "RPA": [20.2,11.3,9.1]}
). Each array MUST contain three numeric values corresponding to x, y, and z axis of the coordinate system in that exact order.
schema information:
{'display_name': 'Fiducials Coordinates', 'type': 'object', 'additionalProperties': {'type': 'array', 'items': {'type': 'number'}, 'minItems': 3, 'maxItems': 3}}
FiducialsDescription (metadata)
name: Fiducials Description
description:
Free-form text description of how the fiducials such as vitamin-E capsules were placed relative to anatomical landmarks, and how the position of the fiducials were measured (for example,
"both with Polhemus and with T1w MRI"
).
schema information:
{'display_name': 'Fiducials Description', 'type': 'string'}
FlipAngle (metadata)
name: Flip Angle
description:
Flip angle (FA) for the acquisition, specified in degrees. Corresponds to: DICOM Tag 0018, 1314
Flip Angle
. The data type number may apply to files from any MRI modality concerned with a single value for this field, or to the files in a file collection where the value of this field is iterated using theflip
entity. The data type array provides a value for each volume in a 4D dataset and should only be used when the volume timing is critical for interpretation of the data, such as in ASL or variable flip angle fMRI sequences.
schema information:
{'display_name': 'Flip Angle', 'anyOf': [{'type': 'number', 'unit': 'degree', 'exclusiveMinimum': 0, 'maximum': 360}, {'type': 'array', 'items': {'type': 'number', 'unit': 'degree', 'exclusiveMinimum': 0, 'maximum': 360}}]}
FrameDuration (metadata)
name: Frame Duration
description:
Time duration of each frame in default unit seconds. This corresponds to DICOM Tag 0018, 1242
Actual Frame Duration
converted to seconds.
schema information:
{'display_name': 'Frame Duration', 'type': 'array', 'items': {'type': 'number'}, 'unit': 's'}
FrameTimesStart (metadata)
name: Frame Times Start
description:
Start times for all frames relative to
"TimeZero"
in default unit seconds.
schema information:
{'display_name': 'Frame Times Start', 'type': 'array', 'items': {'type': 'number'}, 'unit': 's'}
Funding (metadata)
name: Funding
description:
List of sources of funding (grant numbers).
schema information:
{'display_name': 'Funding', 'type': 'array', 'items': {'type': 'string'}}
GeneratedBy (metadata)
name: Generated By
description:
Used to specify provenance of the dataset.
schema information:
{'display_name': 'Generated By', 'type': 'array', 'minItems': 1, 'items': {'type': 'object', 'properties': {'Name': {'type': 'string'}, 'Version': {'type': 'string'}, 'Description': {'type': 'string'}, 'CodeURL': {'type': 'string', 'format': 'uri'}, 'Container': {'type': 'object', 'properties': {'Type': {'type': 'string'}, 'Tag': {'type': 'string'}, 'URI': {'type': 'string', 'format': 'uri'}}}}}}
GeneticLevel (metadata)
name: Genetic Level
description:
Describes the level of analysis. Values MUST be one of
"Genetic"
,"Genomic"
,"Epigenomic"
,"Transcriptomic"
,"Metabolomic"
, or"Proteomic"
.
schema information:
{'display_name': 'Genetic Level', 'anyOf': [{'type': 'string', 'enum': ['Genetic', 'Genomic', 'Epigenomic', 'Transcriptomic', 'Metabolomic', 'Proteomic']}, {'type': 'array', 'items': {'type': 'string', 'enum': ['Genetic', 'Genomic', 'Epigenomic', 'Transcriptomic', 'Metabolomic', 'Proteomic']}}]}
Genetics (metadata)
name: Genetics
description:
An object containing information about the genetics descriptor.
schema information:
{'display_name': 'Genetics', 'type': 'object', 'properties': {'Database': {'name': 'Database', 'description': '[URI](SPEC_ROOT/02-common-principles.md#uniform-resource-indicator)\nof database where the dataset is hosted.\n', 'type': 'string', 'format': 'uri'}, 'Dataset': {'name': 'Dataset', 'description': '[URI](SPEC_ROOT/02-common-principles.md#uniform-resource-indicator)\nwhere data can be retrieved.\n', 'type': 'string', 'format': 'uri'}, 'Descriptors': {'name': 'Descriptors', 'description': 'List of relevant descriptors (for example, journal articles) for dataset\nusing a valid\n[URI](SPEC_ROOT/02-common-principles.md#uniform-resource-indicator)\nwhen possible.\n', 'anyOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}]}}}
GradientSetType (metadata)
name: Gradient Set Type
description:
It should be possible to infer the gradient coil from the scanner model. If not, for example because of a custom upgrade or use of a gradient insert set, then the specifications of the actual gradient coil should be reported independently.
schema information:
{'display_name': 'Gradient Set Type', 'type': 'string'}
HED (columns)
name: HED Tag
description:
Hierarchical Event Descriptor (HED) Tag. See Appendix III for details.
schema information:
{'display_name': 'HED Tag', 'type': 'string'}
HED (metadata)
name: HED
description:
Hierarchical Event Descriptor (HED) information, see: Appendix III for details.
schema information:
{'display_name': 'HED', 'anyOf': [{'type': 'string'}, {'type': 'object', 'additionalProperties': {'type': 'string'}}]}
HEDVersion (metadata)
name: HED Version
description:
If HED tags are used: The version of the HED schema used to validate HED tags for study.
schema information:
{'display_name': 'HED Version', 'type': 'string'}
Haematocrit (metadata)
name: Haematocrit
description:
Measured haematocrit, meaning the volume of erythrocytes divided by the volume of whole blood.
schema information:
{'display_name': 'Haematocrit', 'type': 'number'}
HardcopyDeviceSoftwareVersion (metadata)
name: Hardcopy Device Software Version
description:
Manufacturer's designation of the software of the device that created this Hardcopy Image (the printer). Corresponds to DICOM Tag 0018, 101A
Hardcopy Device Software Version
.
schema information:
{'display_name': 'Hardcopy Device Software Version', 'type': 'string'}
HardwareFilters (metadata)
name: Hardware Filters
description:
Object of temporal hardware filters applied, or
"n/a"
if the data is not available. Each key-value pair in the JSON object is a name of the filter and an object in which its parameters are defined as key-value pairs. For example,{"Highpass RC filter": {"Half amplitude cutoff (Hz)": 0.0159, "Roll-off": "6dB/Octave"}}
.
schema information:
{'display_name': 'Hardware Filters', 'anyOf': [{'type': 'object', 'additionalProperties': {'type': 'object'}}, {'type': 'string', 'enum': ['n/a']}]}
HeadCircumference (metadata)
name: Head Circumference
description:
Circumference of the participant's head, expressed in cm (for example,
58
).
schema information:
{'display_name': 'Head Circumference', 'type': 'number', 'exclusiveMinimum': 0, 'unit': 'cm'}
HeadCoilCoordinateSystem (metadata)
name: Head Coil Coordinate System
description:
Defines the coordinate system for the head coils. See Appendix VIII for a list of restricted keywords for coordinate systems. If
"Other"
, provide definition of the coordinate system inHeadCoilCoordinateSystemDescription
.
schema information:
{'display_name': 'Head Coil Coordinate System', 'type': 'string', 'enum': ['CTF', 'ElektaNeuromag', '4DBti', 'KitYokogawa', 'ChietiItab', 'Other', 'CapTrak', 'EEGLAB', 'EEGLAB-HJ', 'Other', 'ICBM452AirSpace', 'ICBM452Warp5Space', 'IXI549Space', 'fsaverage', 'fsaverageSym', 'fsLR', 'MNIColin27', 'MNI152Lin', 'MNI152NLin2009aSym', 'MNI152NLin2009bSym', 'MNI152NLin2009cSym', 'MNI152NLin2009aAsym', 'MNI152NLin2009bAsym', 'MNI152NLin2009cAsym', 'MNI152NLin6Sym', 'MNI152NLin6ASym', 'MNI305', 'NIHPD', 'OASIS30AntsOASISAnts', 'OASIS30Atropos', 'Talairach', 'UNCInfant', 'fsaverage3', 'fsaverage4', 'fsaverage5', 'fsaverage6', 'fsaveragesym', 'UNCInfant0V21', 'UNCInfant1V21', 'UNCInfant2V21', 'UNCInfant0V22', 'UNCInfant1V22', 'UNCInfant2V22', 'UNCInfant0V23', 'UNCInfant1V23', 'UNCInfant2V23']}
HeadCoilCoordinateSystemDescription (metadata)
name: Head Coil Coordinate System Description
description:
Free-form text description of the coordinate system. May also include a link to a documentation page or paper describing the system in greater detail.
schema information:
{'display_name': 'Head Coil Coordinate System Description', 'type': 'string'}
HeadCoilCoordinateUnits (metadata)
name: Head Coil Coordinate Units
description:
Units of the coordinates of
HeadCoilCoordinateSystem
.
schema information:
{'display_name': 'Head Coil Coordinate Units', 'type': 'string', 'enum': ['m', 'mm', 'cm', 'n/a']}
HeadCoilCoordinates (metadata)
name: Head Coil Coordinates
description:
Key-value pairs describing head localization coil labels and their coordinates, interpreted following the
HeadCoilCoordinateSystem
(for example,{"NAS": [12.7,21.3,13.9], "LPA": [5.2,11.3,9.6], "RPA": [20.2,11.3,9.1]}
). Note that coils are not always placed at locations that have a known anatomical name (for example, for Elekta, Yokogawa systems); in that case generic labels can be used (for example,{"coil1": [12.2,21.3,12.3], "coil2": [6.7,12.3,8.6], "coil3": [21.9,11.0,8.1]}
). Each array MUST contain three numeric values corresponding to x, y, and z axis of the coordinate system in that exact order.
schema information:
{'display_name': 'Head Coil Coordinates', 'type': 'object', 'additionalProperties': {'type': 'array', 'items': {'type': 'number'}, 'minItems': 3, 'maxItems': 3}}
HeadCoilFrequency (metadata)
name: Head Coil Frequency
description:
List of frequencies (in Hz) used by the head localisation coils ('HLC' in CTF systems, 'HPI' in Elekta, 'COH' in BTi/4D) that track the subject's head position in the MEG helmet (for example,
[293, 307, 314, 321]
).
schema information:
{'display_name': 'Head Coil Frequency', 'anyOf': [{'type': 'number', 'unit': 'Hz'}, {'type': 'array', 'items': {'type': 'number', 'unit': 'Hz'}}]}
HowToAcknowledge (metadata)
name: How To Acknowledge
description:
Text containing instructions on how researchers using this dataset should acknowledge the original authors. This field can also be used to define a publication that should be cited in publications that use the dataset.
schema information:
{'display_name': 'How To Acknowledge', 'type': 'string'}
IRT1 (suffixes)
name: Inversion recovery T1 mapping
description:
The IRT1 method involves multiple inversion recovery spin-echo images acquired at different inversion times (Barral et al. 2010).
schema information:
{'value': 'IRT1', 'display_name': 'Inversion recovery T1 mapping'}
ImageAcquisitionProtocol (metadata)
name: Image Acquisition Protocol
description:
Description of the image acquisition protocol or URI (for example from protocols.io).
schema information:
{'display_name': 'Image Acquisition Protocol', 'type': 'string'}
ImageDecayCorrected (metadata)
name: Image Decay Corrected
description:
Boolean flag specifying whether the image data have been decay-corrected.
schema information:
{'display_name': 'Image Decay Corrected', 'type': 'boolean'}
ImageDecayCorrectionTime (metadata)
name: Image Decay Correction Time
description:
Point in time from which the decay correction was applied with respect to
"TimeZero"
in the default unit seconds.
schema information:
{'display_name': 'Image Decay Correction Time', 'type': 'number', 'unit': 's'}
Immersion (metadata)
name: Immersion
description:
Lens immersion medium. If the file format is OME-TIFF, the value MUST be consistent with the
Immersion
OME metadata field.
schema information:
{'display_name': 'Immersion', 'type': 'string'}
InfusionRadioactivity (metadata)
name: Infusion Radioactivity
description:
Amount of radioactivity infused into the patient. This value must be less than or equal to the total injected radioactivity (
"InjectedRadioactivity"
). Units should be the same as"InjectedRadioactivityUnits"
.
schema information:
{'display_name': 'Infusion Radioactivity', 'type': 'number'}
InfusionSpeed (metadata)
name: Infusion Speed
description:
If given, infusion speed.
schema information:
{'display_name': 'Infusion Speed', 'type': 'number'}
InfusionSpeedUnits (metadata)
name: Infusion Speed Units
description:
Unit of infusion speed (for example,
"mL/s"
).
schema information:
{'display_name': 'Infusion Speed Units', 'type': 'string', 'format': 'unit'}
InfusionStart (metadata)
name: Infusion Start
description:
Time of start of infusion with respect to
"TimeZero"
in the default unit seconds.
schema information:
{'display_name': 'Infusion Start', 'type': 'number', 'unit': 's'}
InjectedMass (metadata)
name: Injected Mass
description:
Total mass of radiolabeled compound injected into subject (for example,
10
). This can be derived as the ratio of the"InjectedRadioactivity"
and"MolarRadioactivity"
. For those tracers in which injected mass is not available (for example FDG) can be set to"n/a"
).
schema information:
{'display_name': 'Injected Mass', 'anyOf': [{'type': 'number'}, {'type': 'string', 'enum': ['n/a']}]}
InjectedMassPerWeight (metadata)
name: Injected Mass Per Weight
description:
Injected mass per kilogram bodyweight.
schema information:
{'display_name': 'Injected Mass Per Weight', 'type': 'number'}
InjectedMassPerWeightUnits (metadata)
name: Injected Mass Per Weight Units
description:
Unit format of the injected mass per kilogram bodyweight (for example,
"ug/kg"
).
schema information:
{'display_name': 'Injected Mass Per Weight Units', 'type': 'string', 'format': 'unit'}
InjectedMassUnits (metadata)
name: Injected Mass Units
description:
Unit format of the mass of compound injected (for example,
"ug"
or"umol"
). Note this is not required for an FDG acquisition, since it is not available, and SHOULD be set to"n/a"
.
schema information:
{'display_name': 'Injected Mass Units', 'anyOf': [{'type': 'string', 'format': 'unit'}, {'type': 'string', 'enum': ['n/a']}]}
InjectedRadioactivity (metadata)
name: Injected Radioactivity
description:
Total amount of radioactivity injected into the patient (for example,
400
). For bolus-infusion experiments, this value should be the sum of all injected radioactivity originating from both bolus and infusion. Corresponds to DICOM Tag 0018, 1074Radionuclide Total Dose
.
schema information:
{'display_name': 'Injected Radioactivity', 'type': 'number'}
InjectedRadioactivityUnits (metadata)
name: Injected Radioactivity Units
description:
Unit format of the specified injected radioactivity (for example,
"MBq"
).
schema information:
{'display_name': 'Injected Radioactivity Units', 'type': 'string', 'format': 'unit'}
InjectedVolume (metadata)
name: Injected Volume
description:
Injected volume of the radiotracer in the unit
"mL"
.
schema information:
{'display_name': 'Injected Volume', 'type': 'number', 'unit': 'mL'}
InjectionEnd (metadata)
name: Injection End
description:
Time of end of injection with respect to
"TimeZero"
in the default unit seconds.
schema information:
{'display_name': 'Injection End', 'type': 'number', 'unit': 's'}
InjectionStart (metadata)
name: Injection Start
description:
Time of start of injection with respect to
"TimeZero"
in the default unit seconds. This corresponds to DICOM Tag 0018, 1072Contrast/Bolus Start Time
converted to seconds relative to"TimeZero"
.
schema information:
{'display_name': 'Injection Start', 'type': 'number', 'unit': 's'}
InstitutionAddress (metadata)
name: Institution Address
description:
The address of the institution in charge of the equipment that produced the measurements.
schema information:
{'display_name': 'Institution Address', 'type': 'string'}
InstitutionName (metadata)
name: Institution Name
description:
The name of the institution in charge of the equipment that produced the measurements.
schema information:
{'display_name': 'Institution Name', 'type': 'string'}
InstitutionalDepartmentName (metadata)
name: Institutional Department Name
description:
The department in the institution in charge of the equipment that produced the measurements.
schema information:
{'display_name': 'Institutional Department Name', 'type': 'string'}
Instructions (metadata)
name: Instructions
description:
Text of the instructions given to participants before the recording.
schema information:
{'display_name': 'Instructions', 'type': 'string'}
IntendedFor sense 1 (metadata)
name: Intended For
description:
The paths to files for which the associated file is intended to be used. Contains one or more filenames with paths relative to the participant subdirectory. Paths need to use forward slashes instead of backward slashes, regardless of operating system.
schema information:
{'display_name': 'Intended For', 'anyOf': [{'type': 'string', 'format': 'participant_relative'}, {'type': 'array', 'items': {'type': 'string', 'format': 'participant_relative'}}]}
IntendedFor sense 2 (metadata)
name: Intended For
description:
The paths to files for which the associated file is intended to be used. Contains one or more filenames with paths relative to the dataset root. Paths need to use forward slashes instead of backward slashes, regardless of operating system.
schema information:
{'display_name': 'Intended For', 'anyOf': [{'type': 'string', 'format': 'dataset_relative'}, {'type': 'array', 'items': {'type': 'string', 'format': 'dataset_relative'}}]}
InversionTime (metadata)
name: Inversion Time
description:
The inversion time (TI) for the acquisition, specified in seconds. Inversion time is the time after the middle of inverting RF pulse to middle of excitation pulse to detect the amount of longitudinal magnetization. Corresponds to DICOM Tag 0018, 0082
Inversion Time
(please note that the DICOM term is in milliseconds not seconds).
schema information:
{'display_name': 'Inversion Time', 'type': 'number', 'unit': 's', 'exclusiveMinimum': 0}
LICENSE (top_level_files)
name: License
description:
A
LICENSE
file MAY be provided in addition to the short specification of the used license in thedataset_description.json
"License"
field. The"License"
field andLICENSE
file MUST correspond. TheLICENSE
file MUST be either in ASCII or UTF-8 encoding.
schema information:
{'display_name': 'License'}
LabelingDistance (metadata)
name: Labeling Distance
description:
Distance from the center of the imaging slab to the center of the labeling plane (
(P)CASL
) or the leading edge of the labeling slab (PASL
), in millimeters. If the labeling is performed inferior to the isocenter, this number should be negative. Based on DICOM macro C.8.13.5.14.
schema information:
{'display_name': 'Labeling Distance', 'type': 'number', 'unit': 'mm'}
LabelingDuration (metadata)
name: Labeling Duration
description:
Total duration of the labeling pulse train, in seconds, corresponding to the temporal width of the labeling bolus for
"PCASL"
or"CASL"
. In case all control-label volumes (or deltam or CBF) have the sameLabelingDuration
, a scalar must be specified. In case the control-label volumes (or deltam or cbf) have a different"LabelingDuration"
, an array of numbers must be specified, for which anym0scan
in the timeseries has a"LabelingDuration"
of zero. In case an array of numbers is provided, its length should be equal to the number of volumes specified in*_aslcontext.tsv
. Corresponds to DICOM Tag 0018, 9258ASL Pulse Train Duration
.
schema information:
{'display_name': 'Labeling Duration', 'anyOf': [{'type': 'number', 'minimum': 0, 'unit': 's'}, {'type': 'array', 'items': {'type': 'number', 'unit': 's', 'minimum': 0}}]}
LabelingEfficiency (metadata)
name: Labeling Efficiency
description:
Labeling efficiency, specified as a number between zero and one, only if obtained externally (for example phase-contrast based).
schema information:
{'display_name': 'Labeling Efficiency', 'type': 'number', 'exclusiveMinimum': 0}
LabelingLocationDescription (metadata)
name: Labeling Location Description
description:
Description of the location of the labeling plane (
"CASL"
or"PCASL"
) or the labeling slab ("PASL"
) that cannot be captured by fieldsLabelingOrientation
orLabelingDistance
. May include a link to an anonymized screenshot of the planning of the labeling slab/plane with respect to the imaging slab or slices*_asllabeling.jpg
. Based on DICOM macro C.8.13.5.14.
schema information:
{'display_name': 'Labeling Location Description', 'type': 'string'}
LabelingOrientation (metadata)
name: Labeling Orientation
description:
Orientation of the labeling plane (
(P)CASL
) or slab (PASL
). The direction cosines of a normal vector perpendicular to the ASL labeling slab or plane with respect to the patient. Corresponds to DICOM Tag 0018, 9255ASL Slab Orientation
.
schema information:
{'display_name': 'Labeling Orientation', 'type': 'array', 'items': {'type': 'number'}}
LabelingPulseAverageB1 (metadata)
name: Labeling Pulse Average B1
description:
The average B1-field strength of the RF labeling pulses, in microteslas. As an alternative,
"LabelingPulseFlipAngle"
can be provided.
schema information:
{'display_name': 'Labeling Pulse Average B1', 'type': 'number', 'exclusiveMinimum': 0, 'unit': 'uT'}
LabelingPulseAverageGradient (metadata)
name: Labeling Pulse Average Gradient
description:
The average labeling gradient, in milliteslas per meter.
schema information:
{'display_name': 'Labeling Pulse Average Gradient', 'type': 'number', 'exclusiveMinimum': 0, 'unit': 'mT/m'}
LabelingPulseDuration (metadata)
name: Labeling Pulse Duration
description:
Duration of the individual labeling pulses, in milliseconds.
schema information:
{'display_name': 'Labeling Pulse Duration', 'type': 'number', 'exclusiveMinimum': 0, 'unit': 'ms'}
LabelingPulseFlipAngle (metadata)
name: Labeling Pulse Flip Angle
description:
The flip angle of a single labeling pulse, in degrees, which can be given as an alternative to
"LabelingPulseAverageB1"
.
schema information:
{'display_name': 'Labeling Pulse Flip Angle', 'type': 'number', 'exclusiveMinimum': 0, 'maximum': 360, 'unit': 'degree'}
LabelingPulseInterval (metadata)
name: Labeling Pulse Interval
description:
Delay between the peaks of the individual labeling pulses, in milliseconds.
schema information:
{'display_name': 'Labeling Pulse Interval', 'type': 'number', 'exclusiveMinimum': 0, 'unit': 'ms'}
LabelingPulseMaximumGradient (metadata)
name: Labeling Pulse Maximum Gradient
description:
The maximum amplitude of the gradient switched on during the application of the labeling RF pulse(s), in milliteslas per meter.
schema information:
{'display_name': 'Labeling Pulse Maximum Gradient', 'type': 'number', 'exclusiveMinimum': 0, 'unit': 'mT/m'}
LabelingSlabThickness (metadata)
name: Labeling Slab Thickness
description:
Thickness of the labeling slab in millimeters. For non-selective FAIR a zero is entered. Corresponds to DICOM Tag 0018, 9254
ASL Slab Thickness
.
schema information:
{'display_name': 'Labeling Slab Thickness', 'type': 'number', 'exclusiveMinimum': 0, 'unit': 'mm'}
Levels (metadata)
name: Levels
description:
For categorical variables: An object of possible values (keys) and their descriptions (values).
schema information:
{'display_name': 'Levels', 'type': 'object', 'additionalProperties': {'type': 'string'}}
License (metadata)
name: License
description:
The license for the dataset. The use of license name abbreviations is RECOMMENDED for specifying a license (see Appendix II). The corresponding full license text MAY be specified in an additional
LICENSE
file.
schema information:
{'display_name': 'License', 'type': 'string'}
LongName (metadata)
name: Long Name
description:
Long (unabbreviated) name of the column.
schema information:
{'display_name': 'Long Name', 'type': 'string'}
LookLocker (metadata)
name: Look Locker
description:
Boolean indicating if a Look-Locker readout is used.
schema information:
{'display_name': 'Look Locker', 'type': 'boolean'}
M0Estimate (metadata)
name: M0Estimate
description:
A single numerical whole-brain M0 value (referring to the M0 of blood), only if obtained externally (for example retrieved from CSF in a separate measurement).
schema information:
{'display_name': 'M0Estimate', 'type': 'number', 'exclusiveMinimum': 0}
M0Type (metadata)
name: M0Type
description:
Describes the presence of M0 information.
"Separate"
means that a separate*_m0scan.nii[.gz]
is present."Included"
means that an m0scan volume is contained within the current*_asl.nii[.gz]
."Estimate"
means that a single whole-brain M0 value is provided."Absent"
means that no specific M0 information is present.
schema information:
{'display_name': 'M0Type', 'type': 'string', 'enum': ['Separate', 'Included', 'Estimate', 'Absent']}
M0map (suffixes)
name: Equilibrium magnetization (M0) map
description:
In arbitrary units (arbitrary). A common quantitative MRI (qMRI) fitting variable that represents the amount of magnetization at thermal equilibrium. M0 maps are RECOMMENDED to use this suffix if generated by qMRI applications (for example, variable flip angle T1 mapping).
schema information:
{'value': 'M0map', 'display_name': 'Equilibrium magnetization (M0) map', 'unit': 'arbitrary'}
MEGChannelCount (metadata)
name: MEG Channel Count
description:
Number of MEG channels (for example,
275
).
schema information:
{'display_name': 'MEG Channel Count', 'type': 'integer', 'minimum': 0}
MEGCoordinateSystem (metadata)
name: MEG Coordinate System
description:
Defines the coordinate system for the MEG sensors. See Appendix VIII for a list of restricted keywords for coordinate systems. If
"Other"
, provide definition of the coordinate system in"MEGCoordinateSystemDescription"
.
schema information:
{'display_name': 'MEG Coordinate System', 'type': 'string', 'enum': ['CTF', 'ElektaNeuromag', '4DBti', 'KitYokogawa', 'ChietiItab', 'Other', 'CapTrak', 'EEGLAB', 'EEGLAB-HJ', 'Other', 'ICBM452AirSpace', 'ICBM452Warp5Space', 'IXI549Space', 'fsaverage', 'fsaverageSym', 'fsLR', 'MNIColin27', 'MNI152Lin', 'MNI152NLin2009aSym', 'MNI152NLin2009bSym', 'MNI152NLin2009cSym', 'MNI152NLin2009aAsym', 'MNI152NLin2009bAsym', 'MNI152NLin2009cAsym', 'MNI152NLin6Sym', 'MNI152NLin6ASym', 'MNI305', 'NIHPD', 'OASIS30AntsOASISAnts', 'OASIS30Atropos', 'Talairach', 'UNCInfant', 'fsaverage3', 'fsaverage4', 'fsaverage5', 'fsaverage6', 'fsaveragesym', 'UNCInfant0V21', 'UNCInfant1V21', 'UNCInfant2V21', 'UNCInfant0V22', 'UNCInfant1V22', 'UNCInfant2V22', 'UNCInfant0V23', 'UNCInfant1V23', 'UNCInfant2V23']}
MEGCoordinateSystemDescription (metadata)
name: MEG Coordinate System Description
description:
Free-form text description of the coordinate system. May also include a link to a documentation page or paper describing the system in greater detail.
schema information:
{'display_name': 'MEG Coordinate System Description', 'type': 'string'}
MEGCoordinateUnits (metadata)
name: MEG Coordinate Units
description:
Units of the coordinates of
"MEGCoordinateSystem"
.
schema information:
{'display_name': 'MEG Coordinate Units', 'type': 'string', 'enum': ['m', 'mm', 'cm', 'n/a']}
MEGRE (suffixes)
name: Multi-echo Gradient Recalled Echo
description:
Anatomical gradient echo images acquired at different echo times. Please note that this suffix is not intended for the logical grouping of images acquired using an Echo Planar Imaging (EPI) readout.
schema information:
{'value': 'MEGRE', 'display_name': 'Multi-echo Gradient Recalled Echo'}
MEGREFChannelCount (metadata)
name: MEGREF Channel Count
description:
Number of MEG reference channels (for example,
23
). For systems without such channels (for example, Neuromag Vectorview),MEGREFChannelCount
should be set to0
.
schema information:
{'display_name': 'MEGREF Channel Count', 'type': 'integer', 'minimum': 0}
MESE (suffixes)
name: Multi-echo Spin Echo
description:
The MESE method involves multiple spin echo images acquired at different echo times and is primarily used for T2 mapping. Please note that this suffix is not intended for the logical grouping of images acquired using an Echo Planar Imaging (EPI) readout.
schema information:
{'value': 'MESE', 'display_name': 'Multi-echo Spin Echo'}
MP2RAGE (suffixes)
name: Magnetization Prepared Two Gradient Echoes
description:
The MP2RAGE method is a special protocol that collects several images at different flip angles and inversion times to create a parametric T1map by combining the magnitude and phase images (Marques et al. 2010).
schema information:
{'value': 'MP2RAGE', 'display_name': 'Magnetization Prepared Two Gradient Echoes'}
MPE (suffixes)
name: Multi-photon excitation microscopy
description:
Multi-photon excitation microscopy imaging data
schema information:
{'value': 'MPE', 'display_name': 'Multi-photon excitation microscopy'}
MPM (suffixes)
name: Multi-parametric Mapping
description:
The MPM approaches (a.k.a hMRI) involves the acquisition of highly-similar anatomical images that differ in terms of application of a magnetization transfer RF pulse (MTon or MToff), flip angle and (optionally) echo time and magnitue/phase parts (Weiskopf et al. 2013). See here for suggested MPM acquisition protocols.
schema information:
{'value': 'MPM', 'display_name': 'Multi-parametric Mapping'}
MRAcquisitionType (metadata)
name: MR Acquisition Type
description:
Type of sequence readout. Corresponds to DICOM Tag 0018, 0023
MR Acquisition Type
.
schema information:
{'display_name': 'MR Acquisition Type', 'type': 'string', 'enum': ['2D', '3D']}
MRTransmitCoilSequence (metadata)
name: MR Transmit Coil Sequence
description:
This is a relevant field if a non-standard transmit coil is used. Corresponds to DICOM Tag 0018, 9049
MR Transmit Coil Sequence
.
schema information:
{'display_name': 'MR Transmit Coil Sequence', 'type': 'string'}
MTNumberOfPulses (metadata)
name: MT Number Of Pulses
description:
The number of magnetization transfer RF pulses applied before the readout.
schema information:
{'display_name': 'MT Number Of Pulses', 'type': 'number'}
MTOffsetFrequency (metadata)
name: MT Offset Frequency
description:
The frequency offset of the magnetization transfer pulse with respect to the central H1 Larmor frequency in Hertz (Hz).
schema information:
{'display_name': 'MT Offset Frequency', 'type': 'number', 'unit': 'Hz'}
MTPulseBandwidth (metadata)
name: MT Pulse Bandwidth
description:
The excitation bandwidth of the magnetization transfer pulse in Hertz (Hz).
schema information:
{'display_name': 'MT Pulse Bandwidth', 'type': 'number', 'unit': 'Hz'}
MTPulseDuration (metadata)
name: MT Pulse Duration
description:
Duration of the magnetization transfer RF pulse in seconds.
schema information:
{'display_name': 'MT Pulse Duration', 'type': 'number', 'unit': 's'}
MTPulseShape (metadata)
name: MT Pulse Shape
description:
Shape of the magnetization transfer RF pulse waveform. The value
"GAUSSHANN"
refers to a Gaussian pulse with a Hanning window. The value"SINCHANN"
refers to a sinc pulse with a Hanning window. The value"SINCGAUSS"
refers to a sinc pulse with a Gaussian window.
schema information:
{'display_name': 'MT Pulse Shape', 'type': 'string', 'enum': ['HARD', 'GAUSSIAN', 'GAUSSHANN', 'SINC', 'SINCHANN', 'SINCGAUSS', 'FERMI']}
MTR (suffixes)
name: Magnetization Transfer Ratio
description:
This method is to calculate a semi-quantitative magnetization transfer ratio map.
schema information:
{'value': 'MTR', 'display_name': 'Magnetization Transfer Ratio'}
MTRmap (suffixes)
name: Magnetization transfer ratio image
description:
In arbitrary units (arbitrary). MTR maps are REQUIRED to use this suffix regardless of the method used to generate them. MTRmap intensity values are RECOMMENDED to be represented in percentage in the range of 0-100%.
schema information:
{'value': 'MTRmap', 'display_name': 'Magnetization transfer ratio image', 'unit': 'arbitrary', 'minValue': 0, 'maxValue': 100}
MTS (suffixes)
name: Magnetization transfer saturation
description:
This method is to calculate a semi-quantitative magnetization transfer saturation index map. The MTS method involves three sets of anatomical images that differ in terms of application of a magnetization transfer RF pulse (MTon or MToff) and flip angle (Helms et al. 2008).
schema information:
{'value': 'MTS', 'display_name': 'Magnetization transfer saturation'}
MTState (metadata)
name: MT State
description:
Boolean stating whether the magnetization transfer pulse is applied. Corresponds to DICOM Tag 0018, 9020
Magnetization Transfer
.
schema information:
{'display_name': 'MT State', 'type': 'boolean'}
MTVmap (suffixes)
name: Macromolecular tissue volume (MTV) image
description:
In arbitrary units (arbitrary). MTV maps are REQUIRED to use this suffix regardless of the method used to generate them.
schema information:
{'value': 'MTVmap', 'display_name': 'Macromolecular tissue volume (MTV) image', 'unit': 'arbitrary'}
MTsat (suffixes)
name: Magnetization transfer saturation image
description:
In arbitrary units (arbitrary). MTsat maps are REQUIRED to use this suffix regardless of the method used to generate them.
schema information:
{'value': 'MTsat', 'display_name': 'Magnetization transfer saturation image', 'unit': 'arbitrary'}
MWFmap (suffixes)
name: Myelin water fraction image
description:
In arbitrary units (arbitrary). MWF maps are REQUIRED to use this suffix regardless of the method used to generate them. MWF intensity values are RECOMMENDED to be represented in percentage in the range of 0-100%.
schema information:
{'value': 'MWFmap', 'display_name': 'Myelin water fraction image', 'unit': 'arbitrary', 'minValue': 0, 'maxValue': 100}
MagneticFieldStrength (metadata)
name: Magnetic Field Strength
description:
Nominal field strength of MR magnet in Tesla. Corresponds to DICOM Tag 0018, 0087
Magnetic Field Strength
.
schema information:
{'display_name': 'Magnetic Field Strength', 'type': 'number'}
Magnification (metadata)
name: Magnification
description:
Lens magnification (for example:
40
). If the file format is OME-TIFF, the value MUST be consistent with the"NominalMagnification"
OME metadata field.
schema information:
{'display_name': 'Magnification', 'type': 'number', 'exclusiveMinimum': 0}
Manual (metadata)
name: Manual
description:
Indicates if the segmentation was performed manually or via an automated process.
schema information:
{'display_name': 'Manual', 'type': 'boolean'}
Manufacturer (metadata)
name: Manufacturer
description:
Manufacturer of the equipment that produced the measurements.
schema information:
{'display_name': 'Manufacturer', 'type': 'string'}
ManufacturersModelName (metadata)
name: Manufacturers Model Name
description:
Manufacturer's model name of the equipment that produced the measurements.
schema information:
{'display_name': 'Manufacturers Model Name', 'type': 'string'}
MatrixCoilMode (metadata)
name: Matrix Coil Mode
description:
(If used) A method for reducing the number of independent channels by combining in analog the signals from multiple coil elements. There are typically different default modes when using un-accelerated or accelerated (for example,
"GRAPPA"
,"SENSE"
) imaging.
schema information:
{'display_name': 'Matrix Coil Mode', 'type': 'string'}
MaxMovement (metadata)
name: Max Movement
description:
Maximum head movement (in mm) detected during the recording, as measured by the head localisation coils (for example,
4.8
).
schema information:
{'display_name': 'Max Movement', 'type': 'number', 'unit': 'mm'}
MeasurementToolMetadata (metadata)
name: Measurement Tool Metadata
description:
A description of the measurement tool as a whole. Contains two fields:
"Description"
and"TermURL"
."Description"
is a free text description of the measurement tool."TermURL"
is a URL to an entity in an ontology corresponding to this tool.
schema information:
{'display_name': 'Measurement Tool Metadata', 'type': 'object', 'properties': {'TermURL': {'type': 'string', 'format': 'uri'}, 'Description': {'type': 'string'}}}
MetaboliteAvail (metadata)
name: Metabolite Available
description:
Boolean that specifies if metabolite measurements are available. If
true
, themetabolite_parent_fraction
column MUST be present in the corresponding*_blood.tsv
file.
schema information:
{'display_name': 'Metabolite Available', 'type': 'boolean'}
MetaboliteMethod (metadata)
name: Metabolite Method
description:
Method used to measure metabolites.
schema information:
{'display_name': 'Metabolite Method', 'type': 'string'}
MetaboliteRecoveryCorrectionApplied (metadata)
name: Metabolite Recovery Correction Applied
description:
Metabolite recovery correction from the HPLC, for tracers where it changes with time postinjection. If
true
, thehplc_recovery_fractions
column MUST be present in the corresponding*_blood.tsv
file.
schema information:
{'display_name': 'Metabolite Recovery Correction Applied', 'type': 'boolean'}
MiscChannelCount (metadata)
name: Misc Channel Count
description:
Number of miscellaneous analog channels for auxiliary signals.
schema information:
{'display_name': 'Misc Channel Count', 'type': 'integer', 'minimum': 0}
MixingTime (metadata)
name: Mixing Time
description:
In the context of a stimulated- and spin-echo 3D EPI sequence for B1+ mapping, corresponds to the interval between spin- and stimulated-echo pulses. In the context of a diffusion-weighted double spin-echo sequence, corresponds to the interval between two successive diffusion sensitizing gradients, specified in seconds.
schema information:
{'display_name': 'Mixing Time', 'type': 'number', 'unit': 's'}
ModeOfAdministration (metadata)
name: Mode Of Administration
description:
Mode of administration of the injection (for example,
"bolus"
,"infusion"
, or"bolus-infusion"
).
schema information:
{'display_name': 'Mode Of Administration', 'type': 'string'}
MolarActivity (metadata)
name: Molar Activity
description:
Molar activity of compound injected. Corresponds to DICOM Tag 0018, 1077
Radiopharmaceutical Specific Activity
.
schema information:
{'display_name': 'Molar Activity', 'type': 'number'}
MolarActivityMeasTime (metadata)
name: Molar Activity Measurement Time
description:
Time to which molar radioactivity measurement above applies in the default unit
"hh:mm:ss"
.
schema information:
{'display_name': 'Molar Activity Measurement Time', 'type': 'string', 'format': 'time'}
MolarActivityUnits (metadata)
name: Molar Activity Units
description:
Unit of the specified molar radioactivity (for example,
"GBq/umol"
).
schema information:
{'display_name': 'Molar Activity Units', 'type': 'string', 'format': 'unit'}
MultibandAccelerationFactor (metadata)
name: Multiband Acceleration Factor
description:
The multiband factor, for multiband acquisitions.
schema information:
{'display_name': 'Multiband Acceleration Factor', 'type': 'number'}
MultipartID (metadata)
name: MultipartID
description:
A unique (per participant) label tagging DWI runs that are part of a multipart scan.
schema information:
{'display_name': 'MultipartID', 'type': 'string'}
NLO (suffixes)
name: Nonlinear optical microscopy
description:
Nonlinear optical microscopy imaging data
schema information:
{'value': 'NLO', 'display_name': 'Nonlinear optical microscopy'}
Name (metadata)
name: Name
description:
Name of the dataset.
schema information:
{'display_name': 'Name', 'type': 'string'}
NegativeContrast (metadata)
name: Negative Contrast
description:
true
orfalse
value specifying whether increasing voxel intensity (within sample voxels) denotes a decreased value with respect to the contrast suffix. This is commonly the case when Cerebral Blood Volume is estimated via usage of a contrast agent in conjunction with a T2* weighted acquisition protocol.
schema information:
{'display_name': 'Negative Contrast', 'type': 'boolean'}
None (extensions)
name: No extension
description:
A file with no extension.
schema information:
{'value': '', 'display_name': 'No extension'}
NonlinearGradientCorrection (metadata)
name: Nonlinear Gradient Correction
description:
Boolean stating if the image saved has been corrected for gradient nonlinearities by the scanner sequence.
schema information:
{'display_name': 'Nonlinear Gradient Correction', 'type': 'boolean'}
NumberOfVolumesDiscardedByScanner (metadata)
name: Number Of Volumes Discarded By Scanner
description:
Number of volumes ("dummy scans") discarded by the scanner (as opposed to those discarded by the user post hoc) before saving the imaging file. For example, a sequence that automatically discards the first 4 volumes before saving would have this field as 4. A sequence that does not discard dummy scans would have this set to 0. Please note that the onsets recorded in the
events.tsv
file should always refer to the beginning of the acquisition of the first volume in the corresponding imaging file - independent of the value of"NumberOfVolumesDiscardedByScanner"
field.
schema information:
{'display_name': 'Number Of Volumes Discarded By Scanner', 'type': 'integer', 'minimum': 0}
NumberOfVolumesDiscardedByUser (metadata)
name: Number Of Volumes Discarded By User
description:
Number of volumes ("dummy scans") discarded by the user before including the file in the dataset. If possible, including all of the volumes is strongly recommended. Please note that the onsets recorded in the
events.tsv
file should always refer to the beginning of the acquisition of the first volume in the corresponding imaging file - independent of the value of"NumberOfVolumesDiscardedByUser"
field.
schema information:
{'display_name': 'Number Of Volumes Discarded By User', 'type': 'integer', 'minimum': 0}
NumberShots (metadata)
name: Number Shots
description:
The number of RF excitations needed to reconstruct a slice or volume (may be referred to as partition). Please mind that this is not the same as Echo Train Length which denotes the number of k-space lines collected after excitation in a multi-echo readout. The data type array is applicable for specifying this parameter before and after the k-space center is sampled. Please see
"NumberShots"
metadata field in the qMRI appendix for corresponding calculations.
schema information:
{'display_name': 'Number Shots', 'anyOf': [{'type': 'number'}, {'type': 'array', 'items': {'type': 'number'}}]}
NumericalAperture (metadata)
name: Numerical Aperture
description:
Lens numerical aperture (for example:
1.4
). If the file format is OME-TIFF, the value MUST be consistent with theLensNA
OME metadata field.
schema information:
{'display_name': 'Numerical Aperture', 'type': 'number', 'exclusiveMinimum': 0}
OCT (suffixes)
name: Optical coherence tomography
description:
Optical coherence tomography imaging data
schema information:
{'value': 'OCT', 'display_name': 'Optical coherence tomography'}
OMEBigTiff (extensions)
name: Open Microscopy Environment BigTIFF
description:
A BigTIFF image file, for very large images.
schema information:
{'value': '.ome.btf', 'display_name': 'Open Microscopy Environment BigTIFF'}
OMETiff (extensions)
name: Open Microscopy Environment Tag Image File Format
description:
An OME-TIFF image file.
schema information:
{'value': '.ome.tif', 'display_name': 'Open Microscopy Environment Tag Image File Format'}
OMEZARR (extensions)
name: OME Next Generation File Format
description:
An OME-NGFF file.
OME-NGFF is a Zarr-based format, organizing data arrays in nested directories. This format was developed by the Open Microscopy Environment to provide data stream access to very large data.
schema information:
{'value': '.ome.zarr/', 'display_name': 'OME Next Generation File Format'}
OperatingSystem (metadata)
name: Operating System
description:
Operating system used to run the stimuli presentation software (for formatting recommendations, see examples below this table).
schema information:
{'display_name': 'Operating System', 'type': 'string'}
OtherAcquisitionParameters (metadata)
name: Other Acquisition Parameters
description:
Description of other relevant image acquisition parameters.
schema information:
{'display_name': 'Other Acquisition Parameters', 'type': 'string'}
PASLType (metadata)
name: PASL Type
description:
Type of the labeling pulse of the
PASL
labeling, for example"FAIR"
,"EPISTAR"
, or"PICORE"
.
schema information:
{'display_name': 'PASL Type', 'type': 'string'}
PC (suffixes)
name: Phase-contrast microscopy
description:
Phase-contrast microscopy imaging data
schema information:
{'value': 'PC', 'display_name': 'Phase-contrast microscopy'}
PCASLType (metadata)
name: PCASL Type
description:
The type of gradient pulses used in the
control
condition.
schema information:
{'display_name': 'PCASL Type', 'type': 'string', 'enum': ['balanced', 'unbalanced']}
PD (suffixes)
name: Proton density image
description:
Ambiguous, may refer to a parametric image or to a conventional image. Change: Replaced by
PDw
orPDmap
.
schema information:
{'value': 'PD', 'display_name': 'Proton density image', 'unit': 'arbitrary'}
PDT2 (suffixes)
name: PD and T2 weighted image
description:
In arbitrary units (arbitrary). PDw and T2w images acquired using a dual echo FSE sequence through view sharing process (Johnson et al. 1994).
schema information:
{'value': 'PDT2', 'display_name': 'PD and T2 weighted image', 'unit': 'arbitrary'}
PDT2map (suffixes)
name: Combined PD/T2 image
description:
In arbitrary units (arbitrary). Combined PD/T2 maps are REQUIRED to use this suffix regardless of the method used to generate them.
schema information:
{'value': 'PDT2map', 'display_name': 'Combined PD/T2 image', 'unit': 'arbitrary'}
PDmap (suffixes)
name: Proton density image
description:
In arbitrary units (arbitrary). PD maps are REQUIRED to use this suffix regardless of the method used to generate them.
schema information:
{'value': 'PDmap', 'display_name': 'Proton density image', 'unit': 'arbitrary'}
PDw (suffixes)
name: Proton density (PD) weighted image
description:
In arbitrary units (arbitrary). The contrast of these images is mainly determined by spatial variations in the spin density (1H) of the imaged specimen. In spin-echo sequences this contrast is achieved at short repetition and long echo times. In a gradient-echo acquisition, PD weighting dominates the contrast at long repetition and short echo times, and at small flip angles.
schema information:
{'value': 'PDw', 'display_name': 'Proton density (PD) weighted image', 'unit': 'arbitrary'}
PLI (suffixes)
name: Polarized-light microscopy
description:
Polarized-light microscopy imaging data
schema information:
{'value': 'PLI', 'display_name': 'Polarized-light microscopy'}
ParallelAcquisitionTechnique (metadata)
name: Parallel Acquisition Technique
description:
The type of parallel imaging used (for example
"GRAPPA"
,"SENSE"
). Corresponds to DICOM Tag 0018, 9078Parallel Acquisition Technique
.
schema information:
{'display_name': 'Parallel Acquisition Technique', 'type': 'string'}
ParallelReductionFactorInPlane (metadata)
name: Parallel Reduction Factor In Plane
description:
The parallel imaging (for instance, GRAPPA) factor. Use the denominator of the fraction of k-space encoded for each slice. For example, 2 means half of k-space is encoded. Corresponds to DICOM Tag 0018, 9069
Parallel Reduction Factor In-plane
.
schema information:
{'display_name': 'Parallel Reduction Factor In Plane', 'type': 'number'}
PartialFourier (metadata)
name: Partial Fourier
description:
The fraction of partial Fourier information collected. Corresponds to DICOM Tag 0018, 9081
Partial Fourier
.
schema information:
{'display_name': 'Partial Fourier', 'type': 'number'}
PartialFourierDirection (metadata)
name: Partial Fourier Direction
description:
The direction where only partial Fourier information was collected. Corresponds to DICOM Tag 0018, 9036
Partial Fourier Direction
.
schema information:
{'display_name': 'Partial Fourier Direction', 'type': 'string'}
PharmaceuticalDoseAmount (metadata)
name: Pharmaceutical Dose Amount
description:
Dose amount of pharmaceutical coadministered with tracer.
schema information:
{'display_name': 'Pharmaceutical Dose Amount', 'anyOf': [{'type': 'number'}, {'type': 'array', 'items': {'type': 'number'}}]}
PharmaceuticalDoseRegimen (metadata)
name: Pharmaceutical Dose Regimen
description:
Details of the pharmaceutical dose regimen. Either adequate description or short-code relating to regimen documented elsewhere (for example,
"single oral bolus"
).
schema information:
{'display_name': 'Pharmaceutical Dose Regimen', 'type': 'string'}
PharmaceuticalDoseTime (metadata)
name: Pharmaceutical Dose Time
description:
Time of administration of pharmaceutical dose, relative to time zero. For an infusion, this should be a vector with two elements specifying the start and end of the infusion period. For more complex dose regimens, the regimen description should be complete enough to enable unambiguous interpretation of
"PharmaceuticalDoseTime"
. Unit format of the specified pharmaceutical dose time MUST be seconds.
schema information:
{'display_name': 'Pharmaceutical Dose Time', 'anyOf': [{'type': 'number', 'unit': 's'}, {'type': 'array', 'items': {'type': 'number', 'unit': 's'}}]}
PharmaceuticalDoseUnits (metadata)
name: Pharmaceutical Dose Units
description:
Unit format relating to pharmaceutical dose (for example,
"mg"
or"mg/kg"
).
schema information:
{'display_name': 'Pharmaceutical Dose Units', 'type': 'string', 'format': 'unit'}
PharmaceuticalName (metadata)
name: Pharmaceutical Name
description:
Name of pharmaceutical coadministered with tracer.
schema information:
{'display_name': 'Pharmaceutical Name', 'type': 'string'}
PhaseEncodingDirection (metadata)
name: Phase Encoding Direction
description:
The letters
i
,j
,k
correspond to the first, second and third axis of the data in the NIFTI file. The polarity of the phase encoding is assumed to go from zero index to maximum index unless-
sign is present (then the order is reversed - starting from the highest index instead of zero).PhaseEncodingDirection
is defined as the direction along which phase is was modulated which may result in visible distortions. Note that this is not the same as the DICOM termInPlanePhaseEncodingDirection
which can haveROW
orCOL
values.
schema information:
{'display_name': 'Phase Encoding Direction', 'type': 'string', 'enum': ['i', 'j', 'k', 'i-', 'j-', 'k-']}
PixelSize (metadata)
name: Pixel Size
description:
A 2- or 3-number array of the physical size of a pixel, either
[PixelSizeX, PixelSizeY]
or[PixelSizeX, PixelSizeY, PixelSizeZ]
, where X is the width, Y the height and Z the depth. If the file format is OME-TIFF, these values need to be consistent withPhysicalSizeX
,PhysicalSizeY
andPhysicalSizeZ
OME metadata fields, after converting inPixelSizeUnits
according toPhysicalSizeXunit
,PhysicalSizeYunit
andPhysicalSizeZunit
OME fields.
schema information:
{'display_name': 'Pixel Size', 'type': 'array', 'minItems': 2, 'maxItems': 3, 'items': {'type': 'number', 'minimum': 0}}
PixelSizeUnits (metadata)
name: Pixel Size Units
description:
Unit format of the specified
"PixelSize"
. MUST be one of:"mm"
(millimeter),"um"
(micrometer) or"nm"
(nanometer).
schema information:
{'display_name': 'Pixel Size Units', 'type': 'string', 'enum': ['mm', 'um', 'nm']}
PlasmaAvail (metadata)
name: Plasma Avail
description:
Boolean that specifies if plasma measurements are available.
schema information:
{'display_name': 'Plasma Avail', 'type': 'boolean'}
PlasmaFreeFraction (metadata)
name: Plasma Free Fraction
description:
Measured free fraction in plasma, meaning the concentration of free compound in plasma divided by total concentration of compound in plasma (Units: 0-100%).
schema information:
{'display_name': 'Plasma Free Fraction', 'type': 'number', 'minimum': 0, 'maximum': 100}
PlasmaFreeFractionMethod (metadata)
name: Plasma Free Fraction Method
description:
Method used to estimate free fraction.
schema information:
{'display_name': 'Plasma Free Fraction Method', 'type': 'string'}
PostLabelingDelay (metadata)
name: Post Labeling Delay
description:
This is the postlabeling delay (PLD) time, in seconds, after the end of the labeling (for
"CASL"
or"PCASL"
) or middle of the labeling pulse (for"PASL"
) until the middle of the excitation pulse applied to the imaging slab (for 3D acquisition) or first slice (for 2D acquisition). Can be a number (for a single-PLD time series) or an array of numbers (for multi-PLD and Look-Locker). In the latter case, the array of numbers contains the PLD of each volume, namely eachcontrol
andlabel
, in the acquisition order. Any image within the time-series without a PLD, for example anm0scan
, is indicated by a zero. Based on DICOM Tags 0018, 9079Inversion Times
and 0018, 0082InversionTime
.
schema information:
{'display_name': 'Post Labeling Delay', 'anyOf': [{'type': 'number', 'exclusiveMinimum': 0, 'unit': 's'}, {'type': 'array', 'items': {'type': 'number', 'exclusiveMinimum': 0, 'unit': 's'}}]}
PowerLineFrequency (metadata)
name: Power Line Frequency
description:
Frequency (in Hz) of the power grid at the geographical location of the instrument (for example,
50
or60
).
schema information:
{'display_name': 'Power Line Frequency', 'anyOf': [{'type': 'number', 'exclusiveMinimum': 0, 'unit': 'Hz'}, {'type': 'string', 'enum': ['n/a']}]}
PromptRate (metadata)
name: Prompt Rate
description:
Prompt rate for each frame (same units as
Units
, for example,"Bq/mL"
).
schema information:
{'display_name': 'Prompt Rate', 'type': 'array', 'items': {'type': 'number'}}
PulseSequenceDetails (metadata)
name: Pulse Sequence Details
description:
Information beyond pulse sequence type that identifies the specific pulse sequence used (for example,
"Standard Siemens Sequence distributed with the VB17 software"
,"Siemens WIP ### version #.##,"
or"Sequence written by X using a version compiled on MM/DD/YYYY"
).
schema information:
{'display_name': 'Pulse Sequence Details', 'type': 'string'}
PulseSequenceType (metadata)
name: Pulse Sequence Type
description:
A general description of the pulse sequence used for the scan (for example,
"MPRAGE"
,"Gradient Echo EPI"
,"Spin Echo EPI"
,"Multiband gradient echo EPI"
).
schema information:
{'display_name': 'Pulse Sequence Type', 'type': 'string'}
Purity (metadata)
name: Purity
description:
Purity of the radiolabeled compound (between 0 and 100%).
schema information:
{'display_name': 'Purity', 'type': 'number', 'minimum': 0, 'maximum': 100}
R1map (suffixes)
name: Longitudinal relaxation rate image
description:
In seconds-1 (1/s). R1 maps (R1 = 1/T1) are REQUIRED to use this suffix regardless of the method used to generate them.
schema information:
{'value': 'R1map', 'display_name': 'Longitudinal relaxation rate image', 'unit': '1/s'}
R2map (suffixes)
name: True transverse relaxation rate image
description:
In seconds-1 (1/s). R2 maps (R2 = 1/T2) are REQUIRED to use this suffix regardless of the method used to generate them.
schema information:
{'value': 'R2map', 'display_name': 'True transverse relaxation rate image', 'unit': '1/s'}
R2starmap (suffixes)
name: Observed transverse relaxation rate image
description:
In seconds-1 (1/s). R2-star maps (R2star = 1/T2star) are REQUIRED to use this suffix regardless of the method used to generate them.
schema information:
{'value': 'R2starmap', 'display_name': 'Observed transverse relaxation rate image', 'unit': '1/s'}
RB1COR (suffixes)
name: RB1COR
description:
Low resolution images acquired by the body coil (in the gantry of the scanner) and the head coil using identical acquisition parameters to generate a combined sensitivity map as described in Papp et al. (2016).
schema information:
{'value': 'RB1COR', 'display_name': 'RB1COR'}
RB1map (suffixes)
name: RF receive sensitivity map
description:
In arbitrary units (arbitrary). Radio frequency (RF) receive (B1-) sensitivity maps are REQUIRED to use this suffix regardless of the method used to generate them. RB1map intensity values are RECOMMENDED to be represented as percent multiplicative factors such that Amplitudeeffective = B1-intensity*Amplitudeideal.
schema information:
{'value': 'RB1map', 'display_name': 'RF receive sensitivity map', 'unit': 'arbitrary'}
README (top_level_files)
name: Readme
description:
A REQUIRED text file,
README
, SHOULD describe the dataset in more detail. TheREADME
file MUST be either in ASCII or UTF-8 encoding and MAY have one of the extensions:.md
(Markdown),.rst
(reStructuredText), or.txt
. A BIDS dataset MUST NOT contain more than oneREADME
file (with or without extension) at its root directory. BIDS does not make any recommendations with regards to the Markdown flavor and does not validate the syntax of Markdown and reStructuredText. TheREADME
file SHOULD be structured such that its contents can be easily understood even if the used format is not rendered. A guideline for creating a goodREADME
file can be found in the bids-starter-kit.
schema information:
{'display_name': 'Readme'}
RandomRate (metadata)
name: Random Rate
description:
Random rate for each frame (same units as
"Units"
, for example,"Bq/mL"
).
schema information:
{'display_name': 'Random Rate', 'type': 'array', 'items': {'type': 'number'}}
RawSources (metadata)
name: Raw Sources
description:
A list of paths relative to dataset root pointing to the BIDS-Raw file(s) that were used in the creation of this derivative.
schema information:
{'display_name': 'Raw Sources', 'type': 'array', 'items': {'type': 'string', 'format': 'dataset_relative'}}
ReceiveCoilActiveElements (metadata)
name: Receive Coil Active Elements
description:
Information describing the active/selected elements of the receiver coil. This does not correspond to a tag in the DICOM ontology. The vendor-defined terminology for active coil elements can go in this field.
schema information:
{'display_name': 'Receive Coil Active Elements', 'type': 'string'}
ReceiveCoilName (metadata)
name: Receive Coil Name
description:
Information describing the receiver coil. Corresponds to DICOM Tag 0018, 1250
Receive Coil Name
, although not all vendors populate that DICOM Tag, in which case this field can be derived from an appropriate private DICOM field.
schema information:
{'display_name': 'Receive Coil Name', 'type': 'string'}
ReconFilterSize (metadata)
name: Recon Filter Size
description:
Kernel size of post-recon filter (FWHM) in default units
"mm"
.
schema information:
{'display_name': 'Recon Filter Size', 'anyOf': [{'type': 'number', 'unit': 'mm'}, {'type': 'array', 'items': {'type': 'number', 'unit': 'mm'}}]}
ReconFilterType (metadata)
name: Recon Filter Type
description:
Type of post-recon smoothing (for example,
["Shepp"]
).
schema information:
{'display_name': 'Recon Filter Type', 'anyOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}]}
ReconMethodImplementationVersion (metadata)
name: Recon Method Implementation Version
description:
Identification for the software used, such as name and version.
schema information:
{'display_name': 'Recon Method Implementation Version', 'type': 'string'}
ReconMethodName (metadata)
name: Recon Method Name
description:
Reconstruction method or algorithm (for example,
"3d-op-osem"
).
schema information:
{'display_name': 'Recon Method Name', 'type': 'string'}
ReconMethodParameterLabels (metadata)
name: Recon Method Parameter Labels
description:
Names of reconstruction parameters (for example,
["subsets", "iterations"]
).
schema information:
{'display_name': 'Recon Method Parameter Labels', 'type': 'array', 'items': {'type': 'string'}}
ReconMethodParameterUnits (metadata)
name: Recon Method Parameter Units
description:
Unit of reconstruction parameters (for example,
["none", "none"]
).
schema information:
{'display_name': 'Recon Method Parameter Units', 'type': 'array', 'items': {'type': 'string', 'format': 'unit'}}
ReconMethodParameterValues (metadata)
name: Recon Method Parameter Values
description:
Values of reconstruction parameters (for example,
[21, 3]
).
schema information:
{'display_name': 'Recon Method Parameter Values', 'type': 'array', 'items': {'type': 'number'}}
RecordingDuration (metadata)
name: Recording Duration
description:
Length of the recording in seconds (for example,
3600
).
schema information:
{'display_name': 'Recording Duration', 'type': 'number', 'unit': 's'}
RecordingType (metadata)
name: Recording Type
description:
Defines whether the recording is
"continuous"
,"discontinuous"
, or"epoched"
, where"epoched"
is limited to time windows about events of interest (for example, stimulus presentations or subject responses).
schema information:
{'display_name': 'Recording Type', 'type': 'string', 'enum': ['continuous', 'epoched', 'discontinuous']}
ReferencesAndLinks (metadata)
name: References And Links
description:
List of references to publications that contain information on the dataset. A reference may be textual or a URI.
schema information:
{'display_name': 'References And Links', 'items': {'type': 'string'}, 'type': 'array'}
RepetitionTime (metadata)
name: Repetition Time
description:
The time in seconds between the beginning of an acquisition of one volume and the beginning of acquisition of the volume following it (TR). When used in the context of functional acquisitions this parameter best corresponds to DICOM Tag 0020, 0110: the "time delta between images in a dynamic of functional set of images" but may also be found in DICOM Tag 0018, 0080: "the period of time in msec between the beginning of a pulse sequence and the beginning of the succeeding (essentially identical) pulse sequence". This definition includes time between scans (when no data has been acquired) in case of sparse acquisition schemes. This value MUST be consistent with the 'pixdim[4]' field (after accounting for units stored in 'xyzt_units' field) in the NIfTI header. This field is mutually exclusive with VolumeTiming.
schema information:
{'display_name': 'Repetition Time', 'type': 'number', 'exclusiveMinimum': 0, 'unit': 's'}
RepetitionTimeExcitation (metadata)
name: Repetition Time Excitation
description:
The interval, in seconds, between two successive excitations. [DICOM Tag 0018, 0080](http://dicomlookup.com/lookup.asp?sw=Tnumber&q=(0018,0080) best refers to this parameter. This field may be used together with the
"RepetitionTimePreparation"
for certain use cases, such as MP2RAGE. UseRepetitionTimeExcitation
(in combination with"RepetitionTimePreparation"
if needed) for anatomy imaging data rather than"RepetitionTime"
as it is already defined as the amount of time that it takes to acquire a single volume in the task imaging data section.
schema information:
{'display_name': 'Repetition Time Excitation', 'type': 'number', 'minimum': 0, 'unit': 's'}
RepetitionTimePreparation (metadata)
name: Repetition Time Preparation
description:
The interval, in seconds, that it takes a preparation pulse block to re-appear at the beginning of the succeeding (essentially identical) pulse sequence block. The data type number may apply to files from any MRI modality concerned with a single value for this field. The data type array provides a value for each volume in a 4D dataset and should only be used when the volume timing is critical for interpretation of the data, such as in ASL.
schema information:
{'display_name': 'Repetition Time Preparation', 'anyOf': [{'type': 'number', 'minimum': 0, 'unit': 's'}, {'type': 'array', 'items': {'type': 'number', 'minimum': 0, 'unit': 's'}}]}
Resolution (metadata)
name: Resolution
description:
Specifies the interpretation of the resolution keyword. If an object is used, then the keys should be values for the
res
entity and values should be descriptions of thoseres
values.
schema information:
{'display_name': 'Resolution', 'anyOf': [{'type': 'string'}, {'type': 'object', 'additionalProperties': {'type': 'string'}}]}
S0map (suffixes)
name: Observed signal amplitude (S0) image
description:
In arbitrary units (arbitrary). For a multi-echo (typically fMRI) sequence, S0 maps index the baseline signal before exponential (T2-star) signal decay. In other words: the exponential of the intercept for a linear decay model across log-transformed echos. For more information, please see, for example, the tedana documentation. S0 maps are RECOMMENDED to use this suffix if derived from an ME-FMRI dataset.
schema information:
{'value': 'S0map', 'display_name': 'Observed signal amplitude (S0) image'}
SEEGChannelCount (metadata)
name: SEEG Channel Count
description:
Number of SEEG channels.
schema information:
{'display_name': 'SEEG Channel Count', 'type': 'integer', 'minimum': 0}
SEM (suffixes)
name: Scanning electron microscopy
description:
Scanning electron microscopy imaging data
schema information:
{'value': 'SEM', 'display_name': 'Scanning electron microscopy'}
SPIM (suffixes)
name: Selective plane illumination microscopy
description:
Selective plane illumination microscopy imaging data
schema information:
{'value': 'SPIM', 'display_name': 'Selective plane illumination microscopy'}
SR (suffixes)
name: Super-resolution microscopy
description:
Super-resolution microscopy imaging data
schema information:
{'value': 'SR', 'display_name': 'Super-resolution microscopy'}
SampleEmbedding (metadata)
name: Sample Embedding
description:
Description of the tissue sample embedding (for example:
"Epoxy resin"
).
schema information:
{'display_name': 'Sample Embedding', 'type': 'string'}
SampleEnvironment (metadata)
name: Sample Environment
description:
Environment in which the sample was imaged. MUST be one of:
"in vivo"
,"ex vivo"
or"in vitro"
.
schema information:
{'display_name': 'Sample Environment', 'type': 'string', 'enum': ['in vivo', 'ex vivo', 'in vitro']}
SampleExtractionInstitution (metadata)
name: Sample Extraction Institution
description:
The name of the institution in charge of the extraction of the sample, if different from the institution in charge of the equipment that produced the image.
schema information:
{'display_name': 'Sample Extraction Institution', 'type': 'string'}
SampleExtractionProtocol (metadata)
name: Sample Extraction Protocol
description:
Description of the sample extraction protocol or URI (for example from protocols.io).
schema information:
{'display_name': 'Sample Extraction Protocol', 'type': 'string'}
SampleFixation (metadata)
name: Sample Fixation
description:
Description of the tissue sample fixation (for example:
"4% paraformaldehyde, 2% glutaraldehyde"
).
schema information:
{'display_name': 'Sample Fixation', 'type': 'string'}
SampleOrigin (metadata)
name: Sample Origin
description:
Describes from which tissue the genetic information was extracted.
schema information:
{'display_name': 'Sample Origin', 'type': 'string', 'enum': ['blood', 'saliva', 'brain', 'csf', 'breast milk', 'bile', 'amniotic fluid', 'other biospecimen']}
SamplePrimaryAntibody (metadata)
name: Sample Primary Antibody
description:
Description(s) of the primary antibody used for immunostaining. Either an RRID or the name, supplier and catalogue number of a commercial antibody. For non-commercial antibodies either an RRID or the host-animal and immunogen used (for examples:
"RRID:AB_2122563"
or"Rabbit anti-Human HTR5A Polyclonal Antibody, Invitrogen, Catalog # PA1-2453"
). MAY be an array of strings if different antibodies are used in each channel of the file.
schema information:
{'display_name': 'Sample Primary Antibody', 'anyOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}]}
SampleSecondaryAntibody (metadata)
name: Sample Secondary Antibody
description:
Description(s) of the secondary antibody used for immunostaining. Either an RRID or the name, supplier and catalogue number of a commercial antibody. For non-commercial antibodies either an RRID or the host-animal and immunogen used (for examples:
"RRID:AB_228322"
or"Goat anti-Mouse IgM Secondary Antibody, Invitrogen, Catalog # 31172"
). MAY be an array of strings if different antibodies are used in each channel of the file.
schema information:
{'display_name': 'Sample Secondary Antibody', 'anyOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}]}
SampleStaining (metadata)
name: Sample Staining
description:
Description(s) of the tissue sample staining (for example:
"Osmium"
). MAY be an array of strings if different stains are used in each channel of the file (for example:["LFB", "PLP"]
).
schema information:
{'display_name': 'Sample Staining', 'anyOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}]}
SamplingFrequency (metadata)
name: Sampling Frequency
description:
Sampling frequency (in Hz) of all the data in the recording, regardless of their type (for example,
2400
).
schema information:
{'display_name': 'Sampling Frequency', 'type': 'number', 'unit': 'Hz'}
ScaleFactor (metadata)
name: Scale Factor
description:
Scale factor for each frame. This field MUST be defined if the imaging data (
.nii[.gz]
) are scaled. If this field is not defined, then it is assumed that the scaling factor is 1. Defining this field when the scaling factor is 1 is RECOMMENDED, for the sake of clarity.
schema information:
{'display_name': 'Scale Factor', 'type': 'array', 'items': {'type': 'number'}}
ScanDate (metadata)
name: Scan Date
description:
Date of scan in the format
"YYYY-MM-DD[Z]"
. This field is DEPRECATED, and this metadata SHOULD be recorded in theacq_time
column of the corresponding Scans file.
schema information:
{'display_name': 'Scan Date', 'type': 'string', 'format': 'date'}
ScanOptions (metadata)
name: Scan Options
description:
Parameters of ScanningSequence. Corresponds to DICOM Tag 0018, 0022
Scan Options
.
schema information:
{'display_name': 'Scan Options', 'anyOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}]}
ScanStart (metadata)
name: Scan Start
description:
Time of start of scan with respect to
TimeZero
in the default unit seconds.
schema information:
{'display_name': 'Scan Start', 'type': 'number', 'unit': 's'}
ScanningSequence (metadata)
name: Scanning Sequence
description:
Description of the type of data acquired. Corresponds to DICOM Tag 0018, 0020
Scanning Sequence
.
schema information:
{'display_name': 'Scanning Sequence', 'anyOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}]}
ScatterFraction (metadata)
name: Scatter Fraction
description:
Scatter fraction for each frame (Units: 0-100%).
schema information:
{'display_name': 'Scatter Fraction', 'type': 'array', 'items': {'type': 'number', 'minimum': 0, 'maximum': 100}}
SequenceName (metadata)
name: Sequence Name
description:
Manufacturer's designation of the sequence name. Corresponds to DICOM Tag 0018, 0024
Sequence Name
.
schema information:
{'display_name': 'Sequence Name', 'type': 'string'}
SequenceVariant (metadata)
name: Sequence Variant
description:
Variant of the ScanningSequence. Corresponds to DICOM Tag 0018, 0021
Sequence Variant
.
schema information:
{'display_name': 'Sequence Variant', 'anyOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}]}
SinglesRate (metadata)
name: Singles Rate
description:
Singles rate for each frame (same units as
Units
, for example,"Bq/mL"
).
schema information:
{'display_name': 'Singles Rate', 'type': 'array', 'items': {'type': 'number'}}
SkullStripped (metadata)
name: Skull Stripped
description:
Whether the volume was skull stripped (non-brain voxels set to zero) or not.
schema information:
{'display_name': 'Skull Stripped', 'type': 'boolean'}
SliceEncodingDirection (metadata)
name: Slice Encoding Direction
description:
The axis of the NIfTI data along which slices were acquired, and the direction in which
"SliceTiming"
is defined with respect to.i
,j
,k
identifiers correspond to the first, second and third axis of the data in the NIfTI file. A-
sign indicates that the contents of"SliceTiming"
are defined in reverse order - that is, the first entry corresponds to the slice with the largest index, and the final entry corresponds to slice index zero. When present, the axis defined by"SliceEncodingDirection"
needs to be consistent with theslice_dim
field in the NIfTI header. When absent, the entries in"SliceTiming"
must be in the order of increasing slice index as defined by the NIfTI header.
schema information:
{'display_name': 'Slice Encoding Direction', 'type': 'string', 'enum': ['i', 'j', 'k', 'i-', 'j-', 'k-']}
SliceThickness (metadata)
name: Slice Thickness
description:
Slice thickness of the tissue sample in the unit micrometers (
"um"
) (for example:5
).
schema information:
{'display_name': 'Slice Thickness', 'type': 'number', 'unit': 'um', 'exclusiveMinimum': 0}
SliceTiming (metadata)
name: Slice Timing
description:
The time at which each slice was acquired within each volume (frame) of the acquisition. Slice timing is not slice order -- rather, it is a list of times containing the time (in seconds) of each slice acquisition in relation to the beginning of volume acquisition. The list goes through the slices along the slice axis in the slice encoding dimension (see below). Note that to ensure the proper interpretation of the
"SliceTiming"
field, it is important to check if the OPTIONALSliceEncodingDirection
exists. In particular, if"SliceEncodingDirection"
is negative, the entries in"SliceTiming"
are defined in reverse order with respect to the slice axis, such that the final entry in the"SliceTiming"
list is the time of acquisition of slice 0. Without this parameter slice time correction will not be possible.
schema information:
{'display_name': 'Slice Timing', 'type': 'array', 'items': {'type': 'number', 'minimum': 0, 'unit': 's'}}
SoftwareFilters (metadata)
name: Software Filters
description:
Object of temporal software filters applied, or
"n/a"
if the data is not available. Each key-value pair in the JSON object is a name of the filter and an object in which its parameters are defined as key-value pairs (for example,{"Anti-aliasing filter": {"half-amplitude cutoff (Hz)": 500, "Roll-off": "6dB/Octave"}}
).
schema information:
{'display_name': 'Software Filters', 'anyOf': [{'type': 'object', 'additionalProperties': {'type': 'object'}}, {'type': 'string', 'enum': ['n/a']}]}
SoftwareName (metadata)
name: Software Name
description:
Name of the software that was used to present the stimuli.
schema information:
{'display_name': 'Software Name', 'type': 'string'}
SoftwareRRID (metadata)
name: SoftwareRRID
description:
Research Resource Identifier of the software that was used to present the stimuli. Examples: The RRID for Psychtoolbox is 'SCR_002881', and that of PsychoPy is 'SCR_006571'.
schema information:
{'display_name': 'SoftwareRRID', 'type': 'string', 'format': 'rrid'}
SoftwareVersion (metadata)
name: Software Version
description:
Version of the software that was used to present the stimuli.
schema information:
{'display_name': 'Software Version', 'type': 'string'}
SoftwareVersions (metadata)
name: Software Versions
description:
Manufacturer's designation of software version of the equipment that produced the measurements.
schema information:
{'display_name': 'Software Versions', 'type': 'string'}
SourceDatasets (metadata)
name: Source Datasets
description:
Used to specify the locations and relevant attributes of all source datasets. Valid keys in each object include
"URL"
,"DOI"
(see URI), and"Version"
with string values.
schema information:
{'display_name': 'Source Datasets', 'type': 'array', 'items': {'type': 'object', 'properties': {'URL': {'type': 'string', 'format': 'uri'}, 'DOI': {'type': 'string'}, 'Version': {'type': 'string'}}}}
Sources (metadata)
name: Sources
description:
A list of files with the paths specified relative to dataset root; these files were directly used in the creation of this derivative data file. For example, if a derivative A is used in the creation of another derivative B, which is in turn used to generate C in a chain of A->B->C, C should only list B in
"Sources"
, and B should only list A in"Sources"
. However, in case both X and Y are directly used in the creation of Z, then Z should list X and Y in"Sources"
, regardless of whether X was used to generate Y.
schema information:
{'display_name': 'Sources', 'type': 'array', 'items': {'type': 'string', 'format': 'dataset_relative'}}
SpatialReference (metadata)
name: Spatial Reference
description:
For images with a single reference, the value MUST be a single string. For images with multiple references, such as surface and volume references, a JSON object MUST be used.
schema information:
{'display_name': 'Spatial Reference', 'anyOf': [{'type': 'string', 'enum': ['orig']}, {'type': 'string', 'format': 'uri'}, {'type': 'string', 'format': 'dataset_relative'}, {'type': 'object', 'additionalProperties': {'anyOf': [{'type': 'string', 'enum': ['orig']}, {'type': 'string', 'format': 'uri'}, {'type': 'string', 'format': 'dataset_relative'}]}}]}
SpecificRadioactivity (metadata)
name: Specific Radioactivity
description:
Specific activity of compound injected. Note this is not required for an FDG acquisition, since it is not available, and SHOULD be set to
"n/a"
.
schema information:
{'display_name': 'Specific Radioactivity', 'anyOf': [{'type': 'number'}, {'type': 'string', 'enum': ['n/a']}]}
SpecificRadioactivityMeasTime (metadata)
name: Specific Radioactivity Measurement Time
description:
Time to which specific radioactivity measurement above applies in the default unit
"hh:mm:ss"
.
schema information:
{'display_name': 'Specific Radioactivity Measurement Time', 'type': 'string', 'format': 'time'}
SpecificRadioactivityUnits (metadata)
name: Specific Radioactivity Units
description:
Unit format of specified specific radioactivity (for example,
"Bq/g"
). Note this is not required for an FDG acquisition, since it is not available, and SHOULD be set to"n/a"
.
schema information:
{'display_name': 'Specific Radioactivity Units', 'anyOf': [{'type': 'string', 'format': 'unit'}, {'type': 'string', 'enum': ['n/a']}]}
SpoilingGradientDuration (metadata)
name: Spoiling Gradient Duration
description:
The duration of the spoiler gradient lobe in seconds. The duration of a trapezoidal lobe is defined as the summation of ramp-up and plateau times.
schema information:
{'display_name': 'Spoiling Gradient Duration', 'type': 'number', 'unit': 's'}
SpoilingGradientMoment (metadata)
name: Spoiling Gradient Moment
description:
Zeroth moment of the spoiler gradient lobe in millitesla times second per meter (mT.s/m).
schema information:
{'display_name': 'Spoiling Gradient Moment', 'type': 'number', 'unit': 'mT.s/m'}
SpoilingRFPhaseIncrement (metadata)
name: Spoiling RF Phase Increment
description:
The amount of incrementation described in degrees, which is applied to the phase of the excitation pulse at each TR period for achieving RF spoiling.
schema information:
{'display_name': 'Spoiling RF Phase Increment', 'type': 'number', 'unit': 'degrees'}
SpoilingState (metadata)
name: Spoiling State
description:
Boolean stating whether the pulse sequence uses any type of spoiling strategy to suppress residual transverse magnetization.
schema information:
{'display_name': 'Spoiling State', 'type': 'boolean'}
SpoilingType (metadata)
name: Spoiling Type
description:
Specifies which spoiling method(s) are used by a spoiled sequence.
schema information:
{'display_name': 'Spoiling Type', 'type': 'string', 'enum': ['RF', 'GRADIENT', 'COMBINED']}
StartTime (metadata)
name: Start Time
description:
Start time in seconds in relation to the start of acquisition of the first data sample in the corresponding neural dataset (negative values are allowed).
schema information:
{'display_name': 'Start Time', 'type': 'number', 'unit': 's'}
StationName (metadata)
name: Station Name
description:
Institution defined name of the machine that produced the measurements.
schema information:
{'display_name': 'Station Name', 'type': 'string'}
StimulusPresentation (metadata)
name: Stimulus Presentation
description:
Object containing key-value pairs related to the software used to present the stimuli during the experiment, specifically:
"OperatingSystem"
,"SoftwareName"
,"SoftwareRRID"
,"SoftwareVersion"
and"Code"
. See table below for more information.
schema information:
{'display_name': 'Stimulus Presentation', 'type': 'object', 'properties': {'OperatingSystem': {'name': 'OperatingSystem', 'display_name': 'Operating System', 'description': 'Operating system used to run the stimuli presentation software\n(for formatting recommendations, see examples below this table).\n', 'type': 'string'}, 'SoftwareName': {'name': 'SoftwareName', 'display_name': 'Software Name', 'description': 'Name of the software that was used to present the stimuli.\n', 'type': 'string'}, 'SoftwareRRID': {'name': 'SoftwareRRID', 'display_name': 'SoftwareRRID', 'description': "[Research Resource Identifier](https://scicrunch.org/resources) of the\nsoftware that was used to present the stimuli.\nExamples: The RRID for Psychtoolbox is 'SCR_002881',\nand that of PsychoPy is 'SCR_006571'.\n", 'type': 'string', 'format': 'rrid'}, 'SoftwareVersion': {'name': 'SoftwareVersion', 'display_name': 'Software Version', 'description': 'Version of the software that was used to present the stimuli.\n', 'type': 'string'}, 'Code': {'name': 'Code', 'display_name': 'Code', 'description': '[URI](SPEC_ROOT/02-common-principles.md#uniform-resource-indicator)\nof the code used to present the stimuli.\nPersistent identifiers such as DOIs are preferred.\nIf multiple versions of code may be hosted at the same location,\nrevision-specific URIs are recommended.\n', 'type': 'string', 'format': 'uri'}}}
SubjectArtefactDescription (metadata)
name: Subject Artefact Description
description:
Freeform description of the observed subject artefact and its possible cause (for example,
"Vagus Nerve Stimulator"
,"non-removable implant"
). If this field is set to"n/a"
, it will be interpreted as absence of major source of artifacts except cardiac and blinks.
schema information:
{'display_name': 'Subject Artefact Description', 'type': 'string'}
T1map (suffixes)
name: Longitudinal relaxation time image
description:
In seconds (s). T1 maps are REQUIRED to use this suffix regardless of the method used to generate them. See this interactive book on T1 mapping for further reading on T1-mapping.
schema information:
{'value': 'T1map', 'display_name': 'Longitudinal relaxation time image', 'unit': 's'}
T1rho (suffixes)
name: T1 in rotating frame (T1 rho) image
description:
In seconds (s). T1-rho maps are REQUIRED to use this suffix regardless of the method used to generate them.
schema information:
{'value': 'T1rho', 'display_name': 'T1 in rotating frame (T1 rho) image', 'unit': 's'}
T1w (suffixes)
name: T1-weighted image
description:
In arbitrary units (arbitrary). The contrast of these images is mainly determined by spatial variations in the longitudinal relaxation time of the imaged specimen. In spin-echo sequences this contrast is achieved at relatively short repetition and echo times. To achieve this weighting in gradient-echo images, again, short repetition and echo times are selected; however, at relatively large flip angles. Another common approach to increase T1 weighting in gradient-echo images is to add an inversion preparation block to the beginning of the imaging sequence (for example,
TurboFLASH
orMP-RAGE
).
schema information:
{'value': 'T1w', 'display_name': 'T1-weighted image', 'unit': 'arbitrary'}
T2map (suffixes)
name: True transverse relaxation time image
description:
In seconds (s). T2 maps are REQUIRED to use this suffix regardless of the method used to generate them.
schema information:
{'value': 'T2map', 'display_name': 'True transverse relaxation time image', 'unit': 's'}
T2star (suffixes)
name: T2* image
description:
Ambiguous, may refer to a parametric image or to a conventional image. Change: Replaced by
T2starw
orT2starmap
.
schema information:
{'value': 'T2star', 'display_name': 'T2\\* image', 'anyOf': [{'unit': 'arbitrary'}, {'unit': 's'}]}
T2starmap (suffixes)
name: Observed transverse relaxation time image
description:
In seconds (s). T2-star maps are REQUIRED to use this suffix regardless of the method used to generate them.
schema information:
{'value': 'T2starmap', 'display_name': 'Observed transverse relaxation time image', 'unit': 's'}
T2starw (suffixes)
name: T2star weighted image
description:
In arbitrary units (arbitrary). The contrast of these images is mainly determined by spatial variations in the (observed) transverse relaxation time of the imaged specimen. In spin-echo sequences, this effect is negated as the excitation is followed by an inversion pulse. The contrast of gradient-echo images natively depends on T2-star effects. However, for T2-star variation to dominate the image contrast, gradient-echo acquisitions are carried out at long repetition and echo times, and at small flip angles.
schema information:
{'value': 'T2starw', 'display_name': 'T2star weighted image', 'unit': 'arbitrary'}
T2w (suffixes)
name: T2-weighted image
description:
In arbitrary units (arbitrary). The contrast of these images is mainly determined by spatial variations in the (true) transverse relaxation time of the imaged specimen. In spin-echo sequences this contrast is achieved at relatively long repetition and echo times. Generally, gradient echo sequences are not the most suitable option for achieving T2 weighting, as their contrast natively depends on T2-star rather than on T2.
schema information:
{'value': 'T2w', 'display_name': 'T2-weighted image', 'unit': 'arbitrary'}
TB1AFI (suffixes)
name: TB1AFI
description:
This method (Yarnykh 2007) calculates a B1+ map from two images acquired at interleaved (two) TRs with identical RF pulses using a steady-state sequence.
schema information:
{'value': 'TB1AFI', 'display_name': 'TB1AFI'}
TB1DAM (suffixes)
name: TB1DAM
description:
The double-angle B1+ method (Insko and Bolinger 1993) is based on the calculation of the actual angles from signal ratios, collected by two acquisitions at different nominal excitation flip angles. Common sequence types for this application include spin echo and echo planar imaging.
schema information:
{'value': 'TB1DAM', 'display_name': 'TB1DAM'}
TB1EPI (suffixes)
name: TB1EPI
description:
This B1+ mapping method (Jiru and Klose 2006) is based on two EPI readouts to acquire spin echo (SE) and stimulated echo (STE) images at multiple flip angles in one sequence, used in the calculation of deviations from the nominal flip angle.
schema information:
{'value': 'TB1EPI', 'display_name': 'TB1EPI'}
TB1RFM (suffixes)
name: TB1RFM
description:
The result of a Siemens
rf_map
product sequence. This sequence produces two images. The first image appears like an anatomical image and the second output is a scaled flip angle map.
schema information:
{'value': 'TB1RFM', 'display_name': 'TB1RFM'}
TB1SRGE (suffixes)
name: TB1SRGE
description:
Saturation-prepared with 2 rapid gradient echoes (SA2RAGE) uses a ratio of two saturation recovery images with different time delays, and a simulated look-up table to estimate B1+ (Eggenschwiler et al. 2011). This sequence can also be used in conjunction with MP2RAGE T1 mapping to iteratively improve B1+ and T1 map estimation (Marques & Gruetter 2013).
schema information:
{'value': 'TB1SRGE', 'display_name': 'TB1SRGE'}
TB1TFL (suffixes)
name: TB1TFL
description:
The result of a Siemens
tfl_b1_map
product sequence. This sequence produces two images. The first image appears like an anatomical image and the second output is a scaled flip angle map.
schema information:
{'value': 'TB1TFL', 'display_name': 'TB1TFL'}
TB1map (suffixes)
name: RF transmit field image
description:
In arbitrary units (arbitrary). Radio frequency (RF) transmit (B1+) field maps are REQUIRED to use this suffix regardless of the method used to generate them. TB1map intensity values are RECOMMENDED to be represented as percent multiplicative factors such that FlipAngleeffective = B1+intensity*FlipAnglenominal .
schema information:
{'value': 'TB1map', 'display_name': 'RF transmit field image', 'unit': 'arbitrary'}
TEM (suffixes)
name: Transmission electron microscopy
description:
Transmission electron microscopy imaging data
schema information:
{'value': 'TEM', 'display_name': 'Transmission electron microscopy'}
TaskDescription (metadata)
name: Task Description
description:
Longer description of the task.
schema information:
{'display_name': 'Task Description', 'type': 'string'}
TaskName (metadata)
name: Task Name
description:
Name of the task. No two tasks should have the same name. The task label included in the file name is derived from this
"TaskName"
field by removing all non-alphanumeric ([a-zA-Z0-9]
) characters. For example"TaskName"
"faces n-back"
will correspond to task labelfacesnback
.
schema information:
{'display_name': 'Task Name', 'type': 'string'}
TermURL (metadata)
name: TermURL
description:
URL pointing to a formal definition of this type of data in an ontology available on the web.
schema information:
{'display_name': 'TermURL', 'type': 'string'}
TimeZero (metadata)
name: Time Zero
description:
Time zero to which all scan and/or blood measurements have been adjusted to, in the unit "hh:mm:ss". This should be equal to
"InjectionStart"
or"ScanStart"
.
schema information:
{'display_name': 'Time Zero', 'type': 'string', 'format': 'time'}
TissueDeformationScaling (metadata)
name: Tissue Deformation Scaling
description:
Estimated deformation of the tissue, given as a percentage of the original tissue size (for examples: for a shrinkage of 3%, the value is
97
; and for an expansion of 100%, the value is200
).
schema information:
{'display_name': 'Tissue Deformation Scaling', 'type': 'number', 'exclusiveMinimum': 0}
TissueOrigin (metadata)
name: Tissue Origin
description:
Describes the type of tissue analyzed for
"SampleOrigin"
brain
.
schema information:
{'display_name': 'Tissue Origin', 'type': 'string', 'enum': ['gray matter', 'white matter', 'csf', 'meninges', 'macrovascular', 'microvascular']}
TotalAcquiredPairs (metadata)
name: Total Acquired Pairs
description:
The total number of acquired
control
-label
pairs. A single pair consists of a singlecontrol
and a singlelabel
image.
schema information:
{'display_name': 'Total Acquired Pairs', 'type': 'number', 'exclusiveMinimum': 0}
TotalReadoutTime (metadata)
name: Total Readout Time
description:
This is actually the "effective" total readout time, defined as the readout duration, specified in seconds, that would have generated data with the given level of distortion. It is NOT the actual, physical duration of the readout train. If
"EffectiveEchoSpacing"
has been properly computed, it is justEffectiveEchoSpacing * (ReconMatrixPE - 1)
.
schema information:
{'display_name': 'Total Readout Time', 'type': 'number', 'unit': 's'}
TracerMolecularWeight (metadata)
name: Tracer Molecular Weight
description:
Accurate molecular weight of the tracer used.
schema information:
{'display_name': 'Tracer Molecular Weight', 'type': 'number'}
TracerMolecularWeightUnits (metadata)
name: Tracer Molecular Weight Units
description:
Unit of the molecular weights measurement (for example,
"g/mol"
).
schema information:
{'display_name': 'Tracer Molecular Weight Units', 'type': 'string', 'format': 'unit'}
TracerName (metadata)
name: Tracer Name
description:
Name of the tracer compound used (for example,
"CIMBI-36"
)
schema information:
{'display_name': 'Tracer Name', 'type': 'string'}
TracerRadLex (metadata)
name: Tracer Rad Lex
description:
ID of the tracer compound from the RadLex Ontology.
schema information:
{'display_name': 'Tracer Rad Lex', 'type': 'string'}
TracerRadionuclide (metadata)
name: Tracer Radionuclide
description:
Radioisotope labelling tracer (for example,
"C11"
).
schema information:
{'display_name': 'Tracer Radionuclide', 'type': 'string'}
TracerSNOMED (metadata)
name: TracerSNOMED
description:
ID of the tracer compound from the SNOMED Ontology (subclass of Radioactive isotope).
schema information:
{'display_name': 'TracerSNOMED', 'type': 'string'}
TriggerChannelCount (metadata)
name: Trigger Channel Count
description:
Number of channels for digital (TTL bit level) triggers.
schema information:
{'display_name': 'Trigger Channel Count', 'type': 'integer', 'minimum': 0}
TubingLength (metadata)
name: Tubing Length
description:
The length of the blood tubing, from the subject to the detector in meters.
schema information:
{'display_name': 'Tubing Length', 'type': 'number', 'unit': 'm'}
TubingType (metadata)
name: Tubing Type
description:
Description of the type of tubing used, ideally including the material and (internal) diameter.
schema information:
{'display_name': 'Tubing Type', 'type': 'string'}
TwoPE (suffixes)
name: 2-photon excitation microscopy
description:
2-photon excitation microscopy imaging data
schema information:
{'value': '2PE', 'display_name': '2-photon excitation microscopy'}
Type (metadata)
name: Type
description:
Short identifier of the mask. The value
"Brain"
refers to a brain mask. The value"Lesion"
refers to a lesion mask. The value"Face"
refers to a face mask. The value"ROI"
refers to a region of interest mask.
schema information:
{'display_name': 'Type', 'type': 'string', 'enum': ['Brain', 'Lesion', 'Face', 'ROI']}
UNIT1 (suffixes)
name: Homogeneous (flat) T1-weighted MP2RAGE image
description:
In arbitrary units (arbitrary). UNIT1 images are REQUIRED to use this suffix regardless of the method used to generate them. Note that although this image is T1-weighted, regions without MR signal will contain white salt-and-pepper noise that most segmentation algorithms will fail on. Therefore, it is important to dissociate it from
T1w
. Please seeMP2RAGE
specific notes in the qMRI appendix for further information.
schema information:
{'value': 'UNIT1', 'display_name': 'Homogeneous (flat) T1-weighted MP2RAGE image'}
Units (metadata)
name: Units
description:
Measurement units for the associated file. SI units in CMIXF formatting are RECOMMENDED (see Units).
schema information:
{'display_name': 'Units', 'type': 'string', 'format': 'unit'}
VFA (suffixes)
name: Variable flip angle
description:
The VFA method involves at least two spoiled gradient echo (SPGR) of steady-state free precession (SSFP) images acquired at different flip angles. Depending on the provided metadata fields and the sequence type, data may be eligible for DESPOT1, DESPOT2 and their variants (Deoni et al. 2005).
schema information:
{'value': 'VFA', 'display_name': 'Variable flip angle'}
VascularCrushing (metadata)
name: Vascular Crushing
description:
Boolean indicating if Vascular Crushing is used. Corresponds to DICOM Tag 0018, 9259
ASL Crusher Flag
.
schema information:
{'display_name': 'Vascular Crushing', 'type': 'boolean'}
VascularCrushingVENC (metadata)
name: Vascular Crushing VENC
description:
The crusher gradient strength, in centimeters per second. Specify either one number for the total time-series, or provide an array of numbers, for example when using QUASAR, using the value zero to identify volumes for which
VascularCrushing
was turned off. Corresponds to DICOM Tag 0018, 925AASL Crusher Flow Limit
.
schema information:
{'display_name': 'Vascular Crushing VENC', 'anyOf': [{'type': 'number', 'unit': 'cm/s'}, {'type': 'array', 'items': {'type': 'number', 'unit': 'cm/s'}}]}
VolumeTiming (metadata)
name: Volume Timing
description:
The time at which each volume was acquired during the acquisition. It is described using a list of times referring to the onset of each volume in the BOLD series. The list must have the same length as the BOLD series, and the values must be non-negative and monotonically increasing. This field is mutually exclusive with
"RepetitionTime"
and"DelayTime"
. If defined, this requires acquisition time (TA) be defined via either"SliceTiming"
or"AcquisitionDuration"
be defined.
schema information:
{'display_name': 'Volume Timing', 'type': 'array', 'minItems': 1, 'items': {'type': 'number', 'unit': 's'}}
WholeBloodAvail (metadata)
name: Whole Blood Avail
description:
Boolean that specifies if whole blood measurements are available. If
true
, thewhole_blood_radioactivity
column MUST be present in the corresponding*_blood.tsv
file.
schema information:
{'display_name': 'Whole Blood Avail', 'type': 'boolean'}
WithdrawalRate (metadata)
name: Withdrawal Rate
description:
The rate at which the blood was withdrawn from the subject. The unit of the specified withdrawal rate should be in
"mL/s"
.
schema information:
{'display_name': 'Withdrawal Rate', 'type': 'number', 'unit': 'mL/s'}
abbreviation (columns)
name: Abbreviation
description:
The unique label abbreviation
schema information:
{'display_name': 'Abbreviation', 'type': 'string'}
acq_time sense 1 (columns)
name: Scan acquisition time
description:
Acquisition time refers to when the first data point in each run was acquired. Furthermore, if this header is provided, the acquisition times of all files from the same recording MUST be identical. Datetime format and their anonymization are described in Units.
schema information:
{'display_name': 'Scan acquisition time', 'type': 'string', 'format': 'datetime'}
acq_time sense 2 (columns)
name: Session acquisition time
description:
Acquisition time refers to when the first data point of the first run was acquired. Datetime format and their anonymization are described in Units.
schema information:
{'display_name': 'Session acquisition time', 'type': 'string', 'format': 'datetime'}
acquisition (entities)
name: Acquisition
description:
The
acq-<label>
entity corresponds to a custom label the user MAY use to distinguish a different set of parameters used for acquiring the same modality. For example this should be used when a study includes two T1w images - one full brain low resolution and one restricted field of view but high resolution. In such case two files could have the following names:sub-01_acq-highres_T1w.nii.gz
andsub-01_acq-lowres_T1w.nii.gz
, however the user is free to choose any other label thanhighres
andlowres
as long as they are consistent across subjects and sessions. In case different sequences are used to record the same modality (for example,RARE
andFLASH
for T1w) this field can also be used to make that distinction. At what level of detail to make the distinction (for example, just betweenRARE
andFLASH
, or betweenRARE
,FLASH
, andFLASHsubsampled
) remains at the discretion of the researcher.
schema information:
{'display_name': 'Acquisition', 'type': 'string', 'format': 'label'}
age (columns)
name: Subject age
description:
Numeric value in years (float or integer value).
schema information:
{'display_name': 'Subject age', 'type': 'number', 'unit': 'year'}
anat (datatypes)
name: Anatomical Magnetic Resonance Imaging
description:
Magnetic resonance imaging sequences designed to characterize static, anatomical features.
schema information:
{'value': 'anat', 'display_name': 'Anatomical Magnetic Resonance Imaging'}
angio (suffixes)
name: Angiogram
description:
Magnetic resonance angiography sequences focus on enhancing the contrast of blood vessels (generally arteries, but sometimes veins) against other tissue types.
schema information:
{'value': 'angio', 'display_name': 'Angiogram'}
asl (suffixes)
name: Arterial Spin Labeling
description:
The complete ASL time series stored as a 4D NIfTI file in the original acquisition order, with possible volume types including: control, label, m0scan, deltam, cbf.
schema information:
{'value': 'asl', 'display_name': 'Arterial Spin Labeling'}
aslcontext (suffixes)
name: Arterial Spin Labeling Context
description:
A TSV file defining the image types for volumes in an associated ASL file.
schema information:
{'value': 'aslcontext', 'display_name': 'Arterial Spin Labeling Context'}
asllabeling (suffixes)
name: ASL Labeling Screenshot
description:
An anonymized screenshot of the planning of the labeling slab/plane with respect to the imaging slab or slices
*_asllabeling.jpg
. Based on DICOM macro C.8.13.5.14.
schema information:
{'value': 'asllabeling', 'display_name': 'ASL Labeling Screenshot'}
atlas (entities)
name: Atlas
description:
The
atlas-<label>
key/value pair corresponds to a custom label the user MAY use to distinguish a different atlas used for similar type of data.
This entity is only applicable to derivative data.
schema information:
{'display_name': 'Atlas', 'type': 'string', 'format': 'label'}
ave (extensions)
name: AVE
description:
File containing data averaged by segments of interest.
Used by KIT, Yokogawa, and Ricoh MEG systems.
schema information:
{'value': '.ave', 'display_name': 'AVE'}
bdf (extensions)
name: Biosemi Data Format
description:
A Biosemi Data Format file.
Each recording consists of a single.bdf
file.bdf+
files are permitted. The capital.BDF
extension MUST NOT be used.
schema information:
{'value': '.bdf', 'display_name': 'Biosemi Data Format'}
beh (datatypes)
name: Behavioral Data
description:
Behavioral data.
schema information:
{'value': 'beh', 'display_name': 'Behavioral Data'}
beh (modalities)
name: Behavioral experiments
description:
Behavioral data acquired without accompanying neuroimaging data.
schema information:
{'display_name': 'Behavioral experiments'}
beh (suffixes)
name: Behavioral recording
description:
Behavioral recordings from tasks. These files are similar to events files, but do not include the
"onset"
and"duration"
columns that are mandatory for events files.
schema information:
{'value': 'beh', 'display_name': 'Behavioral recording'}
bids_uri (formats)
name: BIDS uniform resource indicator
description:
A BIDS uniform resource indicator.
The validation for this format is minimal. It simply ensures that the value is a string with any characters that may appear in a valid URI, starting with "bids:".
schema information:
{'display_name': 'BIDS uniform resource indicator', 'pattern': 'bids:[0-9a-zA-Z/#:\\?\\_\\-\\.]+'}
blood (suffixes)
name: Blood recording data
description:
Blood measurements of radioactivity stored in tabular files and located in the
pet/
directory along with the corresponding PET data.
schema information:
{'value': 'blood', 'display_name': 'Blood recording data'}
bold (suffixes)
name: Blood-Oxygen-Level Dependent image
description:
Blood-Oxygen-Level Dependent contrast (specialized T2* weighting)
schema information:
{'value': 'bold', 'display_name': 'Blood-Oxygen-Level Dependent image'}
boolean (formats)
name: Boolean
description:
A boolean. Must be either "true" or "false".
schema information:
{'display_name': 'Boolean', 'pattern': '(true|false)'}
bval (extensions)
name: FSL-Format Gradient Amplitudes
description:
A space-delimited file containing gradient directions (b-vectors) of diffusion measurement.
Thebval
file contains the b-values (in s/mm2) corresponding to the volumes in the relevant NIfTI file, with 0 designating b=0 volumes.
schema information:
{'value': '.bval', 'display_name': 'FSL-Format Gradient Amplitudes'}
bvec (extensions)
name: FSL-Format Gradient Directions
description:
A space-delimited file containing gradient directions (b-vectors) of diffusion measurement.
This file contains 3 rows with N space-delimited floating-point numbers, corresponding to the N volumes in the corresponding NIfTI file.
The first row contains the x elements, the second row contains the y elements and the third row contains the z elements of a unit vector in the direction of the applied diffusion gradient, where the i-th elements in each row correspond together to the i-th volume, with[0,0,0]
for non-diffusion-weighted (also called b=0 or low-b) volumes.
Following the FSL format for thebvec
specification, the coordinate system of the b vectors MUST be defined with respect to the coordinate system defined by the header of the corresponding_dwi
NIfTI file and not the scanner's device coordinate system (see Coordinate systems). The most relevant limitation imposed by this choice is that the gradient information cannot be directly stored in this format if the scanner generates b-vectors in scanner coordinates.
schema information:
{'value': '.bvec', 'display_name': 'FSL-Format Gradient Directions'}
cardiac (columns)
name: Cardiac measurement
description:
continuous pulse measurement
schema information:
{'display_name': 'Cardiac measurement', 'type': 'number'}
cbv (suffixes)
name: Cerebral blood volume image
description:
Cerebral Blood Volume contrast (specialized T2* weighting or difference between T1 weighted images)
schema information:
{'value': 'cbv', 'display_name': 'Cerebral blood volume image'}
ceagent (entities)
name: Contrast Enhancing Agent
description:
The
ce-<label>
entity can be used to distinguish sequences using different contrast enhanced images. The label is the name of the contrast agent. The key"ContrastBolusIngredient"
MAY also be added in the JSON file, with the same label.
schema information:
{'display_name': 'Contrast Enhancing Agent', 'type': 'string', 'format': 'label'}
channels (suffixes)
name: Channels File
description:
Channel information.
schema information:
{'value': 'channels', 'display_name': 'Channels File'}
chn (extensions)
name: KRISS CHN
description:
A file generated by KRISS MEG systems containing the position of the center of the MEG coils.
Each experimental run on the KRISS system produces a file with extension.kdf
. Additional files that may be available in the same folder include the digitized positions of the head points (\_digitizer.txt
), the position of the center of the MEG coils (.chn
), and the event markers (.trg
).
schema information:
{'value': '.chn', 'display_name': 'KRISS CHN'}
chunk (entities)
name: Chunk
description:
The
chunk-<index>
key/value pair is used to distinguish between different regions, 2D images or 3D volumes files, of the same physical sample with different fields of view acquired in the same imaging experiment.
schema information:
{'display_name': 'Chunk', 'type': 'string', 'format': 'index'}
code (associated_data)
name: Code
description:
A directory in which to store any code used to generate the derivatives from the source data.
schema information:
{'display_name': 'Code'}
color (columns)
name: Color label
description:
Hexadecimal. Label color for visualization.
schema information:
{'display_name': 'Color label', 'type': 'string', 'unit': 'hexadecimal'}
con (extensions)
name: KIT/Yokogawa/Ricoh Continuous Data
description:
Raw continuous data from a KIT/Yokogawa/Ricoh MEG system.
Successor to the.sqd
extension for raw continuous data.
schema information:
{'value': '.con', 'display_name': 'KIT/Yokogawa/Ricoh Continuous Data'}
coordsystem (suffixes)
name: Coordinate System File
description:
A JSON document specifying the coordinate system(s) used for the MEG, EEG, head localization coils, and anatomical landmarks.
schema information:
{'value': 'coordsystem', 'display_name': 'Coordinate System File'}
dat (extensions)
name: MEG Fine-Calibration Format
description:
A fine-calibration file used for Neuromag/Elekta/MEGIN MEG recording hardware.
schema information:
{'value': '.dat', 'display_name': 'MEG Fine-Calibration Format'}
dataset_description (top_level_files)
name: Dataset Description
description:
The file
dataset_description.json
is a JSON file describing the dataset.
schema information:
{'display_name': 'Dataset Description'}
dataset_relative (formats)
name: Path relative to the BIDS dataset directory
description:
A path to a file, relative to the dataset directory.
The validation for this format is minimal. It simply ensures that the value is a string with any characters that may appear in a valid path, without starting with "/" (an absolute path).
schema information:
{'display_name': 'Path relative to the BIDS dataset directory', 'pattern': '(?!/)[0-9a-zA-Z/\\_\\-\\.]+'}
date (formats)
name: Date
description:
A date in the form
"YYYY-MM-DD[Z]"
, where [Z] is an optional, valid timezone code.
schema information:
{'display_name': 'Date', 'pattern': '[0-9]{4}-[0-9]{2}-[0-9]{2}([A-Z]{2,4})?'}
datetime (formats)
name: Datetime
description:
A datetime in the form
"YYYY-MM-DDThh:mm:ss[.000000][Z]"
, where [.000000] is an optional subsecond resolution between 1 and 6 decimal points, and [Z] is an optional, valid timezone code.
schema information:
{'display_name': 'Datetime', 'pattern': '[0-9]{4}-[0-9]{2}-[0-9]{2}T(?:2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9](\\.[0-9]{1,6})?([A-Z]{2,4})?'}
defacemask (suffixes)
name: Defacing Mask
description:
A binary mask that was used to remove facial features from an anatomical MRI image.
schema information:
{'value': 'defacemask', 'display_name': 'Defacing Mask'}
density (entities)
name: Density
description:
Density of non-parametric surfaces. MUST have a corresponding
Density
metadata field to provide interpretation.
This entity is only applicable to derivative data.
schema information:
{'display_name': 'Density', 'type': 'string', 'format': 'label'}
derivatives (associated_data)
name: Derivative data
description:
Derivative data
schema information:
{'display_name': 'Derivative data'}
derived_from (columns)
name: Derived from
description:
sample-<label>
entity from which a sample is derived, for example a slice of tissue (sample-02
) derived from a block of tissue (sample-01
).
schema information:
{'display_name': 'Derived from', 'type': 'string', 'pattern': '^sample-[0-9a-zA-Z]+$'}
description (columns)
name: Description
description:
Brief free-text description of the channel, or other information of interest.
schema information:
{'display_name': 'Description', 'type': 'string'}
description (entities)
name: Description
description:
When necessary to distinguish two files that do not otherwise have a distinguishing entity, the
_desc-<label>
entity SHOULD be used.
This entity is only applicable to derivative data.
schema information:
{'display_name': 'Description', 'type': 'string', 'format': 'label'}
dimension (columns)
name: Dimension
description:
Size of the group (grid/strip/probe) that this electrode belongs to. Must be of form
[AxB]
with the smallest dimension first (for example,[1x8]
).
schema information:
{'display_name': 'Dimension', 'type': 'string'}
direction (entities)
name: Phase-Encoding Direction
description:
The
dir-<label>
entity can be set to an arbitrary alphanumeric label (for example,dir-LR
ordir-AP
) to distinguish different phase-encoding directions.
schema information:
{'display_name': 'Phase-Encoding Direction', 'type': 'string', 'format': 'label'}
duration (columns)
name: Event duration
description:
Duration of the event (measured from onset) in seconds. Must always be either zero or positive (or
n/a
if unavailable). A "duration" value of zero implies that the delta function or event is so short as to be effectively modeled as an impulse.
schema information:
{'display_name': 'Event duration', 'anyOf': [{'type': 'number', 'unit': 's', 'minimum': 0}, {'type': 'string', 'enum': ['n/a']}]}
dwi (datatypes)
name: Diffusion-Weighted Imaging
description:
Diffusion-weighted imaging (DWI).
schema information:
{'value': 'dwi', 'display_name': 'Diffusion-Weighted Imaging'}
dwi (suffixes)
name: Diffusion-weighted image
description:
Diffusion-weighted imaging contrast (specialized T2 weighting).
schema information:
{'value': 'dwi', 'display_name': 'Diffusion-weighted image'}
echo (entities)
name: Echo
description:
If files belonging to an entity-linked file collection are acquired at different echo times, the
_echo-<index>
entity MUST be used to distinguish individual files. This entity represents the"EchoTime"
metadata field. Please note that the<index>
denotes the number/index (in the form of a nonnegative integer), not the"EchoTime"
value which needs to be stored in the field"EchoTime"
of the separate JSON file.
schema information:
{'display_name': 'Echo', 'type': 'string', 'format': 'index'}
edf (extensions)
name: European Data Format
description:
A European data format file.
Each recording consists of a single.edf`` file. [
edf+](https://www.edfplus.info/specs/edfplus.html) files are permitted. The capital
.EDF` extension MUST NOT be used.
schema information:
{'value': '.edf', 'display_name': 'European Data Format'}
eeg (datatypes)
name: Electroencephalography
description:
Electroencephalography
schema information:
{'value': 'eeg', 'display_name': 'Electroencephalography'}
eeg (extensions)
name: BrainVision Binary Data
description:
A binary data file in the BrainVision Core Data Format. These files come in three-file sets, including a
.vhdr
, a.vmrk
, and a.eeg
file.
schema information:
{'value': '.eeg', 'display_name': 'BrainVision Binary Data'}
eeg (modalities)
name: Electroencephalography
description:
Data acquired with EEG.
schema information:
{'display_name': 'Electroencephalography'}
eeg (suffixes)
name: Electroencephalography
description:
Electroencephalography recording data.
schema information:
{'value': 'eeg', 'display_name': 'Electroencephalography'}
electrodes (suffixes)
name: Electrodes
description:
File that gives the location of (i)EEG electrodes.
schema information:
{'value': 'electrodes', 'display_name': 'Electrodes'}
epi (suffixes)
name: EPI
description:
The phase-encoding polarity (PEpolar) technique combines two or more Spin Echo EPI scans with different phase encoding directions to estimate the underlying inhomogeneity/deformation map.
schema information:
{'value': 'epi', 'display_name': 'EPI'}
events (suffixes)
name: Events
description:
Event timing information from a behavioral task.
schema information:
{'value': 'events', 'display_name': 'Events'}
fdt (extensions)
name: EEGLAB FDT
description:
An EEGLAB file.
The format used by the MATLAB toolbox EEGLAB. Each recording consists of a.set
file with an optional.fdt
file.
schema information:
{'value': '.fdt', 'display_name': 'EEGLAB FDT'}
fieldmap (suffixes)
name: Fieldmap
description:
Some MR schemes such as spiral-echo imaging (SEI) sequences are able to directly provide maps of the B0 field inhomogeneity.
schema information:
{'value': 'fieldmap', 'display_name': 'Fieldmap'}
fif (extensions)
name: Functional Imaging File Format
description:
An MEG file format used by Neuromag, Elekta, and MEGIN.
schema information:
{'value': '.fif', 'display_name': 'Functional Imaging File Format'}
file_relative (formats)
name: Path relative to the parent file
description:
A path to a file, relative to the file in which the field is defined.
The validation for this format is minimal. It simply ensures that the value is a string with any characters that may appear in a valid path, without starting with "/" (an absolute path).
schema information:
{'display_name': 'Path relative to the parent file', 'pattern': '(?!/)[0-9a-zA-Z/\\_\\-\\.]+'}
filename (columns)
name: Filename
description:
Relative paths to files.
schema information:
{'display_name': 'Filename', 'type': 'string', 'format': 'participant_relative'}
flip (entities)
name: Flip Angle
description:
If files belonging to an entity-linked file collection are acquired at different flip angles, the
_flip-<index>
entity pair MUST be used to distinguish individual files. This entity represents the"FlipAngle"
metadata field. Please note that the<index>
denotes the number/index (in the form of a nonnegative integer), not the"FlipAngle"
value which needs to be stored in the field"FlipAngle"
of the separate JSON file.
schema information:
{'display_name': 'Flip Angle', 'type': 'string', 'format': 'index'}
fmap (datatypes)
name: Field maps
description:
MRI scans for estimating B0 inhomogeneity-induced distortions.
schema information:
{'value': 'fmap', 'display_name': 'Field maps'}
func (datatypes)
name: Task-Based Magnetic Resonance Imaging
description:
Task (including resting state) imaging data
schema information:
{'value': 'func', 'display_name': 'Task-Based Magnetic Resonance Imaging'}
genetic_info (top_level_files)
name: Genetic Information
description:
The
genetic_info.json
file describes the genetic information available in theparticipants.tsv
file and/or the genetic database described indataset_description.json
. Datasets containing theGenetics
field indataset_description.json
or thegenetic_id
column inparticipants.tsv
MUST include this file.
schema information:
{'display_name': 'Genetic Information'}
group sense 1 (columns)
name: Channel group
description:
Which group of channels (grid/strip/seeg/depth) this channel belongs to. This is relevant because one group has one cable-bundle and noise can be shared. This can be a name or number.
schema information:
{'display_name': 'Channel group', 'anyOf': [{'type': 'string'}, {'type': 'number'}]}
handedness (columns)
name: Subject handedness
description:
String value indicating one of "left", "right", "ambidextrous".
For "left", use one of these values:left
,l
,L
,LEFT
,Left
.
For "right", use one of these values:right
,r
,R
,RIGHT
,Right
.
For "ambidextrous", use one of these values:ambidextrous
,a
,A
,AMBIDEXTROUS
,Ambidextrous
.
schema information:
{'display_name': 'Subject handedness', 'type': 'string', 'enum': ['left', 'l', 'L', 'LEFT', 'Left', 'right', 'r', 'R', 'RIGHT', 'Right', 'ambidextrous', 'a', 'A', 'AMBIDEXTROUS', 'Ambidextrous', 'n/a']}
headshape (suffixes)
name: Headshape File
description:
The 3-D locations of points that describe the head shape and/or electrode locations can be digitized and stored in separate files.
schema information:
{'value': 'headshape', 'display_name': 'Headshape File'}
hemisphere (columns)
name: Electrode hemisphere
description:
The hemisphere in which the electrode is placed.
schema information:
{'display_name': 'Electrode hemisphere', 'type': 'string', 'enum': ['L', 'R']}
hemisphere (entities)
name: Hemisphere
description:
The
hemi-<label>
entity indicates which hemibrain is described by the file. Allowed label values for this entity areL
andR
, for the left and right hemibrains, respectively.
schema information:
{'display_name': 'Hemisphere', 'type': 'string', 'format': 'label', 'enum': ['L', 'R']}
high_cutoff (columns)
name: High cutoff
description:
Frequencies used for the low-pass filter applied to the channel in Hz. If no low-pass filter applied, use
n/a
. Note that hardware anti-aliasing in A/D conversion of all MEG/EEG electronics applies a low-pass filter; specify its frequency here if applicable.
schema information:
{'display_name': 'High cutoff', 'anyOf': [{'type': 'number', 'unit': 'Hz', 'minimum': 0}, {'type': 'string', 'enum': ['n/a']}]}
hplc_recovery_fractions (columns)
name: HPLC recovery fractions
description:
HPLC recovery fractions (the fraction of activity that gets loaded onto the HPLC).
schema information:
{'display_name': 'HPLC recovery fractions', 'type': 'number', 'unit': 'arbitrary'}
iEEGCoordinateProcessingDescription (metadata)
name: iEEG Coordinate Processing Description
description:
Has any post-processing (such as projection) been done on the electrode positions (for example,
"surface_projection"
,"none"
).
schema information:
{'display_name': 'iEEG Coordinate Processing Description', 'type': 'string'}
iEEGCoordinateProcessingReference (metadata)
name: iEEG Coordinate Processing Reference
description:
A reference to a paper that defines in more detail the method used to localize the electrodes and to post-process the electrode positions.
schema information:
{'display_name': 'iEEG Coordinate Processing Reference', 'type': 'string'}
iEEGCoordinateSystem (metadata)
name: iEEG Coordinate System
description:
Defines the coordinate system for the iEEG sensors. See Appendix VIII for a list of restricted keywords for coordinate systems. If
"Other"
, provide definition of the coordinate system iniEEGCoordinateSystemDescription
. If positions correspond to pixel indices in a 2D image (of either a volume-rendering, surface-rendering, operative photo, or operative drawing), this MUST be"Pixels"
. For more information, see the section on 2D coordinate systems.
schema information:
{'display_name': 'iEEG Coordinate System', 'type': 'string', 'enum': ['Pixels', 'ACPC', 'Other', 'ICBM452AirSpace', 'ICBM452Warp5Space', 'IXI549Space', 'fsaverage', 'fsaverageSym', 'fsLR', 'MNIColin27', 'MNI152Lin', 'MNI152NLin2009aSym', 'MNI152NLin2009bSym', 'MNI152NLin2009cSym', 'MNI152NLin2009aAsym', 'MNI152NLin2009bAsym', 'MNI152NLin2009cAsym', 'MNI152NLin6Sym', 'MNI152NLin6ASym', 'MNI305', 'NIHPD', 'OASIS30AntsOASISAnts', 'OASIS30Atropos', 'Talairach', 'UNCInfant', 'fsaverage3', 'fsaverage4', 'fsaverage5', 'fsaverage6', 'fsaveragesym', 'UNCInfant0V21', 'UNCInfant1V21', 'UNCInfant2V21', 'UNCInfant0V22', 'UNCInfant1V22', 'UNCInfant2V22', 'UNCInfant0V23', 'UNCInfant1V23', 'UNCInfant2V23']}
iEEGCoordinateSystemDescription (metadata)
name: iEEG Coordinate System Description
description:
Free-form text description of the coordinate system. May also include a link to a documentation page or paper describing the system in greater detail.
schema information:
{'display_name': 'iEEG Coordinate System Description', 'type': 'string'}
iEEGCoordinateUnits (metadata)
name: iEEG Coordinate Units
description:
Units of the
*_electrodes.tsv
. MUST be"pixels"
ifiEEGCoordinateSystem
isPixels
.
schema information:
{'display_name': 'iEEG Coordinate Units', 'type': 'string', 'enum': ['m', 'mm', 'cm', 'pixels', 'n/a']}
iEEGElectrodeGroups (metadata)
name: iEEG Electrode Groups
description:
Field to describe the way electrodes are grouped into strips, grids or depth probes. For example,
"grid1: 10x8 grid on left temporal pole, strip2: 1x8 electrode strip on xxx"
.
schema information:
{'display_name': 'iEEG Electrode Groups', 'type': 'string'}
iEEGGround (metadata)
name: iEEG Ground
description:
Description of the location of the ground electrode (
"placed on right mastoid (M2)"
).
schema information:
{'display_name': 'iEEG Ground', 'type': 'string'}
iEEGPlacementScheme (metadata)
name: iEEG Placement Scheme
description:
Freeform description of the placement of the iEEG electrodes. Left/right/bilateral/depth/surface (for example,
"left frontal grid and bilateral hippocampal depth"
or"surface strip and STN depth"
or"clinical indication bitemporal, bilateral temporal strips and left grid"
).
schema information:
{'display_name': 'iEEG Placement Scheme', 'type': 'string'}
iEEGReference (metadata)
name: iEEG Reference
description:
General description of the reference scheme used and (when applicable) of location of the reference electrode in the raw recordings (for example,
"left mastoid"
,"bipolar"
,"T01"
for electrode with name T01,"intracranial electrode on top of a grid, not included with data"
,"upside down electrode"
). If different channels have a different reference, this field should have a general description and the channel specific reference should be defined in thechannels.tsv
file.
schema information:
{'display_name': 'iEEG Reference', 'type': 'string'}
ieeg (datatypes)
name: Intracranial electroencephalography
description:
Intracranial electroencephalography (iEEG) or electrocorticography (ECoG) data
schema information:
{'value': 'ieeg', 'display_name': 'Intracranial electroencephalography'}
ieeg (modalities)
name: Intracranial Electroencephalography
description:
Data acquired with iEEG.
schema information:
{'display_name': 'Intracranial Electroencephalography'}
ieeg (suffixes)
name: Intracranial Electroencephalography
description:
Intracranial electroencephalography recording data.
schema information:
{'value': 'ieeg', 'display_name': 'Intracranial Electroencephalography'}
impedance (columns)
name: Electrode impedance
description:
Impedance of the electrode, units MUST be in
kOhm
.
schema information:
{'display_name': 'Electrode impedance', 'type': 'number', 'unit': 'kOhm'}
index (columns)
name: Label index
description:
The label integer index.
schema information:
{'display_name': 'Label index', 'type': 'integer'}
index (formats)
name: Index
description:
Non-negative, non-zero integers, optionally prefixed with leading zeros for sortability. An index may not be all zeros.
schema information:
{'display_name': 'Index', 'pattern': '[0-9]*[1-9]+[0-9]*'}
inplaneT1 (suffixes)
name: Inplane T1
description:
In arbitrary units (arbitrary). T1 weighted structural image matched to a functional (task) image.
schema information:
{'value': 'inplaneT1', 'display_name': 'Inplane T1', 'unit': 'arbitrary'}
inplaneT2 (suffixes)
name: Inplane T2
description:
In arbitrary units (arbitrary). T2 weighted structural image matched to a functional (task) image.
schema information:
{'value': 'inplaneT2', 'display_name': 'Inplane T2', 'unit': 'arbitrary'}
integer (formats)
name: Integer
description:
An integer which may be positive or negative.
schema information:
{'display_name': 'Integer', 'pattern': '[+-]?\\d+'}
inversion (entities)
name: Inversion Time
description:
If files belonging to an entity-linked file collection are acquired at different inversion times, the
_inv-<index>
entity MUST be used to distinguish individual files. This entity represents the"InversionTime
metadata field. Please note that the<index>
denotes the number/index (in the form of a nonnegative integer), not the"InversionTime"
value which needs to be stored in the field"InversionTime"
of the separate JSON file.
schema information:
{'display_name': 'Inversion Time', 'type': 'string', 'format': 'index'}
jpg (extensions)
name: Joint Photographic Experts Group Format
description:
A JPEG image file.
schema information:
{'value': '.jpg', 'display_name': 'Joint Photographic Experts Group Format'}
json (extensions)
name: JavaScript Object Notation
description:
A JSON file.
In the BIDS specification, JSON files are primarily used as "sidecar" files, in which metadata describing "data" files are encoded. These sidecar files follow the inheritance principle.
There are also a few special cases of JSON files being first-order data files, such asgenetic_info.json
.
schema information:
{'value': '.json', 'display_name': 'JavaScript Object Notation'}
kdf (extensions)
name: KRISS KDF
description:
A KRISS (file with extension
.kdf
) file.
Each experimental run on the KRISS system produces a file with extension.kdf
. Additional files that may be available in the same folder include the digitized positions of the head points (\_digitizer.txt
), the position of the center of the MEG coils (.chn
), and the event markers (.trg
).
schema information:
{'value': '.kdf', 'display_name': 'KRISS KDF'}
label (entities)
name: Label
description:
Tissue-type label, following a prescribed vocabulary. Applies to binary masks and probabilistic/partial volume segmentations that describe a single tissue type.
This entity is only applicable to derivative data.
schema information:
{'display_name': 'Label', 'type': 'string', 'format': 'label'}
label (formats)
name: Label
description:
Freeform labels without special characters.
schema information:
{'display_name': 'Label', 'pattern': '[0-9a-zA-Z]+'}
low_cutoff (columns)
name: Low cutoff
description:
Frequencies used for the high-pass filter applied to the channel in Hz. If no high-pass filter applied, use
n/a
.
schema information:
{'display_name': 'Low cutoff', 'anyOf': [{'type': 'number', 'unit': 'Hz'}, {'type': 'string', 'enum': ['n/a']}]}
m0scan (suffixes)
name: M0 image
description:
The M0 image is a calibration image, used to estimate the equilibrium magnetization of blood.
schema information:
{'value': 'm0scan', 'display_name': 'M0 image'}
magnitude (suffixes)
name: Magnitude
description:
Field-mapping MR schemes such as gradient-recalled echo (GRE) generate a Magnitude image to be used for anatomical reference. Requires the existence of Phase, Phase-difference or Fieldmap maps.
schema information:
{'value': 'magnitude', 'display_name': 'Magnitude'}
magnitude1 (suffixes)
name: Magnitude
description:
Magnitude map generated by GRE or similar schemes, associated with the first echo in the sequence.
schema information:
{'value': 'magnitude1', 'display_name': 'Magnitude'}
magnitude2 (suffixes)
name: Magnitude
description:
Magnitude map generated by GRE or similar schemes, associated with the second echo in the sequence.
schema information:
{'value': 'magnitude2', 'display_name': 'Magnitude'}
manufacturer (columns)
name: Manufacturer
description:
The manufacturer for each electrode. Can be used if electrodes were manufactured by more than one company.
schema information:
{'display_name': 'Manufacturer', 'type': 'string'}
mapping (columns)
name: Label mapping
description:
Corresponding integer label in the standard BIDS label lookup.
schema information:
{'display_name': 'Label mapping', 'type': 'integer'}
markers (suffixes)
name: MEG Sensor Coil Positions
description:
Another manufacturer-specific detail pertains to the KIT/Yokogawa/Ricoh system, which saves the MEG sensor coil positions in a separate file with two possible filename extensions (
.sqd
,.mrk
). For these files, themarkers
suffix MUST be used. For example:sub-01_task-nback_markers.sqd
schema information:
{'value': 'markers', 'display_name': 'MEG Sensor Coil Positions'}
material (columns)
name: Electrode material
description:
Material of the electrode (for example,
Tin
,Ag/AgCl
,Gold
).
schema information:
{'display_name': 'Electrode material', 'type': 'string'}
md (extensions)
name: Markdown
description:
A Markdown file.
schema information:
{'value': '.md', 'display_name': 'Markdown'}
mefd (extensions)
name: Multiscale Electrophysiology File Format Version 3.0
description:
A folder in the MEF3 format.
Each recording consists of a.mefd
directory.
schema information:
{'value': '.mefd/', 'display_name': 'Multiscale Electrophysiology File Format Version 3.0'}
meg (datatypes)
name: Magnetoencephalography
description:
Magnetoencephalography
schema information:
{'value': 'meg', 'display_name': 'Magnetoencephalography'}
meg (modalities)
name: Magnetoencephalography
description:
Data acquired with an MEG scanner.
schema information:
{'display_name': 'Magnetoencephalography'}
meg (suffixes)
name: Magnetoencephalography
description:
Unprocessed MEG data stored in the native file format of the MEG instrument with which the data was collected.
schema information:
{'value': 'meg', 'display_name': 'Magnetoencephalography'}
metabolite_parent_fraction (columns)
name: Metabolite parent fraction
description:
Parent fraction of the radiotracer (0-1).
schema information:
{'display_name': 'Metabolite parent fraction', 'type': 'number', 'minimum': 0, 'maximum': 1}
metabolite_polar_fraction (columns)
name: Metabolite polar fraction
description:
Polar metabolite fraction of the radiotracer (0-1).
schema information:
{'display_name': 'Metabolite polar fraction', 'type': 'number', 'minimum': 0, 'maximum': 1}
mhd (extensions)
name: ITAB Binary Header
description:
Produced by ITAB-ARGOS153 systems. This file a binary header file, and is generated along with a raw data file with the
.raw
extension.
schema information:
{'value': '.mhd', 'display_name': 'ITAB Binary Header'}
micr (datatypes)
name: Microscopy
description:
Microscopy
schema information:
{'value': 'micr', 'display_name': 'Microscopy'}
micr (modalities)
name: Microscopy
description:
Data acquired with a microscope.
schema information:
{'display_name': 'Microscopy'}
modality (entities)
name: Corresponding Modality
description:
The
mod-<label>
entity corresponds to modality label for defacing masks, for example, T1w, inplaneT1, referenced by a defacemask image. For example,sub-01_mod-T1w_defacemask.nii.gz
.
schema information:
{'display_name': 'Corresponding Modality', 'type': 'string', 'format': 'label'}
mri (modalities)
name: Magnetic Resonance Imaging
description:
Data acquired with an MRI scanner.
schema information:
{'display_name': 'Magnetic Resonance Imaging'}
mrk (extensions)
name: MRK
description:
A file containing MEG sensor coil positions.
Used by KIT, Yokogawa, and Ricoh MEG systems. Successor to the.sqd
extension for marker files.
schema information:
{'value': '.mrk', 'display_name': 'MRK'}
mtransfer (entities)
name: Magnetization Transfer
description:
If files belonging to an entity-linked file collection are acquired at different magnetization transfer (MT) states, the
_mt-<label>
entity MUST be used to distinguish individual files. This entity represents the"MTState"
metadata field. Allowed label values for this entity areon
andoff
, for images acquired in presence and absence of an MT pulse, respectively.
schema information:
{'display_name': 'Magnetization Transfer', 'type': 'string', 'enum': ['on', 'off']}
name sense 1 (columns)
name: Channel name
description:
Label of the channel.
schema information:
{'display_name': 'Channel name', 'type': 'string'}
name sense 2 (columns)
name: Electrode name
description:
Name of the electrode contact point.
schema information:
{'display_name': 'Electrode name', 'type': 'string'}
name sense 3 (columns)
name: Label name
description:
The unique label name.
schema information:
{'display_name': 'Label name', 'type': 'string'}
nii (extensions)
name: NIfTI
description:
A Neuroimaging Informatics Technology Initiative (NIfTI) data file.
schema information:
{'value': '.nii', 'display_name': 'NIfTI'}
niigz (extensions)
name: Compressed NIfTI
description:
A compressed Neuroimaging Informatics Technology Initiative (NIfTI) data file.
schema information:
{'value': '.nii.gz', 'display_name': 'Compressed NIfTI'}
notch (columns)
name: Notch frequencies
description:
Frequencies used for the notch filter applied to the channel, in Hz. If no notch filter applied, use
n/a
.
schema information:
{'display_name': 'Notch frequencies', 'anyOf': [{'type': 'number', 'unit': 'Hz'}, {'type': 'string', 'enum': ['n/a']}]}
number (formats)
name: Number
description:
A number which may be an integer or float, positive or negative.
schema information:
{'display_name': 'Number', 'pattern': '[+-]?([0-9]+([.][0-9]*)?|[.][0-9]+)([eE][+-]?[0-9]+)?'}
nwb (extensions)
name: Neurodata Without Borders Format
description:
A Neurodata Without Borders file.
Each recording consists of a single.nwb
file.
schema information:
{'value': '.nwb', 'display_name': 'Neurodata Without Borders Format'}
onset (columns)
name: Event onset
description:
Onset (in seconds) of the event, measured from the beginning of the acquisition of the first data point stored in the corresponding task data file. Negative onsets are allowed, to account for events that occur prior to the first stored data point. For example, in case there is an in-scanner training phase that begins before the scanning sequence has started events from this sequence should have negative onset time counting down to the beginning of the acquisition of the first volume.
If any data points have been discarded before forming the data file (for example, "dummy volumes" in BOLD fMRI), a time of 0 corresponds to the first stored data point and not the first acquired data point.
schema information:
{'display_name': 'Event onset', 'type': 'number', 'unit': 's'}
part (entities)
name: Part
description:
This entity is used to indicate which component of the complex representation of the MRI signal is represented in voxel data. The
part-<label>
entity is associated with the DICOM Tag0008, 9208
. Allowed label values for this entity arephase
,mag
,real
andimag
, which are typically used inpart-mag
/part-phase
orpart-real
/part-imag
pairs of files.
Phase images MAY be in radians or in arbitrary units. The sidecar JSON file MUST include the units of thephase
image. The possible options are"rad"
or"arbitrary"
.
When there is only a magnitude image of a given type, thepart
entity MAY be omitted.
schema information:
{'display_name': 'Part', 'type': 'string', 'enum': ['mag', 'phase', 'real', 'imag']}
participant_id (columns)
name: Participant ID
description:
A participant identifier of the form
sub-<label>
, matching a participant entity found in the dataset.
schema information:
{'display_name': 'Participant ID', 'type': 'string', 'pattern': '^sub-[0-9a-zA-Z]+$'}
participant_relative (formats)
name: Path relative to the participant directory
description:
A path to a file, relative to the participant's directory in the dataset.
The validation for this format is minimal. It simply ensures that the value is a string with any characters that may appear in a valid path, without starting with "/" (an absolute path) or "sub/" (a relative path starting with the participant directory, rather than relative to that directory).
schema information:
{'display_name': 'Path relative to the participant directory', 'pattern': '(?!/)(?!sub-)[0-9a-zA-Z/\\_\\-\\.]+'}
participants (top_level_files)
name: Participant Information
description:
The purpose of this RECOMMENDED file is to describe properties of participants such as age, sex, handedness. If this file exists, it MUST contain the column
participant_id
, which MUST consist ofsub-<label>
values identifying one row for each participant, followed by a list of optional columns describing participants. Each participant MUST be described by one and only one row.
Commonly used optional columns inparticipant.tsv
files areage
,sex
, andhandedness
. We RECOMMEND to make use of these columns, and in case that you do use them, we RECOMMEND to use the following values for them:
-age
: numeric value in years (float or integer value)
-sex
: string value indicating phenotypical sex, one of "male", "female", "other"
- for "male", use one of these values:male
,m
,M
,MALE
,Male
- for "female", use one of these values:female
,f
,F
,FEMALE
,Female
- for "other", use one of these values:other
,o
,O
,OTHER
,Other
-handedness
: string value indicating one of "left", "right", "ambidextrous"
- for "left", use one of these values:left
,l
,L
,LEFT
,Left
- for "right", use one of these values:right
,r
,R
,RIGHT
,Right
- for "ambidextrous", use one of these values:ambidextrous
,a
,A
,AMBIDEXTROUS
,Ambidextrous
Throughout BIDS you can indicate missing values withn/a
(for "not available").
schema information:
{'display_name': 'Participant Information'}
pathology (columns)
name: Pathology
description:
String value describing the pathology of the sample or type of control. When different from
healthy
, pathology SHOULD be specified. The pathology may be specified in eithersamples.tsv
orsessions.tsv
, depending on whether the pathology changes over time.
schema information:
{'display_name': 'Pathology', 'type': 'string'}
perf (datatypes)
name: Perfusion imaging
description:
Blood perfusion imaging data, including arterial spin labeling (ASL)
schema information:
{'value': 'perf', 'display_name': 'Perfusion imaging'}
pet (datatypes)
name: Positron Emission Tomography
description:
Positron emission tomography data
schema information:
{'value': 'pet', 'display_name': 'Positron Emission Tomography'}
pet (modalities)
name: Positron Emission Tomography
description:
Data acquired with PET.
schema information:
{'display_name': 'Positron Emission Tomography'}
pet (suffixes)
name: Positron Emission Tomography
description:
PET imaging data SHOULD be stored in 4D (or 3D, if only one volume was acquired) NIfTI files with the
_pet
suffix. Volumes MUST be stored in chronological order (the order they were acquired in).
schema information:
{'value': 'pet', 'display_name': 'Positron Emission Tomography'}
phase (suffixes)
name: Phase image
description:
DEPRECATED. Phase information associated with magnitude information stored in BOLD contrast. This suffix should be replaced by the
part-phase
in conjunction with thebold
suffix.
schema information:
{'value': 'phase', 'display_name': 'Phase image', 'anyOf': [{'unit': 'arbitrary'}, {'unit': 'rad'}]}
phase1 (suffixes)
name: Phase
description:
Phase map generated by GRE or similar schemes, associated with the first echo in the sequence.
schema information:
{'value': 'phase1', 'display_name': 'Phase'}
phase2 (suffixes)
name: Phase
description:
Phase map generated by GRE or similar schemes, associated with the second echo in the sequence.
schema information:
{'value': 'phase2', 'display_name': 'Phase'}
phasediff (suffixes)
name: Phase-difference
description:
Some scanners subtract the
phase1
from thephase2
map and generate a uniquephasediff
file. For instance, this is a common output for the built-in fieldmap sequence of Siemens scanners.
schema information:
{'value': 'phasediff', 'display_name': 'Phase-difference'}
photo (suffixes)
name: Photo File
description:
Photos of the anatomical landmarks, head localization coils or tissue sample.
schema information:
{'value': 'photo', 'display_name': 'Photo File'}
physio (suffixes)
name: Physiological recording
description:
Physiological recordings such as cardiac and respiratory signals.
schema information:
{'value': 'physio', 'display_name': 'Physiological recording'}
plasma_radioactivity (columns)
name: Plasma radioactivity
description:
Radioactivity in plasma, in unit of plasma radioactivity (for example,
kBq/mL
).
schema information:
{'display_name': 'Plasma radioactivity', 'type': 'number'}
png (extensions)
name: Portable Network Graphics
description:
A Portable Network Graphics file.
schema information:
{'value': '.png', 'display_name': 'Portable Network Graphics'}
pos (extensions)
name: Head Point Position
description:
File containing digitized positions of the head points.
This may be produced by a 4D neuroimaging/BTi MEG system or a CTF MEG system.
schema information:
{'value': '.pos', 'display_name': 'Head Point Position'}
processing (entities)
name: Processed (on device)
description:
The proc label is analogous to rec for MR and denotes a variant of a file that was a result of particular processing performed on the device.
This is useful for files produced in particular by Elekta's MaxFilter (for example,sss
,tsss
,trans
,quat
ormc
), which some installations impose to be run on raw data because of active shielding software corrections before the MEG data can actually be exploited.
schema information:
{'display_name': 'Processed (on device)', 'type': 'string', 'format': 'label'}
raw (extensions)
name: RAW
description:
When produced by a KIT / Yokogawa / Ricoh MEG system, this file contains trial-based evoked fields.
When produced by an ITAB-ARGOS153 system, this file contains raw data and is generated along with an associated binary header file with the.mhd
extension.
schema information:
{'value': '.raw', 'display_name': 'RAW'}
reconstruction (entities)
name: Reconstruction
description:
The
rec-<label>
entity can be used to distinguish different reconstruction algorithms (for exampleMoCo
for the ones using motion correction).
schema information:
{'display_name': 'Reconstruction', 'type': 'string', 'format': 'label'}
recording (entities)
name: Recording
description:
More than one continuous recording file can be included (with different sampling frequencies). In such case use different labels. For example:
_recording-contrast
,_recording-saturation
.
schema information:
{'display_name': 'Recording', 'type': 'string', 'format': 'label'}
reference sense 1 (columns)
name: Electrode reference
description:
Name of the reference electrode(s). This column is not needed when it is common to all channels. In that case the reference electrode(s) can be specified in
*_eeg.json
asEEGReference
).
schema information:
{'display_name': 'Electrode reference', 'type': 'string'}
reference sense 2 (columns)
name: Electrode reference
description:
Specification of the reference (for example,
mastoid
,ElectrodeName01
,intracranial
,CAR
,other
,n/a
). If the channel is not an electrode channel (for example, a microphone channel) usen/a
.
schema information:
{'display_name': 'Electrode reference', 'anyOf': [{'type': 'string'}, {'type': 'string', 'enum': ['n/a']}]}
resolution (entities)
name: Resolution
description:
Resolution of regularly sampled N-dimensional data. MUST have a corresponding
"Resolution"
metadata field to provide interpretation.
This entity is only applicable to derivative data.
schema information:
{'display_name': 'Resolution', 'type': 'string', 'format': 'label'}
respiratory (columns)
name: Respiratory measurement
description:
continuous breathing measurement
schema information:
{'display_name': 'Respiratory measurement', 'type': 'number'}
response_time (columns)
name: Response time
description:
Response time measured in seconds. A negative response time can be used to represent preemptive responses and
n/a
denotes a missed response.
schema information:
{'display_name': 'Response time', 'anyOf': [{'type': 'number', 'unit': 's'}, {'type': 'string', 'enum': ['n/a']}]}
rrid (formats)
name: Research resource identifier
description:
schema information:
{'display_name': 'Research resource identifier', 'pattern': 'RRID:.+_.+'}
rst (extensions)
name: reStructuredText
description:
A reStructuredText file.
schema information:
{'value': '.rst', 'display_name': 'reStructuredText'}
run (entities)
name: Run
description:
If several data acquisitions (for example, MRI scans or EEG recordings) with the same acquisition parameters are acquired in the same session, they MUST be indexed with the
run-<index>
entity:_run-1
,_run-2
,_run-3
, and so on (only nonnegative integers are allowed as run labels).
If different entities apply, such as a different session indicated byses-<label>
, or different acquisition parameters indicated byacq-<label>
, thenrun
is not needed to distinguish the scans and MAY be omitted.
schema information:
{'display_name': 'Run', 'type': 'string', 'format': 'index'}
sample (columns)
name: Sample index
description:
Onset of the event according to the sampling scheme of the recorded modality (that is, referring to the raw data file that the
events.tsv
file accompanies).
schema information:
{'display_name': 'Sample index', 'type': 'integer'}
sample (entities)
name: Sample
description:
A sample pertaining to a subject such as tissue, primary cell or cell-free sample. The
sample-<label>
entity is used to distinguish between different samples from the same subject. The label MUST be unique per subject and is RECOMMENDED to be unique throughout the dataset.
schema information:
{'display_name': 'Sample', 'type': 'string', 'format': 'label'}
sample_id (columns)
name: Sample ID
description:
A sample identifier of the form
sample-<label>
, matching a sample entity found in the dataset.
schema information:
{'display_name': 'Sample ID', 'type': 'string', 'pattern': '^sample-[0-9a-zA-Z]+$'}
sample_type (columns)
name: Sample type
description:
Biosample type defined by ENCODE Biosample Type.
schema information:
{'display_name': 'Sample type', 'type': 'string', 'enum': ['cell line', 'in vitro differentiated cells', 'primary cell', 'cell-free sample', 'cloning host', 'tissue', 'whole organisms', 'organoid', 'technical sample']}
samples (top_level_files)
name: Sample Information
description:
The purpose of this file is to describe properties of samples, indicated by the
sample
entity. This file is REQUIRED ifsample-<label>
is present in any file name within the dataset. If this file exists, it MUST contain the three following columns:
-sample_id
: MUST consist ofsample-<label>
values identifying one row for each sample
-participant_id
: MUST consist ofsub-<label>
-sample_type
: MUST consist of sample type values, eithercell line
,in vitro differentiated cells
,primary cell
,cell-free sample
,cloning host
,tissue
,whole organisms
,organoid
ortechnical sample
from ENCODE Biosample Type
Other optional columns MAY be used to describe the samples. Each sample MUST be described by one and only one row.
Commonly used optional columns insamples.tsv
files arepathology
andderived_from
. We RECOMMEND to make use of these columns, and in case that you do use them, we RECOMMEND to use the following values for them:
-pathology
: string value describing the pathology of the sample or type of control. When different fromhealthy
, pathology SHOULD be specified insamples.tsv
. The pathology MAY instead be specified in Sessions files in case it changes over time.
-derived_from
:sample-<label>
key/value pair from which a sample is derived from, for example a slice of tissue (sample-02
) derived from a block of tissue (sample-01
)
schema information:
{'display_name': 'Sample Information'}
sampling_frequency (columns)
name: Channel sampling frequency
description:
Sampling rate of the channel in Hz.
schema information:
{'display_name': 'Channel sampling frequency', 'type': 'number', 'unit': 'Hz'}
sbref (suffixes)
name: Single-band reference image
description:
Single-band reference for one or more multi-band
dwi
images.
schema information:
{'value': 'sbref', 'display_name': 'Single-band reference image'}
scans (suffixes)
name: Scans file
description:
The purpose of this file is to describe timing and other properties of each imaging acquisition sequence (each run file) within one session. Each neural recording file SHOULD be described by exactly one row. Some recordings consist of multiple parts, that span several files, for example through echo-, part-, or split- entities. Such recordings MUST be documented with one row per file. Relative paths to files should be used under a compulsory filename header. If acquisition time is included it should be listed under the acq_time header. Acquisition time refers to when the first data point in each run was acquired. Furthermore, if this header is provided, the acquisition times of all files that belong to a recording MUST be identical. Datetime should be expressed as described in Units. Additional fields can include external behavioral measures relevant to the scan. For example vigilance questionnaire score administered after a resting state scan. All such included additional fields SHOULD be documented in an accompanying _scans.json file that describes these fields in detail (see Tabular files).
schema information:
{'value': 'scans', 'display_name': 'Scans file'}
session (entities)
name: Session
description:
A logical grouping of neuroimaging and behavioral data consistent across subjects. Session can (but doesn't have to) be synonymous to a visit in a longitudinal study. In general, subjects will stay in the scanner during one session. However, for example, if a subject has to leave the scanner room and then be re-positioned on the scanner bed, the set of MRI acquisitions will still be considered as a session and match sessions acquired in other subjects. Similarly, in situations where different data types are obtained over several visits (for example fMRI on one day followed by DWI the day after) those can be grouped in one session. Defining multiple sessions is appropriate when several identical or similar data acquisitions are planned and performed on all -or most- subjects, often in the case of some intervention between sessions (for example, training).
schema information:
{'display_name': 'Session', 'type': 'string', 'format': 'label'}
session_id (columns)
name: Session ID
description:
A session identifier of the form
ses-<label>
, matching a session found in the dataset.
schema information:
{'display_name': 'Session ID', 'type': 'string', 'pattern': '^ses-[0-9a-zA-Z]+$'}
sessions (suffixes)
name: Sessions file
description:
In case of multiple sessions there is an option of adding additional sessions.tsv files describing variables changing between sessions. In such case one file per participant SHOULD be added. These files MUST include a session_id column and describe each session by one and only one row. Column names in sessions.tsv files MUST be different from group level participant key column names in the participants.tsv file.
schema information:
{'value': 'sessions', 'display_name': 'Sessions file'}
set (extensions)
name: EEGLAB SET
description:
An EEGLAB file.
The format used by the MATLAB toolbox EEGLAB. Each recording consists of a.set
file with an optional.fdt
file.
schema information:
{'value': '.set', 'display_name': 'EEGLAB SET'}
sex (columns)
name: Sex
description:
String value indicating phenotypical sex, one of "male", "female", "other".
For "male", use one of these values:male
,m
,M
,MALE
,Male
.
For "female", use one of these values:female
,f
,F
,FEMALE
,Female
.
For "other", use one of these values:other
,o
,O
,OTHER
,Other
.
schema information:
{'display_name': 'Sex', 'type': 'string', 'enum': ['male', 'm', 'M', 'MALE', 'Male', 'female', 'f', 'F', 'FEMALE', 'Female', 'other', 'o', 'O', 'OTHER', 'Other', 'n/a']}
size (columns)
name: Electrode size
description:
Surface area of the electrode, units MUST be in
mm^2
.
schema information:
{'display_name': 'Electrode size', 'type': 'number', 'unit': 'mm^2'}
software_filters (columns)
name: Software filters
description:
List of temporal and/or spatial software filters applied (for example,
SSS
,SpatialCompensation
). Note that parameters should be defined in the general MEG sidecar .json file. Indicaten/a
in the absence of software filters applied.
schema information:
{'display_name': 'Software filters', 'anyOf': [{'type': 'string'}, {'type': 'string', 'enum': ['n/a']}]}
sourcedata (associated_data)
name: Source data
description:
Data before harmonization, reconstruction, and/or file format conversion (for example, E-Prime event logs or DICOM files).
schema information:
{'display_name': 'Source data'}
space (entities)
name: Space
description:
The space entity can be used to indicate the way in which electrode positions are interpreted (for EEG/MEG/iEEG data) or the spatial reference to which a file has been aligned (for MRI data). The space
<label>
MUST be taken from one of the modality specific lists in Appendix VIII. For example for iEEG data, the restricted keywords listed under iEEG Specific Coordinate Systems are acceptable for<label>
.
For EEG/MEG/iEEG data, this entity can be applied to raw data, but for other data types, it is restricted to derivative data.
schema information:
{'display_name': 'Space', 'type': 'string', 'format': 'label'}
species (columns)
name: Species
description:
The
species
column SHOULD be a binomial species name from the NCBI Taxonomy (for example,homo sapiens
,mus musculus
,rattus norvegicus
). For backwards compatibility, ifspecies
is absent, the participant is assumed to behomo sapiens
.
schema information:
{'display_name': 'Species', 'type': 'string'}
split (entities)
name: Split
description:
In the case of long data recordings that exceed a file size of 2Gb, the .fif files are conventionally split into multiple parts. Each of these files has an internal pointer to the next file. This is important when renaming these split recordings to the BIDS convention.
Instead of a simple renaming, files should be read in and saved under their new names with dedicated tools like MNE-Python, which will ensure that not only the file names, but also the internal file pointers will be updated. It is RECOMMENDED that .fif files with multiple parts use thesplit-<index>
entity to indicate each part. If there are multiple parts of a recording and the optionalscans.tsv
is provided, remember to list all files separately inscans.tsv
and that the entries for theacq_time
column inscans.tsv
MUST all be identical, as described in Scans file.
schema information:
{'display_name': 'Split', 'type': 'string', 'format': 'index'}
sqd (extensions)
name: SQD
description:
A file containing either raw MEG data or MEG sensor coil positions. While this extension is still valid, it has been succeeded by
.con
for raw MEG data and.mrk
for marker information.
Used by KIT, Yokogawa, and Ricoh MEG systems.
schema information:
{'value': '.sqd', 'display_name': 'SQD'}
stain (entities)
name: Stain
description:
The
stain-<label>
key/pair values can be used to distinguish image files from the same sample using different stains or antibodies for contrast enhancement. Stains SHOULD be indicated in the"SampleStaining"
key in the sidecar JSON file, although the label may be different. Description of antibodies SHOULD also be indicated in"SamplePrimaryAntibodies"
and/or"SampleSecondaryAntobodies"
as appropriate.
schema information:
{'display_name': 'Stain', 'type': 'string', 'format': 'label'}
status (columns)
name: Channel status
description:
Data quality observed on the channel. A channel is considered
bad
if its data quality is compromised by excessive noise. If quality is unknown, then a value ofn/a
may be used. Description of noise type SHOULD be provided in[status_description]
.
schema information:
{'display_name': 'Channel status', 'type': 'string', 'enum': ['good', 'bad', 'n/a']}
status_description (columns)
name: Channel status description
description:
Freeform text description of noise or artifact affecting data quality on the channel. It is meant to explain why the channel was declared bad in the
status
column.
schema information:
{'display_name': 'Channel status description', 'type': 'string'}
stim (suffixes)
name: Continuous recording
description:
Continuous measures, such as parameters of a film or audio stimulus.
schema information:
{'value': 'stim', 'display_name': 'Continuous recording'}
stim_file (columns)
name: Stimulus file
description:
Represents the location of the stimulus file (such as an image, video, or audio file) presented at the given onset time. There are no restrictions on the file formats of the stimuli files, but they should be stored in the
/stimuli
directory (under the root directory of the dataset; with optional subdirectories). The values under thestim_file
column correspond to a path relative to/stimuli
. For exampleimages/cat03.jpg
will be translated to/stimuli/images/cat03.jpg
.
schema information:
{'display_name': 'Stimulus file', 'type': 'string', 'format': 'stimuli_relative'}
stimuli (associated_data)
name: Stimulus files
description:
The stimulus files can be added in a
/stimuli
directory (under the root directory of the dataset; with optional subdirectories) AND using a stim_file column in *_events.tsv mentioning which stimulus file was used for a given event.
There are no restrictions on the file formats of the stimuli files, but they should be stored in the/stimuli
directory.
schema information:
{'display_name': 'Stimulus files'}
stimuli_relative (formats)
name: Path relative to the stimuli directory
description:
A path to a stimulus file, relative to a
/stimuli
directory somewhere.
The validation for this format is minimal. It simply ensures that the value is a string with any characters that may appear in a valid path, without starting with "/" (an absolute path) or "stimuli/" (a relative path starting with the stimuli directory, rather than relative to that directory).
schema information:
{'display_name': 'Path relative to the stimuli directory', 'pattern': '(?!/)(?!stimuli/)[0-9a-zA-Z/\\_\\-\\.]+'}
strain (columns)
name: Strain
description:
For species different from
homo sapiens
, string value indicating the strain of the species, for example:C57BL/6J
.
schema information:
{'display_name': 'Strain', 'type': 'string'}
strain_rrid (columns)
name: Strain RRID
description:
For species different from
homo sapiens
, research resource identifier (RRID) of the strain of the species, for example:RRID:IMSR_JAX:000664
.
schema information:
{'display_name': 'Strain RRID', 'type': 'string', 'format': 'rrid'}
string (formats)
name: String
description:
The basic string type (not a specific format). This should allow any free-form string.
schema information:
{'display_name': 'String', 'pattern': '.*'}
subject (entities)
name: Subject
description:
A person or animal participating in the study.
schema information:
{'display_name': 'Subject', 'type': 'string', 'format': 'label'}
task (entities)
name: Task
description:
Each task has a unique label that MUST only consist of letters and/or numbers (other characters, including spaces and underscores, are not allowed). Those labels MUST be consistent across subjects and sessions.
schema information:
{'display_name': 'Task', 'type': 'string', 'format': 'label'}
tif (extensions)
name: Tag Image File Format
description:
A Tag Image File Format file.
schema information:
{'value': '.tif', 'display_name': 'Tag Image File Format'}
time (columns)
name: Time
description:
Time, in seconds, relative to
TimeZero
defined by the*_pet.json
. For example, 5.
schema information:
{'display_name': 'Time', 'type': 'number', 'unit': 's'}
time (formats)
name: Time
description:
A time in the form
"hh:mm:ss"
.
schema information:
{'display_name': 'Time', 'pattern': '(?:2[0-3]|[01]?[0-9]):[0-5][0-9]:[0-5][0-9]'}
tracer (entities)
name: Tracer
description:
The
trc-<label>
entity can be used to distinguish sequences using different tracers. The key"TracerName"
MUST also be included in the associated JSON file, although the label may be different.
schema information:
{'display_name': 'Tracer', 'type': 'string', 'format': 'label'}
trg (extensions)
name: KRISS TRG
description:
A file generated by KRISS MEG systems containing the event markers.
Each experimental run on the KRISS system produces a file with extension.kdf
. Additional files that may be available in the same folder include the digitized positions of the head points (\_digitizer.txt
), the position of the center of the MEG coils (.chn
), and the event markers (.trg
).
schema information:
{'value': '.trg', 'display_name': 'KRISS TRG'}
trial_type (columns)
name: Trial type
description:
Primary categorisation of each trial to identify them as instances of the experimental conditions. For example: for a response inhibition task, it could take on values
go
andno-go
to refer to response initiation and response inhibition experimental conditions.
schema information:
{'display_name': 'Trial type', 'type': 'string'}
trigger (columns)
name: Trigger
description:
continuous measurement of the scanner trigger signal
schema information:
{'display_name': 'Trigger', 'type': 'number'}
tsv (extensions)
name: Tab-Delimited
description:
A tab-delimited file.
schema information:
{'value': '.tsv', 'display_name': 'Tab-Delimited'}
tsvgz (extensions)
name: Compressed Tab-Delimited
description:
A gzipped tab-delimited file. This file extension is only used for very large tabular data, such as physiological recordings. For smaller data, the unzipped
.tsv
extension is preferred.
schema information:
{'value': '.tsv.gz', 'display_name': 'Compressed Tab-Delimited'}
txt (extensions)
name: Text
description:
A free-form text file.
Tab-delimited files should have the.tsv
extension rather than a.txt
extension.
schema information:
{'value': '.txt', 'display_name': 'Text'}
type sense 1 (columns)
name: Channel type
description:
Type of channel; MUST use the channel types listed below. Note that the type MUST be in upper-case.
schema information:
{'display_name': 'Channel type', 'type': 'string', 'enum': ['AUDIO', 'EEG', 'EOG', 'ECG', 'EMG', 'EYEGAZE', 'GSR', 'HEOG', 'MISC', 'PPG', 'PUPIL', 'REF', 'RESP', 'SYSCLOCK', 'TEMP', 'TRIG', 'VEOG']}
type sense 2 (columns)
name: Channel type
description:
Type of channel; MUST use the channel types listed below. Note that the type MUST be in upper-case.
schema information:
{'display_name': 'Channel type', 'type': 'string', 'enum': ['MEGMAG', 'MEGGRADAXIAL', 'MEGGRADPLANAR', 'MEGREFMAG', 'MEGREFGRADAXIAL', 'MEGREFGRADPLANAR', 'MEGOTHER', 'EEG', 'ECOG', 'SEEG', 'DBS', 'VEOG', 'HEOG', 'EOG', 'ECG', 'EMG', 'TRIG', 'AUDIO', 'PD', 'EYEGAZE', 'PUPIL', 'MISC', 'SYSCLOCK', 'ADC', 'DAC', 'HLU', 'FITERR', 'OTHER']}
type sense 3 (columns)
name: Channel type
description:
Type of channel; MUST use the channel types listed below. Note that the type MUST be in upper-case.
schema information:
{'display_name': 'Channel type', 'type': 'string', 'enum': ['EEG', 'ECOG', 'SEEG', 'DBS', 'VEOG', 'HEOG', 'EOG', 'ECG', 'EMG', 'TRIG', 'AUDIO', 'PD', 'EYEGAZE', 'PUPIL', 'MISC', 'SYSCLOCK', 'ADC', 'DAC', 'REF', 'OTHER']}
type sense 4 (columns)
name: Electrode type
description:
Type of the electrode (for example, cup, ring, clip-on, wire, needle).
schema information:
{'display_name': 'Electrode type', 'type': 'string'}
uCT (suffixes)
name: Micro-CT
description:
Micro-CT imaging data
schema information:
{'value': 'uCT', 'display_name': 'Micro-CT'}
unit (formats)
name: A standardized unit
description:
A unit. SI units in CMIXF formatting are RECOMMENDED (see Units).
Currently this matches any string.
TODO: Somehow reference the actual unit options in the Units appendix.
schema information:
{'display_name': 'A standardized unit', 'pattern': '.*'}
units (columns)
name: Units
description:
Physical unit of the value represented in this channel, for example,
V
for Volt, orfT/cm
for femto Tesla per centimeter (see Units).
schema information:
{'display_name': 'Units', 'type': 'string', 'format': 'unit'}
uri (formats)
name: Uniform resource indicator
description:
A uniform resource indicator.
schema information:
{'display_name': 'Uniform resource indicator', 'pattern': '(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?'}
value (columns)
name: Marker value
description:
Marker value associated with the event (for example, the value of a TTL trigger that was recorded at the onset of the event).
schema information:
{'display_name': 'Marker value', 'anyOf': [{'type': 'number'}, {'type': 'string'}]}
vhdr (extensions)
name: BrainVision Text Header
description:
A text header file in the BrainVision Core Data Format. These files come in three-file sets, including a
.vhdr
, a.vmrk
, and a.eeg
file.
schema information:
{'value': '.vhdr', 'display_name': 'BrainVision Text Header'}
vmrk (extensions)
name: BrainVision Marker
description:
A text marker file in the BrainVision Core Data Format. These files come in three-file sets, including a
.vhdr
, a.vmrk
, and a.eeg
file.
schema information:
{'value': '.vmrk', 'display_name': 'BrainVision Marker'}
volume_type (columns)
name: ASL volume type
description:
The
*_aslcontext.tsv
table consists of a single column of labels identifying thevolume_type
of each volume in the corresponding*_asl.nii[.gz]
file.
schema information:
{'display_name': 'ASL volume type', 'type': 'string', 'enum': ['control', 'label', 'm0scan', 'deltam', 'cbf']}
whole_blood_radioactivity (columns)
name: Whole blood radioactivity
description:
Radioactivity in whole blood samples, in unit of radioactivity measurements in whole blood samples (for example,
kBq/mL
).
schema information:
{'display_name': 'Whole blood radioactivity', 'type': 'number'}
x (columns)
name: X position
description:
Recorded position along the x-axis.
schema information:
{'display_name': 'X position', 'type': 'number'}
y (columns)
name: Y position
description:
Recorded position along the y-axis.
schema information:
{'display_name': 'Y position', 'type': 'number'}
z (columns)
name: Z position
description:
Recorded position along the z-axis.
schema information:
{'display_name': 'Z position', 'anyOf': [{'type': 'number'}, {'type': 'string', 'enum': ['n/a']}]}