Reference

Viewers

Which viewer opens each kind of file, what is in its toolbar, and every key and mouse gesture, written for your system.

Which file opens where

The Editor picks the viewer from the file's name and folder, without reading the file (DICOM is the one exception: its first bytes are read).

File Opens in
.nii, .nii.gz, .mgz, .mgh the image viewer: slices, 3-D, time course
.nii, .nii.gz in mrs/ with an MRS suffix (svs, mrsref, ...) the spectrum viewer
.fif, .edf, .bdf, .gdf, .set, .vhdr, .con, .sqd, .kdf, .mef, .nwb, and the folders .ds and .mff the signal viewer, after a header card with Load signal
.tsv, .tsv.gz whose sidecar gives a sampling frequency the table viewer, with Visualize to open it in the signal viewer
other .tsv, .tsv.gz the table viewer
.json the sidecar form (BIDS view) and Tree view
.bval, .bvec the gradient table
CITATION.cff a form of its fields
README, CHANGES, LICENSE, .txt, .md and other text the document viewer; Markdown is shown rendered
.png, .jpg, .svg and other pictures the picture viewer
a DICOM file, whatever its name the DICOM header viewer
anything else a description of the file, with Open with the system's app

A BrainVision recording opens from its .vhdr, not from its .eeg or .vmrk.

The image viewer

The toolbar, from left to right: the layout; Time course (for a 4-D image); Slice; Volume and Play for a 4-D image; QC (the quality check and the maps of a series); Tools (overlays, the header and sidecar, the next run, echo, session or subject, a fieldmap of this image drawn over it); Save (a screenshot, a mosaic figure, a preset, a scene, the command line); and at the right the keyboard icon, which lists the shortcuts. Advanced controls is the strip on the right edge of the images (⌘I on macOS, Ctrl+I on Windows and Linux). Comparing two images is in the Editor's Tools > Compare images....

Advanced controls opens a column with every control, in sections: the layers (each image and overlay, its colour map, window, gamma and opacity), the slice views, the layout, and for 3-D its look, the clip planes and the lighting.

The viewer remembers how you last looked at each kind of image: a BOLD run opens with its time course, a T1w with what you set for anatomical images. Restore every viewer default... puts back the defaults.

Keys

On a Mac, ⌘ is Command, ⌥ Option, ⌃ Control and ⇧ Shift. Keys are shown for the system this page was opened on; where it cannot tell, for both.

