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.5.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

roipy-1.3.5-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: roipy-1.3.5.tar.gz
  • Upload date:
  • Size: 4.2 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.5.tar.gz
Algorithm Hash digest
SHA256 ec07e9e5ffec0f28a0504714e4e0f67c64eb6e2cbb3b2c2bb01dc5569956ffa1
MD5 e2f720e7edb0f9938393db4f4438773b
BLAKE2b-256 20fa8f940703c8788a98d4ec3f4443581e36610e33d94018dbcdd57ed31ce4ae

See more details on using hashes here.

File details

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

File metadata

  • Download URL: roipy-1.3.5-py3-none-any.whl
  • Upload date:
  • Size: 5.5 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1f459c9a1e70d27fb1afaeb92e08d6b6d1238f432206b714a04e765509bb0731
MD5 a0c31f7304cbc1d2f271e622faef13a5
BLAKE2b-256 4293a6254d649bba7ea0b482c16ffef6bf1073ca6c727d16af598d4657714eef

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