Command-line tool and python library for visualising small 3D datasets
Project description
Simple matplotlib-based tool for viewing small amounts of 3D image data; helpful for debugging.
Notes
Due to the circumstances in which matplotlib holds open figure windows, and stops updates during blocks, the entire array must be read into memory before it can be viewed. It is a smalldataviewer after all…
Installation
pip install smalldataviewer
Some file types require additional dependencies:
Usage
As executable
usage: smalldataviewer [-h] [-i INTERNAL_PATH] [-t TYPE] [-o ORDER]
[-f OFFSET] [-s SHAPE] [-v]
path
positional arguments:
path Path to HDF5, N5, zarr, npy or npz file containing a
3D dataset
optional arguments:
-h, --help show this help message and exit
-i INTERNAL_PATH, --internal_path INTERNAL_PATH
Internal path of dataset inside HDF5, N5, zarr or npz
file
-t TYPE, --type TYPE Dataset file type. Inferred from extension if not
given.
-o ORDER, --order ORDER
Order of spatial axes for axis labelling purposes.
Data is not transposed: dimension 0 will be scrolled
through, dimension 1 will be on the up-down axis,
dimension 2 will be on the left-right axis,
anddimension 3, if it exists, will be used as the
colour channels. Default "zyx".
-f OFFSET, --offset OFFSET
3D offset of ROI from (0, 0, 0) in pixels
-s SHAPE, --shape SHAPE
3D shape of ROI in pixels
-v, --verbose Increase output verbosity
>>> smalldataviewer.py my_data.hdf5 -i /my_group/my_volume
As library
from smalldataviewer import DataViewer, dataviewer_from_file
# data can be anything which slices like a np.ndarray (e.g. h5py dataset)
import numpy as np
data = np.random.random((30, 100, 100))
viewer = DataViewer(data)
viewer.show() # or matplotlib.pyplot.show()
viewer2 = dataviewer_from_file(dataviewer, "my_data.npz", "volume") as viewer2:
viewer2.show()
N.B.
Because of the circumstances under which python holds file descriptors open and matplotlib blocks, file-based volumes may need to read into numpy arrays to be scrolled through if the .show() is at the end of the script.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for smalldataviewer-0.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e373364d4f84ceedc949698e4fce08d23f9d7a0999dd4d68569580162557459d |
|
MD5 | 8aadb2c2037360a03bd02e74e7063556 |
|
BLAKE2b-256 | faf1c2d9feb71f982111065f96e1129bf3a9c21c3f8dc5df02cbc2409667055c |