Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dfsp-spirit/brainview-rs
A simple real-time brain visualization tool for Rust, based on the three-d crate.
https://github.com/dfsp-spirit/brainview-rs
brain-visualization neuroimaging rust surface
Last synced: 17 days ago
JSON representation
A simple real-time brain visualization tool for Rust, based on the three-d crate.
- Host: GitHub
- URL: https://github.com/dfsp-spirit/brainview-rs
- Owner: dfsp-spirit
- Created: 2021-03-07T13:26:37.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-12T13:45:54.000Z (over 3 years ago)
- Last Synced: 2024-10-31T18:12:08.086Z (2 months ago)
- Topics: brain-visualization, neuroimaging, rust, surface
- Language: Rust
- Homepage:
- Size: 7.25 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# brainview
A high-level library and a simple viewer (binary) for surface-based structural neuroimaging data, written in [Rust](https://www.rust-lang.org/).
The `brainview` crate is based on [neuroformats](https://github.com/dfsp-spirit/neuroformats) and [three-d](https://github.com/asny/three-d) by Asger Nyman Christiansen. It can visualize brain surface meshes and related per-vertex data computed from magnetic resonance images (MRI) in [FreeSurfer](http://freesurfer.net/), [CAT12](http://www.neuro.uni-jena.de/cat/) and other neuroimaging software packages which can output or convert to a supported file format.
## Why brainview?
The goal of the `brainview` crate is to provide a very high-level wrapper around `three-d` that allows neuroscientists using Rust for scientific data analyses to look at their data and statisical results directly in Rust -- without having to export their data first and then load them again in a separate viewer application, which is time-consuming and error-prone when looking at many results.
Ideally, you should be able to load and visualize your neuroimaging data with two function calls.
## Usage
This is WIP, come back another day. Once it's ready, the project will be split into a lib crate for `libbrainview` and a binary crate for the `brainviewer` application.
You can have a look at [src/main.rs](./src/main.rs) to see the client code used to create the prototype below.
## Running the current prototype
If you insist and have a recent Rust toolchain installed, you can build the current prototype from source and run it like this:
```
git clone https://github.com/dfsp-spirit/neuroformats-rs
git clone https://github.com/dfsp-spirit/brainview-rs
cd brainview-rs/
cargo build --release
cargo run
```
Note that you need the neuroformats-rs repo in the same directory as it is currently loaded from there. (Yes, this is WIP.)
This will open a 3D window and show a rotating brain mesh, with vertex colors representing cortical thickness:
