rordenlab/MRIcroGL

About

MRIcroGL is a cross-platform tool for viewing DICOM and NIfTI format images. It provides a drag-and-drop user interface as well as a scripting language. Please see the wiki page from more details. Note that the wiki page describes version 1.0 of the software, while this Github page is for the upcoming version 1.2. The changes are in general subtle, but the scripting has changed quite a bit.

Requirements

By default, MRIcroGL 1.2 is compiled to require OpenGL 2.1 (from 2006). It can also be compiled to require OpenGL 3.3 Core (released in 2009). Alternatively, macOS users can also compile the tool for the Metal. From the user perspective, there should be no difference between these choices. If your computer does not support OpenGL 2.1, you can try MRIcron. The code can be compiled for the macOS, Linux or Windows operating system. For macOS, both ARM-based Apple Silicon and Intel-based computers are natively supported.

Installation

You can get MRIcroGL using three methods:

• Download from NITRC.
• Download from Github.
• Run the following command to get the latest version for Linux, Macintosh or Windows:
  • curl -fLO https://github.com/rordenlab/MRIcroGL/releases/latest/download/MRIcroGL_linux.zip
  • curl -fLO https://github.com/rordenlab/MRIcroGL/releases/latest/download/MRIcroGL_macOS.dmg
  • curl -fLO https://github.com/rordenlab/MRIcroGL/releases/latest/download/MRIcroGL_windows.zip

Once you have downloaded the software, extract the archive and run the executable. Visit the wiki for a full manual that includes troubleshooting.

Compiling with the Graphical Interface

It is generally recommended that download a pre-compiled executable (see previous section). However, you can compile your own copy from source code.

• Download and install Lazarus 2.0.6 or later.
• Get the MRIcroGL repository
• Launch the graphical lazarus and choose the Project menu's Open Project item. Select the project you wish to open (e.g. MRIcroGL.lpi).
• Use the Run command from the Run menu compile and run your project.

Compiling with the Command Line

It is generally recommended that download a pre-compiled executable (see earlier section). However, you can compile your own copy from source code. Download and install Lazarus 2.0.6 or later, at which point the lazbuild command should be available from the command line.

For Linux (QT5) or Windows (though see notes above), the compilation will look like this :

git clone https://github.com/rordenlab/MRIcroGL.git
lazbuild --build-ide= --add-package lazopenglcontext ./Python27-for-Lazarus/python4lazarus/python4lazarus_package.lpk
cd MRIcroGL
lazbuild  -B MRIcroGL.lpr

For MacOS, you will want to specify the modern Cocoa widgetset, rather than the legacy Cocoa widgetset:

git clone https://github.com/rordenlab/MRIcroGL.git
cd MRIcroGL
lazbuild  -B --ws=cocoa MRIcroGL.lpi

Project variations

MRIcroGL can be compiled for Linux, macOS and Windows. Compiler directives allow MRIcroGL to be tuned for various environments. Several projects are provided with different Compiler Options. For further control, one can edit the CompilerOptions fields of these projects for preferred builds. Here are the provided projects:

Python:

• Y: Scripting uses PythonBridge. Static linking for Unix, .dll for Windows.
• N: Built without scripting functionality and menu.
• Y*: cripting uses Python-for-Lazarus.
• Y†: Scripting uses PythonBridge. Assumes libpython3.*.so in either /usr/local/lib or /usr/lib. For example, /usr/lib/python3.9/config-3.9-x86_64-linux-gnu/libpython3.9.so.

Metal:

• N: OpenGL 2.1 used for visualization.
• Y: Metal used for visualization (macOS only).

LLVM:

• N: FreePascal compilation.
• Y: FreePascal uses Clnag to create intermediate representation (IR) for LLVM. This can provide slightly faster performance, perticulary for the ARM architecture.

cfGzip:

• N: Uses Compiles native Pascal code for handling GZip compression.
• Y: Statically links accelerated cloudflare zlib which requires CPU instructions introduced in 2011.

Linux dependency

For the Linux (qt5) widgetset users will need to install libqt5pas. Hopefully this can be done with sudo apt install libqt5pas. However, you can also get a Linux libqt5pas 1.2.8 or later installer online.

Deploying MRIcroGL

The MRIcroGL executable has more functionality if it can access its Resources folder. This folder includes color lookup tables (lut folder), Python scripts (script), Material Capture (matcap), GPU Shaders (shader), default NIfTI images (standard), NIfTI atlases (atlas), as well as fonts and icons. Therefore, for full functionality, you want the executable to have access to this folder.

• For MacOS, the Resources folder is placed inside the application package bundle. In other words, if your application is MRIcroGL.app, the software expects MRIcroGL.app/Resources.
• For Windows, place the Resources folder in the same folder as MRIcroGL.exe.
• For Linux, you can place the Resources folder in the same folder as the MRIcroGL executable. If this fails, it will look for the folder $MRICROGL_DIR where $MRICROGL_DIR is an environment variable. It will then look a folder in the following order (for the first pass, where the applications actual name is used MRIcroGL_QT, and for a second pass using MRIcroGL):

 /opt/MRIcroGL/Resources
 /opt/MRIcroGL
 /opt/MRIcroGL/Resources
 /opt/MRIcroGL
 /usr/local/MRIcroGL/Resources
 /usr/local/MRIcroGL
 /usr/local/MRIcroGL/Resources
 /usr/local/MRIcroGL
 /usr/local/share/MRIcroGL/Resources
 /usr/local/share/MRIcroGL
 /usr/local/share/MRIcroGL/Resources
 /usr/local/share/MRIcroGL

