A real-time diffusion MRI slicing application for Linux using OpenGL 4.6. It can visualize spherical functions expressed as a series of spherical harmonics coefficients in DIPY's descoteaux07 legacy real symmetric or full SH basis (See this link for more details.).
To start using dmri-explorer, clone this repository.
Before installing the software, please make sure you meet the requirements below.
Cmakeminimum version 3.11 is required for installing the application.- The generator used by default is
GNU Make. - A compiler supporting
C++17features is required (for GCC,C++17is available for versions 5 and above). - Make sure you have
gitinstalled; it is used for fetching thenifticliblibrary. - You have an OpenGL implementation available on your system. On Ubuntu, it can be installed with
sudo apt install mesa-common-dev.mesa-common-devis an open-source implementation of OpenGL. See this link from wikipedia for more information.
The build the program, run the following commands from the project root directory:
mkdir build
cd build
cmake ..
make
Alternatively, a helper script containing the four commands shown above is made available for building the software. It can be launched using:
./install.sh
The above script creates the build directory, runs Cmake and make. The executable file will be in the folder ${project_root}/build/Engine.
Once the program is built, you can add the path to the directory containing the executable to your .bashrc configuration to make it available system-wide.
export PATH='${absolute_path_to_project}/build/Engine':$PATH
The application can be launched using the command:
dmriexplorer path/to/image.nii.gz
When working with a big image, you may encounter a "Window not responding" message at application startup. Don't worry, it will go away once the image is copied on the GPU.
To display all available command line arguments, use the flag --help.
The software has been presented as part of the CDMRI'21 workshop. It has however evolved since then and will keep getting better over time. For the performances reported at the workshop, please refer to the release v0.1. However, we highly encourage the user to use the latest version of the application on the main branch, as efforts have been made to lower GPU and CPU memory usage.
If you enjoy this application, please consider citing the following work:
Poirier C., Descoteaux M., Gilet G. (2021) Accelerating Geometry-Based Spherical Harmonics Glyphs Rendering for dMRI Using Modern OpenGL. In: Cetin-Karayumak S. et al. (eds) Computational Diffusion MRI. CDMRI 2021. Lecture Notes in Computer Science, vol 13006. Springer, Cham. https://doi.org/10.1007/978-3-030-87615-9_13
Contributions are welcome and encouraged:
- If you discover bugs (installation problems, in-app bugs, etc.), please open an issue describing the error and the steps to reproduce it;
- If you have a feature request, you are also encouraged to open an issue describing your need;
- Pull-requests are of course welcome! Please refer to the contributing guidelines.