Skip to main content

Experimental tensor viewer for IPython built on top of Voxel

Project description

Tunnelvision

Tunnelvision is an experimental tensor viewer for IPython environments based on Voxel.

Installation

Tunnelvision requires Python 3.7+. Wheels are only available for MacOS (x86_64) and Linux for now.

To install Tunnelvision, run:

pip install tunnelvision

Quick Start

The API of tunnelvision is very similar to that of matplotlib. Tunnelvision is a 5D tensor viewer that requires tensors to have the following format: Batch x Depth x Height x Width x Channels, where channels can be 1 (grayscale/monochrome) or 3 (RGB). You can quickly plot (medical) images using:

import numpy as np
import tunnelvision as tv

arr = np.random.randint(0, 2048, (2, 3, 224, 224, 1), dtype=np.uint16)
tv.show(arr)

More advanced plots with segmentation overlays (or colormaps in general) can be created as follows:

ax = tv.Axes(figsize=(512, 512))
ax.imshow(arr1)
ax.imshow(arr2, cmap="seg")
ax.show()

Pyvoxel has support for tunnelvision as well, which allows you to plot images with their correct orientation and spacing, without having to manually set those in the configuration:

import voxel as vx

mv = vx.load("../data/ct/")
tv.show(mv)

VS Code Remote

To use tunnelvision through VS Code remote, we need forward an arbitrary available port to the tunnelvision-server. Once you have forwarded a port from the ports pane within VS Code, make sure to add it to your configuration file for tunnelvision:

# ~/.cache/tunnelvision/default_config.yaml
port: 1337

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

tunnelvision-0.3.2-py3-none-manylinux1_x86_64.whl (25.3 kB view hashes)

Uploaded Python 3

tunnelvision-0.3.2-py3-none-macosx_11_0_arm64.whl (2.2 MB view hashes)

Uploaded Python 3 macOS 11.0+ ARM64

tunnelvision-0.3.2-py3-none-macosx_10_14_x86_64.whl (3.2 MB view hashes)

Uploaded Python 3 macOS 10.14+ x86-64

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