https://github.com/raphiniert-com/volume_renderer
GPU-enabled Volume Renderer for use with MATLAB®
https://github.com/raphiniert-com/volume_renderer
Last synced: 8 months ago
JSON representation
GPU-enabled Volume Renderer for use with MATLAB®
- Host: GitHub
- URL: https://github.com/raphiniert-com/volume_renderer
- Owner: raphiniert-com
- License: agpl-3.0
- Created: 2020-01-10T18:08:49.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-28T14:19:17.000Z (over 1 year ago)
- Last Synced: 2024-11-28T15:26:16.687Z (over 1 year ago)
- Language: MATLAB
- Homepage:
- Size: 6.91 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Volume Renderer for use with MATLAB®
_Volume Renderer for use with MATLAB®_ extends MATLAB® by a GPU-accelerated volume render command that handles 3D volumetric data. The core application is implemented in C/C++. To guarantee fast computations the render process computes on the GPU. This is realized by NVIDIA® CUDA®. Furthermore _Volume Renderer for use with MATLAB®_ provides the following features:
* **Special memory management:** Due to restricted GPU memory and the requirement to render more than one volume in one scene, we developed a special memory management to enable the rendering of huge data sets in separate rendering passes. Afterward these separately rendered images are combined to one image using MATLAB®.
* **Generic illumination model:** We developed a generic illumination model that is easy to extend with other illumination functions. The provided function is the Henyey-Greenstein phase function.
* **Stereo rendering:** In some use cases there is a nice feature to work with stereo images. Thus, the renderer offers the possibility to render off-axis stereo images.
* **High usability:** To enable a high usability a MATLAB® interface consisting of several MATLAB® classes has been developed. Due to this interface it is uncomplicated to generate movies.
* **Memory Management:** In order to increase the speed of the renderer, volumes are transferred to the GPU if any change of data occured. This is realized by persisting the memory between all render built upon [this code](https://de.mathworks.com/matlabcentral/fileexchange/38964-example-matlab-class-wrapper-for-a-c-class).
## Requirements
* CUDA® capable NVIDIA® graphics device which is compatible with CUDA 10.2
* Linux or Windows computer (64 bit) with installed NVIDIA® driver and CUDA® 10.2
* MATLAB® [1](#f1) with
* [Image Processing Toolbox](https://www.mathworks.com/products/image.html)
* [Parallel Computing Tookbox](https://mathworks.com/products/parallel-computing.html) for compilation (requires [mexcuda](https://de.mathworks.com/help/parallel-computing/mexcuda.html))
## Installation
First download and extract or clone the repository. Next, download and install the following tools:
- [CUDA 10.2](https://developer.nvidia.com/cuda-downloads)
- [Setup some C compiler](https://de.mathworks.com/support/requirements/supported-compilers.html)
Next, open matlab and navigate to the folder with the render code in matlab. Adjust the CUDA path in `src/make.m` and run it from within `src`. This command will compile all mex-files for the renderer.
Either, enter `src/matlab` to run code and place your matlab renderer code there, or setup matlab to load this folder at each startup into its search path as described [here](https://de.mathworks.com/help/matlab/matlab_env/add-folders-to-matlab-search-path-at-startup.html) (recommended).
## Documentation
In order to generate a [doxygen documentation](https://doxygen.nl) in html, we offer a `Doxyfile`. Install the tool and run `doxygen Doxyfile`.
The resulting Documentation will be stored in `docs/doxygen`. Further, in order to get an theoretical understanding of the concepts, read the related published [research paper](https://www.mdpi.com/2673-6470/4/4/49).
## Example
The following video demonstrates the power of the renderer:
### Example Code
In `src/matlab` are four examples:
- `example1.m`: creating a 2D image of a zebrafish embrio dataset
- `example1_grad.m`: same as above, but using precomputed gradient volumes instead of on the fly gradient computation
- `example2.m`: create a video of the zebrafish embrio
- `example3.m`: same as example 2, but using two channels and fading out one side of the average brain of the zebrafish
They all are built upon one dataset from [1]. In order to run the examples mentioned above, one needs to put the required file `ViBE-Z_72hpf_v1.h5` in `examples/h5-data/`. The scripts are setup to be run from anywhere, either with `add path` or change into the directory.
## License
- The Volume renderer is licensed under [GNU Affero General Public License version 3](https://opensource.org/licenses/AGPL-3.0).
- The examples are licensed under [MIT](https://opensource.org/licenses/MIT).
- Copyright 2020-present © [Raphael Scheible](https://raphiniert.com)
## Acknowledgments
Originally, Raphael Scheible started Volume Renderer for use with MATLAB® as a student at the University of Freiburg, with the assistance of [Benjamin Ummenhofer](http://lmb.informatik.uni-freiburg.de/people/ummenhof/) and [apl. Prof. Dr. Olaf Ronneberger](http://lmb.informatik.uni-freiburg.de/people/ronneber/).
## References
[1] Ronneberger, O and Liu, K and Rath, M and Ruess, D and Mueller, T and Skibbe, H and Drayer, B and Schmidt, T and Filippi, A and Nitschke, R and Brox, T and Burkhardt, H and Driever, W. **[ViBE-Z: A Framework for 3D Virtual Colocalization Analysis in Zebrafish Larval Brains](http://lmb.informatik.uni-freiburg.de//Publications/2012/RLSDSBB12) .** 2012. _Nature Methods,_ 9(7):735--742. [↩](#r1)
## Citation
If you use the renderer in your research, please cite the following paper:
```bibtex
@Article{digital4040049,
AUTHOR = {Scheible, Raphael},
TITLE = {GPU-Enabled Volume Renderer for Use with MATLAB},
JOURNAL = {Digital},
VOLUME = {4},
YEAR = {2024},
NUMBER = {4},
PAGES = {990--1008},
URL = {https://www.mdpi.com/2673-6470/4/4/49},
ISSN = {2673-6470},
DOI = {10.3390/digital4040049}
}
```
---
1: tested and developed under R2022a; might work from R2018a [↩](#a1)