Napari plugin for loading Bitplane imaris files '.ims'
Project description
napari-imaris-loader
Napari plugin for loading Bitplane Imaris files '.ims'.
Notes:
For this plugin to work "File/Preferences/Experimental/Render Images Asynchronously" must be selected.
Features
- Multiscale Rendering
- Image pyramids which are present in the native IMS format are automatically added to napari during file loading.
- Chunks are implemented by dask and matched to the chunk sizes stored in each dataset. (Napari appears to only ask for 2D chunks - unclear how helpful this feature is currently)
- Successfully handles multi-terabyte multi-channel datasets (see unknowns).
- Higher 3D rendering quality is enabled by a widget that reloads data after specifying the lowest resolution level (higher number = lower resolution) to be included in the multiscale series. Must be done while in 2D rendering mode.
Known Issues / limitations
- Currently, this is only an image loader, and there are no features for loading or viewing objects
- Napari sometimes throws errors indicating that it expected a 3D or 5D array but receives the other.
- This sometimes but relatively rarely causes napari to crash
- Would like to enable Asynchronous Tiling of Images, but this results in more instability and causes crashes.
- Contrast_Limits are currently determined by dtype and not the actual data.
- float: [0,1], uint8: [0,254], uint16: [0,65534]
- Future implementations may use the HistogramMax parameter to determine this.
- 3D rendering works, but it is suggested to turn on 1 channel at a time starting from the highest channel to avoid some OpenGL errors and misalignment errors.
- For example: Turn on only Channel 1, activate 3D rendering, then turn on Channel 0.
Unknowns
- Time series data has not been tested, but it has been designed to work.
This napari plugin was generated with Cookiecutter using with @napari's cookiecutter-napari-plugin template.
Installation
You can install napari-imaris-loader
via pip:
pip install napari-imaris-loader
Contributing
Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.
License
Distributed under the terms of the BSD-3 license, "napari-imaris-loader" is free and open source software
Issues
If you encounter any problems, please file an issue along with a detailed description.
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 napari-imaris-loader-0.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64cf0cdde8777f72e057baed3db4fab8f712c6f94c17cc4cb249ac4c3d880834 |
|
MD5 | 0e2a7e23437f030f7332141bd0b232df |
|
BLAKE2b-256 | a9f1ebcaab3fd293422a7705711f9e909b5433b720b1b6c463d44cf833b7d817 |
Hashes for napari_imaris_loader-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db1b5417092e9ad447663baf30b5c45ca6fd20850ac444eea9d36c21b21b5301 |
|
MD5 | ab22b3cff9cfafd22ff37fbd90718096 |
|
BLAKE2b-256 | 8e03f579d539631f047c87d73987dcb3966d2b5a95e23949c6f9bb92cb4ce5de |