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.

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. reg_process Overview of the registration process

Contributing

Contributions to brainreg-napari are more than welcome. Please see the contributing guide.

Citing brainreg

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

Tyson, A. L., Vélez-Fort, M., Rousseau, C. V., Cossell, L., Tsitoura, C., Lenzi, S. C., Obenhaus, H. A., Claudi, F., Branco, T., Margrie, T. W. (2022). Accurate determination of marker location within whole-brain microscopy images. Scientific Reports, 12, 867 doi.org/10.1038/s41598-021-04676-9

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)!


The BrainGlobe project is generously supported by the Sainsbury Wellcome Centre and the Institute of Neuroscience, Technical University of Munich, with funding from Wellcome, the Gatsby Charitable Foundation and the Munich Cluster for Systems Neurology - Synergy.

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.5rc0.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

brainreg_napari-0.0.5rc0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file brainreg-napari-0.0.5rc0.tar.gz.

File metadata

  • Download URL: brainreg-napari-0.0.5rc0.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for brainreg-napari-0.0.5rc0.tar.gz
Algorithm Hash digest
SHA256 b49e4446cd1340b0877349d73ee25ef4d73103e508a6ee60a9ec39166b5ea5fb
MD5 3f3bc09931268e39768b429459b422be
BLAKE2b-256 1a99c5d5a6be7005943057b15acd73fa16669ae4302d24841b824125a33c2784

See more details on using hashes here.

File details

Details for the file brainreg_napari-0.0.5rc0-py3-none-any.whl.

File metadata

File hashes

Hashes for brainreg_napari-0.0.5rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 62f4b5cf42a248d070dd72d531df661b419afe9b9afd885a9ba44e4b62c91f1c
MD5 99c337bf6cc6b9241625b4ccd81ffb34
BLAKE2b-256 961bc0c6620dc91912d757ca22e4193c459822edc7d78bf8183b51dd36d5fc49

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