ActionKey
Views
Axial viewA
Sagittal viewS
Coronal viewC
Multi-planar view (three planes)M
3-D volume renderingD
Multi-planar view with 3-D renderingP
Time-course graphG
Maximise the time course⌘G on macOS, Ctrl+G on Windows and Linux
Time course in its own window⇧⌘G on macOS, Ctrl+Shift+G on Windows and Linux
Advanced controls⌘I on macOS, Ctrl+I on Windows and Linux
Display
Orientation labels and cubeO
Radiological conventionL
World spaceW
Colour barB
CrosshairX
Reset zoom and panR
Nearest-neighbour interpolationN
Navigate
Next slice↑ on macOS, Up on Windows and Linux
Previous slice↓ on macOS, Down on Windows and Linux
Ten slices forwardPage Up on macOS, PgUp on Windows and Linux
Ten slices backPage Down on macOS, PgDown on Windows and Linux
Next volume→ on macOS, Right on Windows and Linux
Previous volume← on macOS, Left on Windows and Linux
First volume⇧← on macOS, Shift+Left on Windows and Linux
Last volume⇧→ on macOS, Shift+Right on Windows and Linux
Play the seriesSpace
Centre the crosshairHome
Diffusion
Next volume of this shell]
Previous volume of this shell[
Dataset
Next run⌥→ on macOS, Alt+Right on Windows and Linux
Previous run⌥← on macOS, Alt+Left on Windows and Linux
Next session⌥ Page Down on macOS, Alt+PgDown on Windows and Linux
Previous session⌥ Page Up on macOS, Alt+PgUp on Windows and Linux
Next subject⌥↓ on macOS, Alt+Down on Windows and Linux
Previous subject⌥↑ on macOS, Alt+Up on Windows and Linux
Contrast
Window to the robust rangeF
Window for the whole series⇧F on macOS, Shift+F on Windows and Linux
Invert the colour mapI
3-D slicer
Clip plane on or off⇧Z on macOS, Shift+Z on Windows and Linux
Axial cut⇧A on macOS, Shift+A on Windows and Linux
Sagittal cut⇧S on macOS, Shift+S on Windows and Linux
Coronal cut⇧C on macOS, Shift+C on Windows and Linux
Cut from the other side⇧X on macOS, Shift+X on Windows and Linux
Cut through the crosshair⇧T on macOS, Shift+T on Windows and Linux
Corner cut at the crosshair⇧O on macOS, Shift+O on Windows and Linux
3-D
Reset the 3-D camera⇧R on macOS, Shift+R on Windows and Linux
Layers
Header and sidecar...H
General
Undo a display change⌘Z on macOS, Ctrl+Z on Windows and Linux
Redo a display change⇧⌘Z on macOS, Ctrl+Shift+Z on Windows and Linux
Save a screenshot...⇧⌘S on macOS, Ctrl+Shift+S on Windows and Linux
Keyboard and mouse shortcutsF1
Find an action⇧⌘P on macOS, Ctrl+Shift+P on Windows and Linux

Mouse, on a slice

MouseDoes
Click / dragMove the crosshair
Right-dragWindow level and width
Middle-dragPan (when zoomed)
⇧ + Click / drag on macOS, Shift + Click / drag on Windows and LinuxFit the window to a box
⌘ + Click / drag on macOS, Ctrl + Click / drag on Windows and LinuxPan (when zoomed)
ScrollStep through slices
⇧ + Scroll on macOS, Shift + Scroll on Windows and LinuxStep through volumes (4-D)
⌘ + Scroll on macOS, Ctrl + Scroll on Windows and LinuxZoom
Horizontal scrollStep through volumes (4-D)
Hold H + ScrollStep through volumes (4-D)

Mouse, in 3-D

MouseDoes
Click / dragRotate (a click without a drag moves the crosshair)
Right-dragPan
Middle-dragPan
⇧ + Click / drag on macOS, Shift + Click / drag on Windows and LinuxTilt the clip plane (when on)
ScrollZoom
⇧ + Scroll on macOS, Shift + Scroll on Windows and LinuxMove the clip plane (when on)
Horizontal scrollMove the clip plane (when on)

The signal viewer

For MEG, EEG and physiological recordings. The toolbar sets how many channels are shown, the scaling, the time span and the filter; Advanced controls chooses the channel type or single channels, and Events there (or E) draws the task's events over the traces; QC checks the recording channel by channel; Annotate marks bad channels and segments; PSD opens the power spectrum. The overview bar at the bottom shows the whole recording; drag in it to move.

Save to dataset writes the bad channels into the status column of the recording's channels.tsv, and the bad segments as BAD_ rows of its events.tsv (which MNE-BIDS reads back as annotations), as one operation recorded in the project. The task's own events are kept.

Keys

On a Mac, ⌘ is Command, ⌥ Option, ⌃ Control and ⇧ Shift. Keys are shown for the system this page was opened on; where it cannot tell, for both.

ActionKey
Views
Advanced controls⌘I on macOS, Ctrl+I on Windows and Linux
Signals
Next page of time→ on macOS, Right on Windows and Linux
Previous page of time← on macOS, Left on Windows and Linux
Start of the recording⇧← on macOS, Shift+Left on Windows and Linux
End of the recording⇧→ on macOS, Shift+Right on Windows and Linux
Shorter time window=
Longer time window-
Fit the whole recordingF
Next channel↓ on macOS, Down on Windows and Linux
Previous channel↑ on macOS, Up on Windows and Linux
Next page of channelsPage Down on macOS, PgDown on Windows and Linux
Previous page of channelsPage Up on macOS, PgUp on Windows and Linux
Larger amplitude]
Smaller amplitude[
Normalise each channelN
Butterfly: every channel of a type in one bandB
Remove each channel's meanD
Quality control (QC)Q
Reset the viewR
Remove the filters⇧R on macOS, Shift+R on Windows and Linux
Show eventsE
Power spectrumP
Zen mode: only the tracesZ
Annotation
Annotation modeA
Delete the selected bad segmentForward Delete on macOS, Delete on Windows and Linux or Delete on macOS, Backspace on Windows and Linux
General
Undo a display change⌘Z on macOS, Ctrl+Z on Windows and Linux
Redo a display change⇧⌘Z on macOS, Ctrl+Shift+Z on Windows and Linux
Save a screenshot...⇧⌘S on macOS, Ctrl+Shift+S on Windows and Linux
Keyboard and mouse shortcutsF1
Find an action⇧⌘P on macOS, Ctrl+Shift+P on Windows and Linux

Mouse

MouseDoes
Click / dragDrag the recording along
ScrollScroll through channels
⇧ + Scroll on macOS, Shift + Scroll on Windows and LinuxScroll through time
⌘ + Scroll on macOS, Ctrl + Scroll on Windows and LinuxZoom time
⌥ + Scroll on macOS, Alt + Scroll on Windows and LinuxChange the amplitude
Horizontal scrollScroll through time

The spectrum viewer

For MR spectroscopy. The spectrum is drawn against chemical shift in ppm, from right to left, with the main metabolites marked; FID shows the signal over time. Advanced controls sets the line broadening, the phase (or Auto phase), which repeat is shown, and the reference; On anatomy shows the voxel on the participant's anatomical image.

Keys

On a Mac, ⌘ is Command, ⌥ Option, ⌃ Control and ⇧ Shift. Keys are shown for the system this page was opened on; where it cannot tell, for both.

ActionKey
Views
Advanced controls⌘I on macOS, Ctrl+I on Windows and Linux
Spectrum
Show the FIDT
Metabolite positionsL
Standard window (0.2 to 4.2 ppm)W
Overlay the water referenceO
Fit the whole bandF
Reset the viewR
Reset the processing⇧R on macOS, Shift+R on Windows and Linux
Phase automaticallyP
Vertical zoom in (look under the peaks)]
Vertical zoom out[
General
Undo a display change⌘Z on macOS, Ctrl+Z on Windows and Linux
Redo a display change⇧⌘Z on macOS, Ctrl+Shift+Z on Windows and Linux
Save a screenshot...⇧⌘S on macOS, Ctrl+Shift+S on Windows and Linux
Keyboard and mouse shortcutsF1
Find an action⇧⌘P on macOS, Ctrl+Shift+P on Windows and Linux

Saving what you see

From Save Writes
Save a screenshot... a PNG of the viewer as it is
Save a mosaic figure... a grid of slices, at one to four times the screen's resolution
Save the look as a preset... the layout, display options, time course and 3-D look, to apply to another image (the colour map and window are kept by a scene, not a preset)
Save a scene in this dataset... what is shown and how, in the project's .bidsmgr/viz/scenes/, to open again later
Show the command line... the bidsmgr-view command that opens the same view, or renders it to a file

A preset or a scene applies only what an image has: a time-course setting is ignored on an anatomical image.

From the command line

bidsmgr-view opens an image, a scene or an overlay in the viewer without the rest of BIDS Manager. With --render it draws the view into a PNG with no window at all, which works on a server.

Terminal
bidsmgr-view sub-001/ses-01/anat/sub-001_ses-01_acq-tfl3p2_T1w.nii.gz
bidsmgr-view T1w.nii.gz --render t1.png --planes axial coronal --height 400

Every option is in Command line.