Skip to main content

View volumetric images in Python 🧠

Project description

niftiview_logo_transparent_small

The easiest way to view volumetric images in Python 👩‍💻 Install it via pip install niftiview!

If pip install niftiview results in an error, try fixing it via

  • apt install libcairo2-dev pkg-config python3-dev (on Linux)
  • brew install cairo pkg-config tcl-tk python-tk (on macOS)

niftiview stands behind

  • NiftiView, the viewer app with the cutest desktop icon 🧠 Download it here!
  • NiftiWidget, a widget for interactive viewing in Jupyter 👩‍💻🧠 Install it via pip install niftiwidget!

Usage 💡

Single images can be shown via NiftiImage

from niftiview import TEMPLATES, NiftiImage

nii = NiftiImage(TEMPLATES['ch2'])
# nii = NiftiImage('/path/to/your/nifti.nii.gz')
im = nii.get_image()
im.show()

niftiimage

NiftiImageGrid can display multiple images in a nice grid layout

from niftiview import TEMPLATES, NiftiImageGrid

niigrid = NiftiImageGrid([TEMPLATES['ch2'], TEMPLATES['T1']])
# niigrid = NiftiImageGrid(['/path/to/your/nifti1.nii.gz', 
#                           '/path/to/your/nifti2.nii.gz'])
im = niigrid.get_image(layout='sagittal++', nrows=1)
im.show()

niftigrid

Behind the scenes, niftiview uses three main classes that build on each other

  • NiftiCore: Puts image slices of the 3D image in a 2D numpy.ndarray...
  • NiftiImage: ...applies a colormap to the array, converts it to a PIL.Image and adds overlays...
  • NiftiImageGrid: ...puts the images in a grid

Study the examples 🧑‍🏫 to fully understand niftiview and create an image like this

sci_gray

as a vector graphic─PDF, SVG, EPS or PS format─with high image quality (e.g. for scientific publication 👨‍🔬)

niftiview-cli 🖥️

pip install niftiview also installs the command line utility that given filepath(s) or a filepattern...

niftiview-cli -i /path/to/niftis/*.nii.gz -o /path/to/output/folder --gif

...saves PNGs or GIFs. To showcase its versatility, here is a compilation of created GIFs

niceviews

Explore all the available options by running niftiview-cli --help

P.S. If you're interested in creating 🧠 tissue maps like the ones shown at the end of the GIF, check out deepmriprep!

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

niftiview-1.1.2.tar.gz (16.3 MB view details)

Uploaded Source

Built Distribution

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

niftiview-1.1.2-py3-none-any.whl (16.3 MB view details)

Uploaded Python 3

File details

Details for the file niftiview-1.1.2.tar.gz.

File metadata

  • Download URL: niftiview-1.1.2.tar.gz
  • Upload date:
  • Size: 16.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.3 Linux/6.14.0-27-generic

File hashes

Hashes for niftiview-1.1.2.tar.gz
Algorithm Hash digest
SHA256 e992efd91a4309f2d53374481b1b0b39faf8aa032e706a70bed2502582807fe7
MD5 69cce7d6dca48da61f4fce74f24201de
BLAKE2b-256 b82bd30d6cae4ba693ec2c2ea1ec3032d23669b26e134a51df8167fd8d0d592f

See more details on using hashes here.

File details

Details for the file niftiview-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: niftiview-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 16.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.3 Linux/6.14.0-27-generic

File hashes

Hashes for niftiview-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2be22b57137401f361c6310b6451dd5f270b91886e9e072b73d625163a0b33b5
MD5 6e015b38a141093c6f34e12fb8ed7787
BLAKE2b-256 1afee4aa742d4b86d6cdb805de68fedcc6240ab7c1477d4a9ae4728f5aa62307

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