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!

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()

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()
im.show()

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

To fully understand how to use niftiview, study the example notebooks 🧑‍🏫

  • examples/0_core.ipynb explaining NiftiCore
  • examples/1_image.ipynb explaining NiftiImage
  • examples/2_grid.ipynb explaining NiftiImageGrid

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. Take a look at all its possible options via niftiview-cli --help!

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-0.1.0.tar.gz (16.3 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: niftiview-0.1.0.tar.gz
  • Upload date:
  • Size: 16.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.9 Linux/5.15.0-56-generic

File hashes

Hashes for niftiview-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c4bf23fee737705e3d162f3aa8f08178ad156a574cfd916888d42ba863712f59
MD5 31c1f6ccdadf07e7a6ae2e22b9844097
BLAKE2b-256 b29a38f375cef065769e968fcce0d10f0b7de52fb784193e00f6ff2bdfd3d197

See more details on using hashes here.

File details

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

File metadata

  • Download URL: niftiview-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.9 Linux/5.15.0-56-generic

File hashes

Hashes for niftiview-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3aa7a9ad929d569c1d708964c2420649085518a14d84907998f4918e8f717770
MD5 79fd6d30abe187f727c311f9289b4f91
BLAKE2b-256 4d7b6e923f5cd830908348c137e3c8b85e37020e9e0759232998ba3bea63ea16

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