Reference

Settings

Every setting in the Settings dialog, page by page, with what it does and its default. Open Settings with the gear at the right of the header.

The pages are listed down the left of the dialog. A change applies when you click Save; Restore Defaults at the bottom puts back the defaults of every page, and Restore defaults inside a group puts back that group only; either is kept only if you then click Save. The settings are kept for your user account, not in a project (where).

The tables below are generated from BIDS Manager 1.5.0 itself: the labels, descriptions and defaults are the ones the dialog shows.

BIDS version

Settings, BIDS version page: the version of the standard datasets are written and validated against.Settings, BIDS version page: the version of the standard datasets are written and validated against.

Settings, BIDS version page.

SettingWhat it doesDefault
Work toThe version of BIDS this session works to. Several ship with BIDS Manager. Choose an older one to work to a dataset that was built against it, so the forms ask for that version's fields and validation judges it by that version's rules. Choices: Newest available (recommended), BIDS 1.10.0, BIDS 1.10.1, BIDS 1.11.0, BIDS 1.11.1, BIDS 1.8.0, BIDS 1.9.0.Newest available (recommended)

Display

Settings, Display page: the theme, its appearance (accent, tint, icons, file colours), the font scale, the Log, the header logo, hidden files in the Editor tree and saving sidecar edits as you go.Settings, Display page: the theme, its appearance (accent, tint, icons, file colours), the font scale, the Log, the header logo, hidden files in the Editor tree and saving sidecar edits as you go.

Settings, Display page.

Theme, text size and how the Editor shows the dataset.

SettingWhat it doesDefault
ThemeDark

Appearance

0 %

SettingWhat it doesDefault
IconsHow toolbar and action icons are coloured. Status icons (ok, warning, error) and the file trees' icons keep their own colours. Choices: Monochrome (the text colour), Accent, Colourful (by purpose).Monochrome (the text colour)
SettingWhat it doesDefault
Font scale Choices: Compact (0.85x), Normal (1.00x), Comfortable (1.15x), Large (1.30x), Extra large (1.50x).Normal (1.00x)
Log
Start each scan and conversion with an empty Log
The Converter's Log shows one run at a time. Every run is also kept as a file: the Log's history icon lists them.On
Header logo Choices: Default (monochrome mark), App icon (full color).Default (monochrome mark)
Editor tree
Show hidden files and folders
Dotfiles and dot-folders (.bidsignore, .bidsmgr, .git) are hidden by default. Shown, they are dimmed so they do not compete with the dataset. Needed to open .bidsignore.Off
Editor saving
Save sidecar edits as you go
Off by default: edits wait for the Save button, and the toolbar says there are unsaved changes from the first keystroke either way. On, a field commits when it loses focus or you press Enter and is written after a short pause, so a burst of typing is one write. Every write is reversible, so this cannot lose what was there before.Off

System

Settings, System page: the processor threads and memory BIDS Manager detected on this computer.Settings, System page: the processor threads and memory BIDS Manager detected on this computer.

Settings, System page.

System info (detected)

Scan

Settings, Scan page: parallel workers, probe conversion, converter fields, the classifier switch and the index widths.Settings, Scan page: parallel workers, probe conversion, converter fields, the classifier switch and the index widths.

Settings, Scan page.

Scan defaults

SettingWhat it doesDefault
Parallel workers (-j)Capped at the detected thread count (10).1
Probe
Probe each series with dcm2niix
Runs dcm2niix on each series during the scan (--probe-convert), so the proposed names know the real number of files and their extensions.On
Converter fields
Record what the conversion fills in by itself
Note, per kind of file, the values dcm2niix and mne-bids produce, so the metadata form can show them instead of asking for a field nobody has to answer. Costs nothing extra: it reads what the scan, and any probe conversion, already produced. With Probe on it covers MRI and PET as well as EEG and MEG.On
Classifier
Skip dcm2niix's BidsGuess classifier
Propose datatypes and suffixes from the series names alone (the older pattern-matching layer), without dcm2niix's BidsGuess.Off

Index width in proposed names

An index entity is one whose value is a number: run, echo, and the others below. BIDS accepts run-1 and run-01 equally, so this is a house style rather than a correction. Setting a width here makes the inspection table propose that width from the moment a scan finishes, so you never have to go and repad the dataset afterwards. As found keeps whatever the source gives, which is what every earlier version did and what stays out of your way. run-7 stays run-7 echo-7 stays echo-7 flip-7 stays flip-7 inv-7 stays inv-7 split-7 stays split-7 chunk-7 stays chunk-7

