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.
1 maintainer
Metadata
1 maintainer
Release files for niicat 0.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| niicat-0.6.0.tar.gz | 377.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| niicat-0.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 395.1 kB
Release files / niicat-0.6.0.tar.gz
| Download URL | niicat-0.6.0.tar.gz |
|---|---|
| Size | 377.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3529681cd6d09b96d9999c9c432c85f77ae3f384db812b6e2400d846f2d9a681
|
|
BLAKE2b-256 checksum How to use checksums |
48780d2436864646ab395de8b26ba67d9ea49bdfcbcf6a9a234c01e158dc62d8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.10
|
Release files / niicat-0.6.0-py3-none-any.whl
| Download URL | niicat-0.6.0-py3-none-any.whl |
|---|---|
| Size | 17.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
23a15901f7af24a7137b7b414a8ef9674f1d601b6254c6ef7e682e62163f5892
|
|
BLAKE2b-256 checksum How to use checksums |
5fcd5097f7b232f825bedebcf41baccf5d41dd86b1d76f1945a05257c4e0cc37
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.10
|