Linux GNOME users may also want to setup a desktop file with a name like MRIcroGL.desktop. A sample is provided in the Resources folder, but this will require minor editing since the Exec and Icon path must be absolute not relative.

Scripting and Command Line

You can use all the functions of MRIcroGL using the graphical interface. You can also create Python scripts to get precise results our automate laborious tasks.

You can also control MRIcroGL from the command line.

• Launch MRIcroGL and have it automatically run a Python script: mricrogl myscript.py. This method also allows you to control MRIcroGL from your preferred programming languages.
• MacOS uses may find it useful to make an alias to MRIcroGL. This will allow you to simply run mricrogl from the command line instead of typing the full path. You can do this by running open -a TextWrangler ~/.bash_profile and then adding an alias, for example adding the line mricrogl='/Applications/MRIcroGL.app/Contents/MacOS/MRIcroGL' (assuming the application is in this folder).
• Reset MRIcroGL to its defaults (forget user preferences): mricrogl -R.
• You can choose the images to load from the command line: MRIcroGL -std -dr 2000 6000 motor -cm actc -dr 2 4. In this example, the FSL standard image is loaded as a background with a display range of 2000...6000, and the image 'motor' is loaded as an overlay with the 'actc' colormap and a display range of 2...4. Note that the options are a subset of those available for fsleyes.
  • You can provide an image name: 'motor', 'mni152.nii.gz', etc.
  • If you have FSL installed, you can choose one of the standard images: '-std', '-std1mm', '--standard', '--standard1mm'.
  • You can specify a color map. For example '-cm bone'.
  • You can specify a display range, for example '-dr 3 4'.
  • Note that you can load multiple images, and the color map and display range is applied to the most recently specified image.

Supported Image Formats

MRIcroGL uses NIfTI as its native format. However, you can drag-and-drop files of various formats and the software should automatically detect and load these images.

• AFNI Brik (.head).
• AIM from Scano Medical µCT or HRpQCT(.AIM;1).
• Analyze (.hdr).
• Bio-Rad PIC (.pic).
• Blender Voxel data (.bvox).
• BrainVoyager VMR (.vmr, .v16).
• DeltaVision (.dv).
• DeskVOX and Virvo (.rvf, .xvf).
• Digital Imaging and Communications in Medicine (DICOM)(extension varies)
  • Simple DICOM images can be imported by dragging and dropping.
  • Use the Import menu's Convert DICOM to NIfTI item for advanced conversion.
• Drishti PVL Processed VoLume (.pvl.nc).
• ECAT (.v).
• FreeSurfer MGH/MGZ Volume (.mgh/.mgz).
• Guys Image Processing Lab (.gipl).
• ICS Image Cytometry Standard (.ics).
• Interfile (.varies, limited support).
• ITK MHA/MHD (.mha/.mhd).
• MRTrix Volume (.mif/.mih; not all variants supported).
• NIfTI (.hdr/.nii/.nii.gz/.voi).
• NRRD (.nhdr/.nrrd).
• POV-Ray Density_File (.df3).
• Portable Network Graphics (.png).
• Portable PixMap (.pgm, .ppm, .pnm).
• slab6 volume format (.vox)
• Spectroscopic Imaging, Visualization and Computing (SIVIC)(.idf).
• Stimulate Sdt (.spr/.sdt)
• Tagged Image File Format (.tiff, .tif, .lsm).
  • Simple TIFF images can be imported by dragging and dropping.
  • Use the Import menu's Convert TIFF to NIfTI item to convert most TIFFs (this allows you to specify pixel dimensions).
  • Use the Import menu's To Convert Folder of 2D TIFFs to NIfTI to stack a series of TIFF files as a single volume (e.g. DigiMorph).
• Vaa3D (.v3draw).
• VTK Legacy Voxel Format (.vtk).
• VTK XML Voxel Format (.vti).
• xraw from MagicaVoxel (.xraw)

If your image format is not supported directly by MRIcroGL, you may want to see if it is supported by the Bio-Formats module of ImageJ/Fiji. If so, you can open the image with the module and save it as NIfTI or NRRD to read it with MRIcroGL.

Rendering Technique

MRIcroGL uses single-pass raycasting to generate volume renderings.

• Philip Rideout's seminal description of this method
• Two-pass rendering explicitly generates a front and back face for a cube that represents the texture coordinates. One pass uses the front face and ray direction to infer the distance to the back face
• Martino Pilia provides a nice description of this method
• Will Usher's minimal WebGL2 project
• MRIcroWeb extends Will Usher's WebGL project to include MatCaps and NIfTI support
• AMI Medical Imaging (AMI) JavaScript ToolKit makes volume rendering easy

Alternatives

There are many terrific free tools for viewing medical imaging data. Since they are free, consider downloading a few and using the best tool for the task at hand. Below are a couple of my personal favorites.

• MRIcron is similar and does not require OpenGL, but it is unable to generate interactive renderings.
• DragonFly is not open source, but it does provide a non-commercial licenses are granted free-of-charge.
• Drishti has powerful rendering abilities, though support for medical imaging formats is limited.
• FSLeyes has many similar features, as well as rich support for FSL. Variants require either OpenGL 1.4 or OpenGL 2.1.
• InVesalius provides useful segmentation tools.
• Mango is a nice viewer.
• Slicer 3D is daunting at first, but provides tremendous power and flexibility.
• Seg3D has powerful segmentation routines.
• For DICOM images (but not other formats), Horos is outstanding.