Napari plugin for viewing Brain Image Library datasets
Project description
Description
View datasets archived at the Brain Image Library.
**NOTE: This plugin is under early development. Currently, only a subset of single-channel, fMOST datasets which include projections are available to view. An example can be found here.
Features
- Multiscale Rendering
- In datasets that include multiple resolution representations of the data, each resolution can be combined to improve the speed of browsing and user experience. An example of a dataset with multiple resolution projections can be found here.
- All datasets included in the current release of napari-bil-data-viewer use multi-resolution datasets.
- 3D rendering of whole datasets. The lowest resolution is used for rendering. Currently, this is a limitation imposed by napari.
- The plugin does NOT require a BIL account as datasets are already accessible via https.
Known Issues / limitations
- Currently the only datasets that are available are those which have been manually selected by the developers. If you would like a specific dataset to be included please consider adding the dataset(s) to the dataset_info.py file and submitting a pull request.
- To inquire about this plugin please contact Brain Image Library support: bil-support@psc.edu
- The plugin is still under development. We appreciate all reports of issues / errors which occur during use.
This napari plugin was generated with Cookiecutter using with @napari's cookiecutter-napari-plugin template.
Installation
Option #1: Install plugin via the napari plugin menu
- Menu: Plugins >> Install/Uninstall Plugins
- Search: napari-bil-data-viewer
- Select install
Option #2: Install a fresh python virtual environment
# Example of venv creation using conda
conda create -y -n bil-viewer python=3.8
conda activate bil-viewer
# Install napari-bil-data-viewer
pip install napari-bil-data-viewer
# Run Napari
napari
Contributing
Please consider contributing to this project! 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-bil-data-viewer" is free and open source software
Issues
If you encounter any problems, please file an issue along with a detailed description.
Change Log:
v0.1.0:
Initial release.
v0.1.1 & v0.1.2:
Changes to documentation
v0.1.3:
Added all available summary fMOST datasets
v0.2.0:
Added support for SWC neuron tracings
v0.3.0:
Added support for multiscale OME zarr data
v0.4.0:
Add scale controls for layers
v0.4.2:
Add URL input to visualize image stacks (tif, tiff, jp2)
v0.5.0:
Split the plugin into 5 widgets:
- Load Curated Datasets
- Load Image Stack From URL
- Load Multiscale Data From URL
- Load Neuron Morphology From URL
- Layer Scale Controls
v0.5.1:
Add metadata link to curated datasets
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-bil-data-viewer-0.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d558c35b29dad33a6f8b6368ac2ec6856b9ade8547a19e272a10cfa5c5d752d5 |
|
MD5 | 2a34519c94541c7417d7afc150a7de34 |
|
BLAKE2b-256 | d9493f0553efb28d0cd883b514840998d44d2227cee7f47d17e0a84517899d5d |
Hashes for napari_bil_data_viewer-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08e20e8bb9378f47a89646043ae97c76e4b2487d6fecd9b435651d52fb6d3df7 |
|
MD5 | b2d7e44c070900dce3d739e9697fb648 |
|
BLAKE2b-256 | 146dc253aafa9fe56a0a7f46b6d1fe401a4a2d89861832ba1c524d29431fbc39 |