Skip to main content

A package for automated plotting of neuroimaging maps using Connectome Workbench.

Project description

Automated plotting of neuroimaging maps from Python using Connectome Workbench.

This package is intended for users who want to generate images which illustrate scalar data on a brain surface, from within their Python scripts.

Installation


Step 1. Make sure you have Connectome Workbench v1.3+ installed.

Step 2. Install wbplot and dependencies.

  • Clone the repository and install manually: git clone https://github.com/jbburt/wbplot.git
  • Or just use pip: pip install wbplot

Usage


Assuming x is a NumPy array containing scalar values mapped onto each of the 360 parcels in the Human Connectome Project's MMP1.0 parcellation:

from wbplot import pscalar
pscalar("/path/to/image.png", x)

Assuming y is a NumPy array containing dense scalar values mapped onto the 59412 surface vertices in a standard bilateral 32k surface mesh:

from wbplot import dscalar
dscalar("/path/to/image.png", y)

Notes


  • wbplot currently only supports cortical data. Parcellated data must also be in the HCP MMP1.0 parcellation. Dense data must be registered to a standard 32k surface mesh.
  • Down the line I'd be open to adding subcortical support and other functionality if anyone ever actually uses this package.
  • More detailed explanations of the functionality can be found in the scripts in the examples directory.

Change Log


  • 1.0 Initial release.
  • 1.0.1 Small error in README.
  • 1.0.2 Error in MANIFEST.in -- not all necessary data files included in build.
  • 1.0.3 Entirely changed the way data are read from and written to, to circumnavigate permissions issues.
  • 1.0.4 ImageParcellated loaded into dense scenes resulted in error messages printed to console.
  • 1.0.5 Last patch didn't fix the problem.
  • 1.0.6 Added errors raised to docstrings and cleaned up a few files.

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

wbplot-1.0.6.tar.gz (20.2 MB view hashes)

Uploaded Source

Built Distribution

wbplot-1.0.6-py3-none-any.whl (20.3 MB view hashes)

Uploaded Python 3

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