Skip to main content

Plotting brain regions of interest (ROI) for demonstration purposes in Python

Project description

roipy

Plotting brain regions of interest (ROI) for demonstration purposes in Python

Description

Have you ever wanted to plot a region of the brain to include in a talk or presentation? What about in a lecture? Some might arbitrarily highlight the area of the cortex in which they think a particular region might fall. Others might scour the internet for images. Well...you won't need to do that any more. With roipy, you can plot exact regions of the brain using the Destrieux Atlas.

Installation

This package is hosted on PyPi. You may use pip to install.

pip install roipy

Usage

There are three types of brain plots included in roipy. A "univariate" plot, a "multivariate" plot and a "whole brain multivariate" plot. There are two methods for generating each plot:

  1. Using the domain general class, roipy.plotting.Plot()
  2. Executing each individual plotting method via its own specific function (e.g., roipy.utils.plot_multivariate())

Below is an example of each methods implementation.

# import
from roipy.plotting import Plot
from roipy.utils import plot_multivariate

# Domain general Plot()
P = Plot()
P.plot_multivariate(roi=[1,3,5,34], cmap='viridis')

#Individual function
plot_multivariate(roi=[1,3,5,34], shape='pial', view='lateral', hemi='left', cmap='viridis')

# Save the plot
import matplotlib.pyplot as plt
plt.savefig('brain.png')

The parameter roi is given a list of integers which correspond to the Destrieux surface atlas.

You can also animate the plots with roipy.animation.Anim().

# import
from roipy.animation import Anim
from roipy.plotting import Plot

# Plot() instance
P = Plot()

# Anim() instance
A = Anim()
a.animate(lambda frame: P.plot_multivariate(roi=[1,3,5,34], cmap='viridis'), fname='brain.gif', save=True)

Admittedly, this is more complex as it requires use of the lambda function in Python. But, using roipy.plotting.utils.plot_univariate, you can devise your own animation style.

Example brain

brain

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

roipy-1.3.8.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

roipy-1.3.8-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file roipy-1.3.8.tar.gz.

File metadata

  • Download URL: roipy-1.3.8.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.6

File hashes

Hashes for roipy-1.3.8.tar.gz
Algorithm Hash digest
SHA256 3094f3a9467067a67cde4fbbefcffa55ee51dfde76c4c8d5d942ca14d65cfd80
MD5 e3559cf3dc455aee3c4875176bbd8834
BLAKE2b-256 39d3c2a73de3af2847960d972158deb5adcf472b047f16659ce4dbedcdf16490

See more details on using hashes here.

File details

Details for the file roipy-1.3.8-py3-none-any.whl.

File metadata

  • Download URL: roipy-1.3.8-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.6

File hashes

Hashes for roipy-1.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c74bba88c652117479883ae1df3d29af475c4cce3f6d55c60a668932dd6cfb34
MD5 203bc984b2cd14ddc60ca04369163aed
BLAKE2b-256 46641b0d5761b958e6dff2831f245079545362504bfa08f99cbdb7ceb3af0340

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