Skip to main content

niicat

This is a tool to quickly preview nifti images on the terminal. This can be helpful if you are working on a remote server via SSH and do not have a -X connection. Niicat can also display png, jpg or similar images.

Your terminal must support inline images. Ubuntu's default terminal (GNOME Terminal / Ptyxis), Apple Terminal, and Alacritty do not. When using SSH, it is the terminal on your local machine that must support the protocol.

Flag Protocol Works in
(default) iTerm2 imgcat iTerm2, WezTerm, VS Code (enable terminal.integrated.enableImages)
-kt Kitty graphics Kitty, Ghostty, WezTerm
-lb / -ls Sixel mlterm, foot, WezTerm, Konsole, Windows Terminal, xterm (-ti 340)

Install:

pip install niicat

Usage:

niicat T1.nii.gz

If nothing is displayed, your terminal likely does not support the selected protocol. Try another flag from the table above, or switch to a terminal that does.

-lb uses img2sixel from libsixel-bin (sudo apt install libsixel-bin). -ls uses libsixel-python.

Niicat was only tested on python >= 3.7.

Copyright

Copyright © German Cancer Research Center (DKFZ), Division of Medical Image Computing (MIC). Please make sure that your usage of this code is in compliance with the code license.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

niicat-0.6.0.tar.gz (377.7 kB view details)

Uploaded Source

Built Distribution

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

niicat-0.6.0-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file niicat-0.6.0.tar.gz.

File metadata

  • Download URL: niicat-0.6.0.tar.gz
  • Upload date:
  • Size: 377.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.10

File hashes

Hashes for niicat-0.6.0.tar.gz
Algorithm Hash digest
SHA256 3529681cd6d09b96d9999c9c432c85f77ae3f384db812b6e2400d846f2d9a681
MD5 d7e4b6cd2069117857fc08dc5b2e697a
BLAKE2b-256 48780d2436864646ab395de8b26ba67d9ea49bdfcbcf6a9a234c01e158dc62d8

See more details on using hashes here.

File details

Details for the file niicat-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: niicat-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.10

File hashes

Hashes for niicat-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23a15901f7af24a7137b7b414a8ef9674f1d601b6254c6ef7e682e62163f5892
MD5 dc5bb14ecc7ed6190157c0cfa51245d0
BLAKE2b-256 5fcd5097f7b232f825bedebcf41baccf5d41dd86b1d76f1945a05257c4e0cc37

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 Sentry Error logging StatusPage Status page