https://github.com/dipterix/three-brain-js
Javascript engine for 3D brain model (used by RAVE project)
https://github.com/dipterix/three-brain-js
ecog electrode-localization freesurfer ieeg mri mri-brain mri-images neuroscience nifti-viewer seeg webgl2
Last synced: 4 days ago
JSON representation
Javascript engine for 3D brain model (used by RAVE project)
- Host: GitHub
- URL: https://github.com/dipterix/three-brain-js
- Owner: dipterix
- License: mpl-2.0
- Created: 2023-01-20T20:42:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-02T02:37:01.000Z (2 months ago)
- Last Synced: 2025-03-30T14:41:56.193Z (about 1 month ago)
- Topics: ecog, electrode-localization, freesurfer, ieeg, mri, mri-brain, mri-images, neuroscience, nifti-viewer, seeg, webgl2
- Language: JavaScript
- Homepage:
- Size: 32.3 MB
- Stars: 16
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## JavaScript Library for YAEL (Your Advanced Electrode Localizer)
[](https://rave.wiki/posts/3dviewer/viewer201.html)
[](https://doi.org/10.1523/ENEURO.0328-23.2023)
[](https://www.npmjs.com/package/@rave-ieeg/three-brain)
**This repository is ONLY for developers who wish to incorporate YAEL into their own 3D programs, not for end-users.** If you are looking for integrated electrode localization & visualization tools, please check our website: [rave.wiki](https://rave.wiki).
This repository contains a JavaScript engine for visualizing 3D brain models via modern web browsers (with [`WebGL2` support](https://get.webgl.org/webgl2/)). The key features include:
* Visualizing surface models (FreeSurfer surface, AFNI/SUMA)
* Overlay T1 MR images as anatomical slices (FreeSurfer `.mgh/mgz`, NIfTI `.nii`)
* Overlay volume data in terms of voxel cubes (NIfTI `.nii`)
* Overlay electrodes as spheres
* Color/Animate electrodes based on their values (continuous, categorical)
* Electrode localization with CT at original resolution (paper in proceeding)
* Group-level electrode mapping (via MNI or SUMA 141 brain)
The data configuration files are currently generated by the R package [`threeBrain`](https://github.com/dipterix/threeBrain/). Python package [`threebrainpy`](https://pypi.org/project/threebrainpy/) is also under active development.
Please see "Roadmap" for details.
For hard-core developers who wish to incorporate the package into your project:
```sh
npm i @rave-ieeg/three-brain
```
## Citation
Please cite the following paper:
* Wang Z, Magnotti JF, Zhang X, Beauchamp MS. _YAEL: your advanced electrode localizer._ eNeuro 19 October 2023, 10 (10); DOI: 10.1523/ENEURO.0328-23.2023
If you are interested in the bigger framework (RAVE: reproducible analysis and visualization of iEEG), please check:
* Magnotti JF, Wang Z, Beauchamp MS. _RAVE: comprehensive open-source software for reproducible analysis and visualization of intracranial EEG data._ NeuroImage (2020) 223:117341
## License
The package is licensed under MPL-2.0 license.
The purpose is to avoid virus-like copyleft licenses such as GPL. MPL-2.0 allows `three-brain-js` library to be *linked* as whole without forcing to change your own license (even it's proprietary). However, any redistribution of the original or modified copies outside your organizations shall be released under MPL-2.0 or more rigid open-source license. This is not a legal advice, nor the license itself, and may not cover important issues that affect you and your specific situation. As a result, please read the license itself, or seek legal advice from a lawyer for any questions.