Scan rules

Scan rules are kept with your other settings. bidsmgr-scan --rules-file reads rules of the same form from a JSON file you write, with a user_hints list and a scan_exclusions list (The command line).

Settings, Scan rules page: series to leave out, your own naming hints, and the built-in criteria.Settings, Scan rules page: series to leave out, your own naming hints, and the built-in criteria.

Settings, Scan rules page.

Scan exclusions (skip matching series)

A table with the columns Pattern, Match against and Mode.

Custom sequence hints (MRI / DICOM only)

A table with the columns Patterns (comma-separated), Datatype, Suffix, Task, Mode and Force.

Built-in MRI classifier criteria (read-only)

What the MRI classifier already matches. EEG / MEG do not use this table - their datatype comes from mne channel types.

A table with the columns Label / group, Datatype, Suffix and Match patterns.

Classification

The settings of the parameter classifier: what it does with what it finds, and every number it tests. The classifier explains how they are used.

Settings, Classification page: how the parameter classifier names MRI series, the weight of each kind of evidence, and the first of its thresholds.Settings, Classification page: how the parameter classifier names MRI series, the weight of each kind of evidence, and the first of its thresholds.

Settings, Classification page.

Classification

What the classifier does with what it finds.

SettingWhat it doesDefault
Use the acquisition parametersApplied: the parameters name the series, with dcm2niix's guess and the series name as second opinions. Shadow: the names stay as before and the classifier only reports what it would do. Off: not run. Choices: To name the series, Only to report, Not at all.To name the series
Name without asking aboveA name this sure (0 to 1) is used as it is. Below it, the row is named but marked to check. Range 0.5 to 0.99.0.8
Leave to the other opinions belowBelow this, the classifier does not decide: dcm2niix's guess or the series name does, and the row is marked to check. Range 0.1 to 0.9.0.4

Weight of the evidence

How much each kind of evidence counts (1 is as built).

SettingWhat it doesDefault
Acquisition parametersEcho, repetition and inversion times, flip angle, readout, volumes, diffusion weighting: what the scanner did. Range 0 to 3.1
Series nameWords in the series description and protocol name (T1, FLAIR, bold, SBRef, a ReproIn name): what the operator called it. Range 0 to 3.1
Neighbouring seriesWhat the series next to it are: an SBRef before its run, a reversed-phase reference beside a run, the two inversions of an MP2RAGE. Range 0 to 3.1

Anatomical contrasts

The ranges that tell anatomical contrasts apart.

SettingWhat it doesDefault
T1-weighted inversion fromAn inversion-recovery gradient echo (MPRAGE) inverts this long or longer before it reads. Range 0.05 to 2 s.0.3 s
T1-weighted inversion up to... and no longer than this. Range 0.5 to 3 s.1.5 s
FLAIR inversion fromA spin echo inverting at least this long before it reads nulls the fluid: FLAIR. Range 1 to 4 s.1.6 s
T2-weighted echo fromA spin echo with an echo time this long or longer is T2-weighted. Range 30 to 200 ms.60 ms
Proton density echo up toA spin echo with a short echo time and a long repetition time is proton density weighted. Range 5 to 60 ms.30 ms
Long repetition time fromRepetition times this long or longer let the tissue recover (T2 and proton density weighting). Range 1 to 6 s.2 s
T2*-weighted echo fromA gradient echo this long or longer (and not an EPI) is T2*-weighted. Range 5 to 60 ms.15 ms
MP2RAGE repetition fromAn inversion-recovery 3-D gradient echo repeating this slowly or slower reads two inversions per repetition: an MP2RAGE. Faster, it is an MPRAGE (T1-weighted). Range 2 to 10 s.3.5 s
Turbo spin echo fromA spin echo reading this many echoes per excitation or more (its echo train) is a turbo or fast spin echo, how T2-weighted, PD-weighted and FLAIR images are made. Range 2 to 64 echoes.2 echoes
High-resolution 3-D up toA 3-D series with voxels this small or smaller in every direction is a structural image (and no localizer). Range 0.3 to 3 mm.1.3 mm

Gradient-echo contrasts

The ranges that make a gradient echo T1-weighted, or an angiogram.

