Skip to main content

Multi-atlas whole-brain microscopy registration

Project description

Python Version PyPI Wheel Development Status Code style: black

brainreg-napari

Napari plugin to run brainreg, developed by Stephen Lenzi.

Installation

pip install brainreg-napari

Usage

Documentation for the plugin is to come, but documentation for the original brainreg can be found here and a tutorial is here.

For segmentation of bulk structures in 3D space (e.g. injection sites, Neuropixels probes), please see brainreg-segment.

This software is at a very early stage, and was written with our data in mind. Over time we hope to support other data types/formats. If you have any issues, please get in touch on the forum or by raising an issue.

If you have any other questions, please send an email.

Details

brainreg is an update to amap (itself a port of the original Java software) to include multiple registration backends, and to support the many atlases provided by bg-atlasapi.

The aim of brainreg is to register the template brain (e.g. from the Allen Reference Atlas) to the sample image. Once this is complete, any other image in the template space can be aligned with the sample (such as region annotations, for segmentation of the sample image). The template to sample transformation can also be inverted, allowing sample images to be aligned in a common coordinate space.

To do this, the template and sample images are filtered, and then registered in a three step process (reorientation, affine registration, and freeform registration.) The resulting transform from template to standard space is then applied to the atlas.

Full details of the process are in the original aMAP paper. process Overview of the registration process

Citing brainreg

If you find brainreg useful, and use it in your research, please let us know and also cite the preprint:

Tyson, A. L., Vélez-Fort, M., Rousseau, C. V., Cossell, L., Tsitoura, C., Obenhaus, H. A., Claudi, F., Lenzi, S. C., Branco, T., Margrie, T. W. (2021) “Tools for accurate post hoc determination of marker location within whole-brain microscopy images’ bioRxiv, doi.org/10.1101/2021.05.21.445133

Please also cite aMAP (the original pipeline from which this software is based):

Niedworok, C.J., Brown, A.P.Y., Jorge Cardoso, M., Osten, P., Ourselin, S., Modat, M. and Margrie, T.W., (2016). AMAP is a validated pipeline for registration and segmentation of high-resolution mouse brain data. Nature Communications. 7, 1–9. https://doi.org/10.1038/ncomms11879

Lastly, if you can, please cite the BrainGlobe Atlas API that provided the atlas:

Claudi, F., Petrucco, L., Tyson, A. L., Branco, T., Margrie, T. W. and Portugues, R. (2020). BrainGlobe Atlas API: a common interface for neuroanatomical atlases. Journal of Open Source Software, 5(54), 2668, https://doi.org/10.21105/joss.02668

Don't forget to cite the developers of the atlas that you used (e.g. the Allen Brain Atlas)!

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

brainreg-napari-0.0.2rc3.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

brainreg_napari-0.0.2rc3-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file brainreg-napari-0.0.2rc3.tar.gz.

File metadata

  • Download URL: brainreg-napari-0.0.2rc3.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for brainreg-napari-0.0.2rc3.tar.gz
Algorithm Hash digest
SHA256 619f99c9afdbf9c25e57b189a751465c6cc362e2114b477ffc31d5cfb3b7bfe1
MD5 be62459985999efeae67ad43fa68d7b1
BLAKE2b-256 235102a82c2da05c9f415af4da70368d52f6fcaacb934df793849cffc9cfcfdd

See more details on using hashes here.

File details

Details for the file brainreg_napari-0.0.2rc3-py3-none-any.whl.

File metadata

  • Download URL: brainreg_napari-0.0.2rc3-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for brainreg_napari-0.0.2rc3-py3-none-any.whl
Algorithm Hash digest
SHA256 79f3b512613344a4b0c9c327dc2fcceffe47f4218f53a730d6643c5071501936
MD5 5763ec39c98764604301ce40e15b6db2
BLAKE2b-256 24caa575a1372ecd9e914ddc73d2b3badd52bb18071ac54fff2c36d2e0245b3e

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