Skip to main content

Read and write files from the BrainGlobe computational neuroanatomy suite into napari

Project description

napari-brainglobe-io

License PyPI Python Version tests codecov

Visualise cellfinder and brainreg results with napari


Installation

This package is likely already installed (e.g. with cellfinder, brainreg or another napari plugin), but if you want to install it again, either use the napari plugin install GUI or you can install brainglobe-napari-io via pip:

pip install brainglobe-napari-io

Usage

  • Open napari (however you normally do it, but typically just type napari into your terminal, or click on your desktop icon)

brainreg

Sample space

Drag your brainreg output directory (the one with the log file) onto the napari window.

Various images should then open, including:

  • Registered image - the image used for registration, downsampled to atlas resolution
  • atlas_name - e.g. allen_mouse_25um the atlas labels, warped to your sample brain
  • Boundaries - the boundaries of the atlas regions

If you downsampled additional channels, these will also be loaded.

Most of these images will not be visible by default. Click the little eye icon to toggle visibility.

N.B. If you use a high resolution atlas (such as allen_mouse_10um), then the files can take a little while to load.

sample_space

Atlas space

napari-brainreg also comes with an additional plugin, for visualising your data in atlas space.

This is typically only used in other software, but you can enable it yourself:

  • Open napari
  • Navigate to Plugins -> Plugin Call Order
  • In the Plugin Sorter window, select napari_get_reader from the select hook... dropdown box
  • Drag brainreg_read_dir_atlas_space (the atlas space viewer plugin) above brainreg_read_dir (the normal plugin) to ensure that the atlas space plugin is used preferentially.

cellfinder

Load cellfinder XML file

  • Load your raw data (drag and drop the data directories into napari, one at a time)
  • Drag and drop your cellfinder XML file (e.g. cell_classification.xml) into napari.

Load cellfinder directory

  • Load your raw data (drag and drop the data directories into napari, one at a time)
  • Drag and drop your cellfinder output directory into napari.

The plugin will then load your detected cells (in yellow) and the rejected cell candidates (in blue). If you carried out registration, then these results will be overlaid (similarly to the loading brainreg data, but transformed to the coordinate space of your raw data).

load_data Loading raw data

load_data Loading cellfinder results

Contributing

Please see the developers guide.

License

Distributed under the terms of the MIT license, "brainglobe-napari-io" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Project details


Download files

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

Source Distribution

brainglobe-napari-io-0.3.1.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

brainglobe_napari_io-0.3.1-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file brainglobe-napari-io-0.3.1.tar.gz.

File metadata

  • Download URL: brainglobe-napari-io-0.3.1.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for brainglobe-napari-io-0.3.1.tar.gz
Algorithm Hash digest
SHA256 9e4115dab772c6da2e1f316a3bbc712c52afd2d7159b083563b2e4537007e03e
MD5 458926e4eb6a223ef2a51bd361827fee
BLAKE2b-256 d4a7f78f43e1ab389a3f6ece473f65e64e31575026464ac907b4d23e04d5bf81

See more details on using hashes here.

File details

Details for the file brainglobe_napari_io-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for brainglobe_napari_io-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c9faa7c4141bf09dff2036b217f59b7606b5ba02eeaa2b8aa57fd34d71f7b8ee
MD5 525b259b45c8ba52ae68b97a9c75fd19
BLAKE2b-256 3b7c284a373b4c42ce288f8470655db06fd1cb8e4bdc705657adbbdcc07cdd4a

See more details on using hashes here.

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