SettingWhat it doesDefault
3-D spoiled gradient echo, repetition up toA 3-D gradient echo repeating this fast or faster, with a small flip angle, is T1-weighted (FLASH, SPGR, a T1 VIBE). Range 5 to 200 ms.50 ms
3-D spoiled gradient echo, flip angle up to... and a flip angle this small or smaller. Range 2 to 90 °.30 °
2-D spoiled gradient echo, echo up toA 2-D gradient echo with an echo this short or shorter, a short repetition and a large flip angle is T1-weighted. Range 1 to 30 ms.10 ms
2-D spoiled gradient echo, repetition up to... repeating this fast or faster ... Range 0.05 to 3 s.1 s
2-D spoiled gradient echo, flip angle from... with a flip angle this large or larger. Range 5 to 90 °.20 °
Magnetization transfer echo up toA gradient echo with magnetization transfer and an echo this short or shorter is a T1-weighted MT image, not a T2*-weighted one. Range 2 to 30 ms.10 ms
Time-of-flight angiography, repetition up toA flow-compensated 3-D gradient echo repeating this fast or faster, with a moderate flip angle, is a time-of-flight angiogram: inflowing blood is bright. Range 5 to 150 ms.50 ms
Time-of-flight angiography, echo up to... with an echo this short ... Range 1 to 20 ms.10 ms
Time-of-flight angiography, flip angle from... a flip angle from ... Range 1 to 60 °.10 °
Time-of-flight angiography, flip angle up to... up to this. Range 5 to 90 °.40 °

Echoes and fieldmaps

Echo counts and fieldmaps.

SettingWhat it doesDefault
Multi-echo fromA series read at this many echo times or more is multi-echo (MEGRE, MESE), not one contrast. Two echoes are a fieldmap's or a proton density and T2 pair. Range 2 to 12 echoes.3 echoes
Fieldmap first echo up toA two-echo gradient echo whose first echo is this short or shorter is a fieldmap's magnitude. Range 2 to 40 ms.15 ms

Time series and diffusion

The counts that tell time series from references and diffusion.

SettingWhat it doesDefault
A run has at leastAn EPI series with this many volumes or more is a run (BOLD); fewer is a reference or a test. Range 3 to 100 volumes.10 volumes
A reference has at mostAn EPI series with this many volumes or fewer, phase-encoded opposite to a run, is that run's fieldmap. Range 1 to 30 volumes.9 volumes
Diffusion weighting fromA b-value above this is diffusion weighting. Range 0 to 500 s/mm².50 s/mm²
A diffusion series has at leastDistinct gradient directions in a diffusion series. Range 1 to 30 directions.3 directions
A localizer has at mostA non-EPI series with this many slices or fewer (in several orientations) is a localizer, left out. Range 1 to 20 slices.5 slices
BOLD echo fromA gradient-echo EPI time series with an echo this long or longer (and no longer than the next setting) has the T2* weighting of BOLD. Range 5 to 60 ms.15 ms
BOLD echo up to... and no longer than this. Range 20 to 120 ms.60 ms
A BOLD run repeats at most everyA time series repeating more slowly than this is unlikely to be BOLD. Range 1 to 20 s.4 s
An SBRef precedes its run by at mostA one-volume EPI is the SBRef of a run with its geometry among the next this many series. Range 1 to 10 series.3 series

Contrast agent and perfusion

A contrast agent, and the series made with one or with labelled blood.

SettingWhat it doesDefault
Name the contrast agent (ce-)A series acquired after a contrast agent was injected carries BIDS's ce- entity: named after the agent in its header (ce-multihance), a fixed label, or not at all. Choices: After the agent in the header, With a fixed label, Not at all.After the agent in the header
Fixed labelThe ce- label when the agent is not named, or always when 'With a fixed label' is chosen. Letters and digits only.gadolinium
Also when only the series name says soA series named post-contrast (post, +C, Gd, KM, contrast) whose header names no agent gets the ce- entity too, marked to check.On
A contrast bolus series (DSC perfusion)An EPI time series acquired during a contrast bolus measures perfusion (dynamic susceptibility contrast). BIDS 1.11 has no raw suffix for it: leave it out (keep it in sourcedata/), or name it func/cbv, BIDS's contrast-agent blood-volume series. Choices: Leave it out, Name it func/cbv.Leave it out
A bolus series has at leastAn EPI series with a contrast agent and this many volumes or more follows a bolus. Range 3 to 300 volumes.20 volumes
An ASL M0 reference has at mostAn unlabelled ASL readout with this many volumes or fewer is the M0 reference. Range 1 to 10 volumes.2 volumes

Convert

Settings, Convert page: existing subjects, curated metadata, residuals, fieldmap links, EEG to EDF and defacing.Settings, Convert page: existing subjects, curated metadata, residuals, fieldmap links, EEG to EDF and defacing.

