Skip to main content

siibra-toolbox-neuroimaging - siibra toolbox for assignment of neuroimaging signals to brain regions

Project description

|License|

siibra neuroimaging toolbox

Copyright 2020-2021, Forschungszentrum Jülich GmbH

Authors: Big Data Analytics Group, Institute of Neuroscience and Medicine (INM-1), Forschungszentrum Jülich GmbH

This repository provides a toolbox for siibra <https://siibra-python.readthedocs.io>__ which provides functionalities to assign (typically thresholded) whole brain activation maps, as obtained from functional neuroimaging, to brain regions. Given an input volume in the form of a NIfTI file, the toolbox will segregate the input signal into connectec components, and then analyze overlap and correlation of each component with regions defined in an atlas. Per default, the Julich-Brain probabilistic cytoarchitectonic maps defined in MNI152 space are used, and the input volume is assumed in the same physical space. The functionality is strongly inspired by similar functionalities of the popular SPM anatomy toolbox <https://github.com/inm7/jubrain-anatomy-toolbox>__ [EickhoffEtAl2005]_.

In the current implementation, the toolbox provides a Python library as well as an extension to the siibra-cli <https://github.com/FZJ-INM1-BDA/siibra-cli>__ commandline client. We release installation packages on pypi, so you typically can just run pip install siibra-toolbox-neuroimaging to install the Python package and commandline extension.

Note that siibra-toolbox-neuroimaging is still in early development. Get in touch with us to discuss, and feel free to post issues here on github.

A typical workflow will look like this::

from siibra_toolbox_neuroimaging import AnatomicalAssignment my_input_file = ".nii.gz" analysis = AnatomicalAssignment() assignments, component_mask = analysis.run(my_input_file) analysis.create_report(assignments, my_input_file, component_mask)

The main result is a table listing for each detected component significantly overlapping brain regions and their properties, returned as a pandas DataFrame (assignments in the above example). From this, the library can generate a nicely formatted pdf report which also adds structural connectivity profiles for the regions. The same report can also be produced using the commandline interface, by the simple call siibra assign nifti <filename>.nii.gz. Future versions will provide an interactive plugin to siibra-explorer <https://github.com/FZJ-INM1-BDA/siibra-explorer>__, the interactive web browser hosted at https://atlases.ebrains.eu/viewer/go/human.

This repository contains an example notebook, which you can run in your browser using mybinder <https://mybinder.org>__ by clicking the following link:

.. image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/FZJ-INM1-BDA/siibra-toolbox-neuroimaging/HEAD?labpath=example.ipynb

The toolbox relies on the functionalities of siibra-python, documented at https://siibra-python.readthedocs.io. It includes a catalogue of well documented code examples that walk you through the different concepts and functionalities. As a new user, it is recommended to go through these examples - they are easy and will quickly provide you with the right code snippets that get you started.

References

.. [EickhoffEtAl2005] Eickhoff S, Stephan KE, Mohlberg H, Grefkes C, Fink GR, Amunts K, Zilles K: A new SPM toolbox for combining probabilistic cytoarchitectonic maps and functional imaging data. NeuroImage 25(4), 1325-1335, 2005

Acknowledgements

This software code is funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).

.. acknowledgments-end

.. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg :target: https://opensource.org/licenses/Apache-2.0

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

siibra_toolbox_neuroimaging-0.2a0.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file siibra_toolbox_neuroimaging-0.2a0.tar.gz.

File metadata

File hashes

Hashes for siibra_toolbox_neuroimaging-0.2a0.tar.gz
Algorithm Hash digest
SHA256 154fd921a2e3a55caee4266d7c76fd8a32aa07631c825880e3fbe202f6c887e5
MD5 317e039e36ccb948bfb656bb76dcc2e3
BLAKE2b-256 694b295f1fd2f0fffd89c277a06e4031d1768856b75bcd75386614a025a9f02c

See more details on using hashes here.

File details

Details for the file siibra_toolbox_neuroimaging-0.2a0-py3-none-any.whl.

File metadata

File hashes

Hashes for siibra_toolbox_neuroimaging-0.2a0-py3-none-any.whl
Algorithm Hash digest
SHA256 8fb861a8feffa66daf56eb49cb313762ebee4e11dd026ff41cb711e0b346b5f6
MD5 3e356ddc4ec8fb6ead302a9c9d4d2d17
BLAKE2b-256 2947abf46451dee35d7ff106f29fcb441af80f4c680e52a1b35b30224c8ec6cc

See more details on using hashes here.

Supported by

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