Skip to main content

Python library for Neurovolume. Build VDBs for scientific visualizations

Project description

Render of a non-skull stripped MNI Template

Neurovolume is a Python library for manipulating and visualizing volumetric data. It includes a custom-built, scientific data-focused, VDB writer. The VDB writer is written in Zig with no external dependencies. Currently some NIfTI1 files can be parsed natively.

While this project focuses on neuroscience, it includes ndarray to VDB to support virtually any volumetric data pipeline.

This project is very much a work in progress. (see "Missing Features" below). As of now, I do not recommend regarding the images created by this software as scientifically accurate.

🏗️ Usage

#todo

📀 Projects

  • BoldViz: a Blender plugin for fMRI and MRI visualizations. It was used to create the renders in this README. A great place to start if you don't want to deal with writing any Python.
  • Neurovolume Examples and Physarum include some good starting points for how one might use this library with numpy. The nibabel example shows how to use an external NIfTI parser, which could be of use for not-yet-supported filetypes.

☁️ Why VDB?

VDBs are a highly performant, art-directable, volumetric data structure that supports animations. Our volume-based approach aims to provide easy access to the original density data throughout the visualization and analysis pipeline. Unlike the openVDB repo, our smaller version is much more readable and does not need to be run in a docker container.

🛠️ Missing Features

While a comprehensive road-map will be published soon, there are a few important considerations to take into account now.

  • Presently the VDB writer isn't sparse nor does it support multiple grids. Tiles and multiple grids are in development.
  • Neurovolume currently only natively supports NIfTI1 files (and only some variants). Full coverage and NIfTI2 will be supported soon. Until then, you can use an ndarray as an intermediary (see Python Usage).
  • Frame interpolation (present in the original Go prototype) is currently under development on this branch. If you wish to access the old Go code, check out the archive
  • Documentation has not been written yet.

🧠 Dataset Citation

This software was tested using the following datasets.

Isaac David and Victor Olalde-Mathieu and Ana Y. Martínez and Lluviana Rodríguez-Vidal and Fernando A. Barrios (2021). Emotion Category and Face Perception Task Optimized for Multivariate Pattern Analysis. OpenNeuro. [Dataset] doi: 10.18112/openneuro.ds003548.v1.0.1

OpenNeuro Study Link

Direct Download Link for T1 Anat test file

Direct Download Link for BOLD test file

The MNI Template can be found Here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neurovolume-0.1.0a8.tar.gz (486.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

neurovolume-0.1.0a8-py3-none-any.whl (486.0 kB view details)

Uploaded Python 3

File details

Details for the file neurovolume-0.1.0a8.tar.gz.

File metadata

  • Download URL: neurovolume-0.1.0a8.tar.gz
  • Upload date:
  • Size: 486.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.14 {"installer":{"name":"uv","version":"0.9.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for neurovolume-0.1.0a8.tar.gz
Algorithm Hash digest
SHA256 f3f95cdef926e229ad84104363be0c92fe326fdb9881d9bab80e89c5496f7f45
MD5 3b32b4413765efc5d6597b8e8de094e2
BLAKE2b-256 81772ba905e9f3cd3cf5541bb926d377134f531d175371317daad9365ea92e70

See more details on using hashes here.

File details

Details for the file neurovolume-0.1.0a8-py3-none-any.whl.

File metadata

  • Download URL: neurovolume-0.1.0a8-py3-none-any.whl
  • Upload date:
  • Size: 486.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.14 {"installer":{"name":"uv","version":"0.9.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for neurovolume-0.1.0a8-py3-none-any.whl
Algorithm Hash digest
SHA256 a68ccb9440605f8492f0570dc45bfbbd47b37c12a262ddf542f9e417276f5f02
MD5 277b7b7f94991cba639ed3990c0a1e33
BLAKE2b-256 b889ca7a27304f0ecf8e8f36f7c6e2ba959b2b8bb95d043800ff972be48e0a58

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page