Settings, Convert page.

Convert defaults

SettingWhat it doesDefault
Parallel workers (-j)Capped at the detected thread count (10).1
Existing subjectsWhat to do when a subject already exists in the dataset. Adding a new session or datatype always merges in; this only governs files that collide with existing ones. Existing data is never lost on the default (Skip). Choices: Skip: keep existing files, add only new (safe default), Update: replace only files whose content changed, Replace: back up and replace colliding files, Error: abort a subject if any file would be overwritten.Skip: keep existing files, add only new (safe default)
Curated metadata
Keep curated metadata
Merge sidecars field by field instead of overwriting them. When a subject you already curated in the Editor is converted again, merge its JSON sidecars and _scans.tsv field by field: a value you stated is kept, a TODO placeholder is replaced, and anything the fresh conversion newly knows is added. Turn it off to let the fresh conversion win outright. Only has an effect with Update or Replace above. Recommended: on.On
Residuals
Skip residual volumes
Drop the secondary duplicates dcm2niix writes (..._bolda, _Eq_, _ROI), which are not real images. dcm2niix splits a single input series into the real image plus derived single-volume duplicates it names ..._bolda, ..._Eq_1, etc. These have no valid BIDS suffix. Recommended: on.On
Fieldmap linksHow a fieldmap's IntendedFor names the runs it corrects. BIDS URIs are the current form; fMRIPrep 24.1 and earlier ignore them silently. Paths from the subject are the older form every version reads. Choices: BIDS URIs (bids::sub-01/...), the current form, Paths from the subject (ses-1/func/...).BIDS URIs (bids::sub-01/...), the current form
Also write B0FieldIdentifier and B0FieldSourceThe newer pairing of a fieldmap and its runs, read by every fMRIPrep version and preferred to IntendedFor. Recommended: on.On
Force EDF
Re-encode EEG to EDF
Re-encode EEG recordings to EDF instead of keeping the source format. Harmonises a study to one BIDS-native format, and makes a non-BIDS-native but mne-readable source (GDF, EGI, ...) convertible. MEG / NIRS are unaffected.Off
Deface
Remove faces from anatomical and PET images
Blank the face before the subject is committed, so the identifiable image never enters the dataset at all. Off by default because it cannot be undone from the conversion: the original stays in your raw data, not in the BIDS tree. Needs niimath, which ships with BIDS Manager.Off
Deface engineallineate: Affine registration of a face mask, then blank the face. The fast default; right for most images. allineate, neck cropped: The same, after cropping the neck and lower head. Steadier when the scan reaches well below the chin. Note that this one CHANGES THE IMAGE DIMENSIONS: the cropped slices are gone, so the result no longer lines up voxel-for-voxel with anything derived from the original. allineate, Hellinger cost: The same, matched with the AFNI-style Hellinger cost instead of the fast one. Slower; worth trying when the default fits badly. mindgrab: A small neural network that finds the brain directly in the image. Much better than fitting an atlas to it. About ten seconds an image on a laptop CPU, plus a one-off download of the model the first time it runs. atlas brain mask: Affine registration of a brain mask from the same atlas the defacer uses, keeping what the mask covers. No extra to install and it works offline, but it is an affine fit of an average brain: expect it to clip cortex in places and leave dura in others. Use mindgrab when the result has to be analysed. Choices: allineate, allineate, neck cropped, allineate, Hellinger cost, mindgrab, atlas brain mask.allineate

Source data

SettingWhat it doesDefault
Keep in sourcedata/Keep each subject's source data in the dataset's sourcedata/ folder, the place BIDS reserves for data before conversion: sourcedata/sub-/[ses-/]//. A manifest.tsv per subject lists every file with its checksum. Archives are fewer files, compress DICOM well and keep paths short on Windows. The conversion is refused before it starts when the disk cannot hold them. Choices: No (default), Copy the files as they are, One archive per series (.tar.gz).No (default)
MRI (DICOM)Keep the MRI (DICOM) source dataOn
PET (DICOM, ECAT, blood)Keep the PET (DICOM, ECAT, blood) source dataOn
EEGKeep the EEG source dataOn
MEGKeep the MEG source dataOn
NIRSKeep the NIRS source dataOn
PhysiologyKeep the Physiology source dataOn
Eye trackingKeep the Eye tracking source dataOn

Post-convert chain (run after every conversion)

SettingWhat it doesDefault
Generate metadatadataset_description.json, participants.tsv, the *_scans.tsv tables, what your metadata templates and per-file answers state, and an audit of every sidecar.On
Write TODO into missing fieldsOnly placeholders, nothing else. Every field the standard declares for a file that nothing filled (not the converter, not the scanner header, not your templates) gets the literal TODO, or n/a where the field accepts it, so the gap is visible in the file and reported by validation instead of being an absence nobody notices. No value is invented and an existing value is never overwritten. The TODOs follow this setting on every run: a narrower choice below takes back the ones a wider one wrote, and turning this off takes them all back.On
Generate missing companion filesevents.tsv, channels.tsv and JSON sidecars a recording should have. What can be read from a recording is read from it, so a channels table is real content. The rest is a stub carrying TODO rows. A generated events table is deliberately INVALID until you fill it in: TODO is not a valid onset, so validation reports an error for each one. That is the point. An empty but valid events table would be indistinguishable from a recording that genuinely had no events, and would pass quietly forever.Off
Write CITATION.cff from the dataset descriptionWrites CITATION.cff from what dataset_description.json already says. This runs without asking, so here is exactly what it changes. MOVED: Authors. It is taken OUT of dataset_description.json, because stating authorship in both files is an error (AUTHORS_AND_CITATION_FILE_MUTUALLY_EXCLUSIVE). COPIED and KEPT: License, HowToAcknowledge and ReferencesAndLinks. They are written into the citation file and left where they are, so a value you typed does not disappear from the file you typed it into. The validator would rather each lived in one place only and says so as a warning (SINGLE_SOURCE_CITATION_FIELDS). That warning is the cost of not deleting your answer. An existing CITATION.cff is never overwritten.Off
Validate the datasetSchema-driven validation (bidsval), the same as the Editor's Validate dataset.On
Deep checks (slower)When on, validation reads NIfTI headers and file contents in addition to the structural checks. More thorough, slower on large trees. Maps to the validator's read-headers mode.On
Write an HTML validation reportA self-contained validation_report.html beside the dataset (--html).On
Check image qualityAnatomical and diffusion images, a few seconds each, with the methods and thresholds of the Quality control page. Last: the fast quality check of every anatomical and diffusion image not checked yet, into derivatives/bidsmgr-qc/ (read it in the Editor, Tools, Quality check). The air is measured only in images that are not defaced.Off

Validation

Settings, Validation page: the rows read per table, which findings the Editor shows, and TODO placeholders.Settings, Validation page: the rows read per table, which findings the Editor shows, and TODO placeholders.

Settings, Validation page.

Validation engine (bidsval)

SettingWhat it doesDefault
Max TSV rows scannedMaximum number of rows scanned per TSV during column / value validation. Large tables are bounded to keep validation fast; raise this to scan more of very long tables.1000
Show findingsFilter which findings the Editor's Validation pane lists. The tree badges and the error / warning counters always show the full picture; this only narrows the list so you can focus. Choices: Errors and warnings, Errors only, Warnings only.Errors and warnings
TODO placeholders
Flag 'TODO' placeholder values as warnings
A BIDS Manager convention: the metadata engine writes the literal string 'TODO' into missing recommended fields so you can find and fill them. On by default. Turn it off for exact parity with the standalone bidsval engine (which does not know this convention).On

Quality control

The methods and thresholds of the quality check. What each measure means is in Quality measures.

Settings, Quality control page: when QC runs, the methods, and the thresholds of every check.Settings, Quality control page: when QC runs, the methods, and the thresholds of every check.

Settings, Quality control page.

When QC runs

Quality control in every viewer.

SettingWhat it doesDefault
Run QC when a file opensOn: QC that was on stays on for the next file and is computed as soon as it opens (the QC plots under a BOLD's time course, the MEG and EEG check). Off: every file opens with QC off, and QC is computed when you switch it on.Off

Methods

Which method makes the masks, the tissue classes and the registration.

SettingWhat it doesDefault
Brain mask (anatomical)mindgrab: brainchop's network, any contrast, about 12 s. Template: the template's brain registered to the image, seconds faster and approximate (it follows the registration, not the image). Choices: mindgrab network (brainchop), Registered template (fast, approximate).mindgrab network (brainchop)
Tissue classesrobust_tissue: brainchop's grey and white matter network (T1w, T2w, FLAIR). EM: three Gaussian classes with the template's tissue maps as priors and a bias field (T1w and T2w only). Choices: robust_tissue network (brainchop), EM with template priors (fast).robust_tissue network (brainchop)
Registration to the templateniimath: AFNI's 3dAllineate (affine), the brain against the template's brain when the brain mask is mindgrab's. Outline and intensity: BIDS Manager's own affine fit, no external tool. Choices: niimath -allineate (affine), Outline and intensity (no external tool).niimath -allineate (affine)
Brain mask (diffusion)mindgrab on the mean b=0, or a median filter and Otsu's threshold (as dipy's median_otsu): faster, and looser at the skull base. Choices: mindgrab network (brainchop), Median filter and Otsu (fast).mindgrab network (brainchop)
Head motion of a BOLD runRead it from fMRIPrep's confounds table when the run has one (the same numbers the analysis will use), else estimate it here. Or always estimate it here. Choices: fMRIPrep's confounds when there, else estimated, Always estimated here.fMRIPrep's confounds when there, else estimated
Time limit for a network or niimathA network that runs longer is stopped and the check falls back to the fast methods. The first run of a network downloads it. Range 60 to 3600 s.600 s

