iishiishii / vscode-niivue

NiiVue README

NiiVue is a WebGL 2.0 medical image viewer. This extension uses NiiVue to display images selected in VSCode.

Features

• Open local files by selecting them in the VSCode explorer
• Open remote files with the command "NiiVue: Open Image" (Ctr+Shift+P)
• Open local or remote files when hovering over the link
• NiiVue hotkeys
• contrast adjustment by windowing with right mouse button
• Works in web-based VSCode

Supported Formats

NiiVue can open several formats popular with brain imaging:

• Voxel-based formats: NIfTI, NRRD, MRtrix MIF, AFNI HEAD/BRIK, MGH/MGZ, ITK MHD, ECAT7.
• Mesh-based formats: GIfTI, ASC, BYU/GEO/G, BrainSuite DFS, ICO/TRI, PLY, BrainNet NV, BrainVoyager SRF, FreeSurfer, MZ3, OFF, Wavefront OBJ, STL, Legacy VTK, X3D.
• Mesh overlay formats: GIfTI, CIfTI-2, MZ3, SMP, STC, FreeSurfer (CURV/ANNOT)
• Tractography formats: TCK, TRK, TRX, VTK, AFNI .niml.tract
• DICOM: DICOM and DICOM Manifests

Not all of the formats might be working in the VSCode extension yet.

Developing this extension in VSCode

• Clone this repository and open in VSCode
• Run inside the vscode-niivue folder

    npm install
    npm run watch

• Press F5 (a new VSCode window opens)
• Test the extension in the new window by opening an image file
• Press Ctrl+R for reload after a code change