Functional time series (BOLD)

The QC plots under a BOLD run's time course and its quality maps.

SettingWhat it doesDefault
Leave out non-steady-state volumesVolumes at the start that are far brighter than the rest (dummy scans the scanner kept) are left out of every measure; left in, they dominate the statistics.On
Non-steady-state aboveA starting volume is non-steady-state when its mean is this many robust standard deviations above the run's median. Range 2 to 20 robust SD.5 robust SD
Head radius for FDRotations are turned into millimetres as arcs on a sphere of this radius (Power 2012: 50 mm, about the distance from the centre of the head to the cortex). Range 30 to 100 mm.50 mm
FD worth a look aboveVolumes whose framewise displacement is above this are marked (fMRIPrep's and Power 2012's default; stricter studies use 0.2 to 0.3 mm). Range 0.05 to 5 mm.0.5 mm
Motion estimated on a grid ofFiner images are averaged down to about this voxel size before the head's motion is estimated: faster, and as accurate for whole-head motion. Range 2 to 8 mm.3.5 mm
DVARS fenceVolumes whose DVARS is above the 75th percentile plus this many interquartile ranges are marked (1.5 is the box plot's fence, FSL's default). Range 0.5 to 5 IQR.1.5 IQR
Outlier voxels worth a look aboveVolumes with more than this share of outlier voxels are marked (afni_proc.py's censoring default). Range 0.5 to 50 %.5 %
Slice spike aboveA slice is a spike when its mean is this many robust standard deviations from its own course. Range 2 to 20 robust SD.6 robust SD
Voxels sampledThe outlier, spike and carpet plots read this many voxels of the head: more is smoother and slower. Range 1000 to 100000.8000
Trend removed from the mapsThe standard deviation and temporal SNR maps are taken around a polynomial trend of this order: slow scanner drift is not instability (AFNI and MRIQC detrend too). Choices: None, Linear, Quadratic.Quadratic
Low temporal SNR belowThe temporal SNR map's summary reports the share of the head below this. Range 1 to 200.20

Anatomical images

The quality check of an anatomical image (T1w, T2w, FLAIR, PDw, T2starw).

SettingWhat it doesDefault
Working gridMasks, registration and tissue classes are made on a grid of about this voxel size; the measures that depend on noise go back to the image's own voxels. Range 1 to 4 mm.2 mm
Defaced when the face is blank overWith no defacing in the sidecar, the image is taken as defaced when more than this share of the face region is exactly zero. A defaced image's air is not measured. Range 5 to 95 %.40 %
Skull stripped when the shell holds underThe image holds the brain only when less than this share of the shell 2 to 8 mm outside the brain holds signal (measured: 1 % stripped, 73 to 89 % intact). Range 1 to 80 %.20 %
Air set to zero aboveWhen more than this share of the air is exactly zero, the scanner or a tool blanked the background and no noise is left to measure. Range 5 to 95 %.50 %
A slab belowA field of view thinner than this covers part of the brain on purpose: the part outside is reported as coverage, not as a cut. Range 40 to 250 mm.120 mm
Not registered belowThinner than this, the template is not registered at all: a whole head cannot be placed in a few centimetres of it. Range 20 to 150 mm.70 mm
Registration trusted aboveThe registered template's brain must overlap the brain found (Dice) at least this much, or the registration is reported as uncertain. Range 0.5 to 0.99 Dice.0.8 Dice
Field of view cuts the brain aboveA warning when more than this share of the template's brain falls outside the image. Range 0 to 10 %.0.5 %
Field of view: error aboveAn error when more than this share of the brain falls outside the image. Range 0 to 30 %.3 %
Partial volume belowA brain voxel counts as partial volume when no tissue class holds it with at least this probability. Range 0.5 to 0.99.0.9
Structured air worth a look aboveA warning when more than this share of the air above the face holds signal far above its noise (QI1). Range 0.01 to 10 %.0.5 %
Saturation worth a look aboveA warning when more than this share of the head sits at the image's maximum. Range 0.01 to 10 %.0.5 %

Diffusion

The quality check of a diffusion series.

SettingWhat it doesDefault
b=0 up toVolumes with a b-value at or below this are b=0 volumes (scanners write small values such as 5 for them). Range 0 to 200 s/mm².50 s/mm²
Tensor fitted up toThe diffusion tensor is fitted on b-values up to this: above it the signal is no longer Gaussian enough for a tensor. Range 500 to 5000 s/mm².1500 s/mm²
Look for flipped or swapped b-vectorsFits the tensor with the stored table and with every flip and swap of its axes, and reports a table whose principal directions are clearly more continuous from voxel to voxel than the stored one's. Experimental; adds a few seconds.On
Another table must be more coherent byHow much more coherent a flipped or swapped table must be before it is reported. Range 0.5 to 20 %.2 %
Repeated directions withinTwo directions closer than this (either sign) are reported as repeats. Range 0.5 to 10 degrees.2 degrees
Head radius for displacementRotations are turned into millimetres as arcs on a sphere of this radius, as for framewise displacement. Range 30 to 100 mm.50 mm
Head motion worth a look aboveA finding when the head moved more than this across the b=0 volumes. Range 0.1 to 10 mm.1 mm
A volume far out of place beyondA volume this far from the first b=0, and an outlier of its shell (robust z above 5), moved during its acquisition. Range 0.5 to 10 mm.2 mm
Registration lost beyondA volume registered further than this from the first b=0 is reported as not placed, not as moved: a head does not move that far between two volumes. Range 5 to 100 mm.30 mm
Registration lost beyond a turn ofAs above, for rotation. Range 2 to 45 degrees.15 degrees
Eddy currents when the gradient explainsShifts are taken as eddy currents (and out of the motion) only when the gradient direction explains at least this share of them. Range 5 to 90 %.30 %
Dropout belowA slice is a dropout when its signal is this many robust spreads below what the tensor predicts, against the same slice in the shell's other volumes, and lost at least the share below. Range 2 to 20 robust SD.5 robust SD
Dropout loses at leastA dropout slice is also at least this much below its prediction. Range 1 to 80 %.10 %
Slices judged fromA slice is judged only when it holds at least this share of a typical slice's brain: the top slices' slivers read as dropouts otherwise. Range 5 to 80 %.25 %
Interleave artefact aboveA volume whose odd and even slices disagree this many robust spreads beyond the rest of its shell. Range 2 to 20 robust SD.5 robust SD
Spiking voxel aboveA voxel this many robust spreads above the tensor's prediction, against the same voxel in the shell's other volumes. Range 3 to 30 robust SD.8 robust SD
Signal drift worth a look aboveA warning when the b=0 signal changes by more than this over the scan. Range 0.5 to 50 %.5 %

MEG and EEG QC

The quick MEG and EEG quality check (``compute.meeg_qc``). Every measure is taken within ONE channel type (magnetometers, gradiometers, EEG): types measure different things in different units, so a channel is only ever compared with channels of its own type.

SettingWhat it doesDefault
Channel types checkedThe channel types QC runs on (mag, grad, eeg, ...); empty: all of them. Chosen per recording in the QC section.
Segment lengthThe recording is checked in segments (epochs) of this length. Range 0.5 to 30 s.2 s
Ignore drifts belowA zero-phase high-pass filter applied before measuring: slow drifts (the environment, sweat, electrode settling) differ from sensor to sensor and would otherwise decide which channel looks noisy. 0 measures the raw signal. Range 0 to 20 Hz.1 Hz
Apply the recording's SSP projectorsMEG recordings usually carry projectors that remove the room's magnetic field; applied, a sensor is judged by what is left.On
Use the standard deviation (STD)Judge channels and segments by their standard deviation.On
Use the peak-to-peak amplitude (PtP)Judge channels and segments by their peak-to-peak range: catches jumps and pops that barely move the standard deviation.On
Noisy channel aboveA channel is NOISY when its level (log STD or log PtP) is more than this many robust standard deviations above the other channels of its type. Range 1 to 10 robust SD.3 robust SD
Flat channel belowA channel is FLAT when its level is below this fraction of its type's median (0.01: a hundred times quieter than the rest). Range 0.001 to 0.5 of its type.0.01 of its type
Channels follow their type aboveHow well a channel correlates with the other channels of its type (98th percentile, the PREP pipeline's measure). A loud channel that follows them is picking up real fields and is not called noisy; one below this, at a normal level, is called uncorrelated. 0 judges by level alone. Range 0 to 0.99 correlation.0.6 correlation
Line noise aboveA channel has LINE NOISE when its power at the line frequency is this much above its type's typical. Needs the recording's PowerLineFrequency. Range 1 to 40 dB.10 dB
Channel off in a segment beyondIn a segment, a channel is OFF when its STD or PtP there is more than this many times its own usual level, or less than its inverse. Range 1.5 to 20 x its level.4 x its level
Segment flagged when off onA segment is flagged when at least this share of the channels of ONE type are off in it. Range 0.01 to 1 of a type.0.2 of a type
Look for muscleThe muscle band's share of the power, z-scored over time per channel and averaged per type (after MNE's annotate_muscle_zscore). Needs a sampling rate above twice the band's top.On
Muscle band fromRange 20 to 500 Hz.110 Hz
Muscle band toRange 30 to 1000 Hz.140 Hz
Muscle aboveA segment is flagged for muscle when its type's mean z is above this. Range 1 to 20 z.4 z

Viewer

Settings, Viewer page: the crosshair, how images and signals open, and the 3-D view.Settings, Viewer page: the crosshair, how images and signals open, and the 3-D view.

Settings, Viewer page.

Crosshair

SettingWhat it doesDefault
ColourThe crosshair on every slice and in the graph.#4FC3F7
ThicknessLine width of the crosshair. Range 1 to 5 px.1 px
GapPixels left empty around the centre, so the voxel under the crosshair stays visible. Range 0 to 40 px.0 px

Images

SettingWhat it doesDefault
Opens inThe layout a volume opens in. Automatic: the three planes, with the 3-D view where there is a GPU. Switching layout in the viewer changes this. Choices: Automatic, One plane, Multi-planar, 3-D, Planes + 3-D, Large view, Mosaic.Automatic
PlaneThe plane of the one-plane layout, and the large view's. Choices: sagittal, coronal, axial.axial
GammaDisplay gamma of a newly opened image: above 1 lifts the mid-tones. Range 0.1 to 10.1.25
InterpolationLinear blends neighbouring voxels; nearest neighbour shows each voxel as a square, as the data is. Choices: Linear (smooth), Nearest neighbour (voxels).Linear (smooth)
Colour mapThe colour map a newly opened image gets.gray
Orientation letters and cubeOn
Colour barOff
RAS orientationOff: each axis in the file's own storage order.On
Radiological conventionMirror left and right: the patient's left on the image's right.Off
SlicesVoxel: the file's own grid (exact, fast). World: the scanner's axes, resampled, so an oblique scan is upright. Choices: Voxel grid, World space.Voxel grid
Memory for 4-D seriesThe most a 4-D series may hold in memory. Automatic is half of the free memory. Range 0 to 262144 MB.Automatic
Playback speedRange 0.5 to 60 volumes/s.8 volumes/s
Advanced controls openThe column beside the images with the layers, their look, the view, the layout and the 3-D controls.On

3-D

SettingWhat it doesDefault
Ray samplesSamples along each ray of a newly opened rendering. More shows finer detail and renders slower. Range 64 to 1024 samples.512 samples

Signals

SettingWhat it doesDefault
Line widthAutomatic: thin for many traces, 2 px for one or two. Range 0 to 8 px.Automatic
Line colourOne colour for every trace; empty colours each by its channel type.
Channel type colours
Dark plot in the light themeDraw signals on a dark canvas even when the app is light. In the dark theme the canvas is dark already.Off
Event line widthRange 1 to 10 px.2 px
Advanced controls openThe column beside the traces with the channel, time, filter, event, QC and display controls.Off
Event colourOne colour for every event; empty colours each label differently.

Viewer shortcuts

Every key and mouse gesture of the viewers. Select an action, press the key in the box, then click Set (replace) or Add (a second key); Unbind removes it and Default restores it. A key used twice in the same viewer is reported under the table. Export... and Import... move a set of keys between computers. The keys as they are by default, for your system, are in Viewers.

Settings, Viewer shortcuts page: every key and mouse gesture of the viewers, each of which can be changed.Settings, Viewer shortcuts page: every key and mouse gesture of the viewers, each of which can be changed.

Settings, Viewer shortcuts page.