Skip to main content

Multi-atlas whole-brain microscopy registration

Project description

Python Version PyPI Wheel Development Status Code style: black codecov

brainreg-napari

Napari plugin to run brainreg, developed by Stephen Lenzi.

Installation

pip install brainreg-napari

Usage

Documentation and tutorials for the plugin can be found 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 developers 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)!

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.1.2.tar.gz (17.3 kB view details)

Uploaded Source

Built Distribution

brainreg_napari-0.1.2-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file brainreg-napari-0.1.2.tar.gz.

File metadata

  • Download URL: brainreg-napari-0.1.2.tar.gz
  • Upload date:
  • Size: 17.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for brainreg-napari-0.1.2.tar.gz
Algorithm Hash digest
SHA256 86741229634c6c8c1674502f3312173323c9154bdb8bbec702f470708420a4c7
MD5 4fcaf0d22e11233e41b2c829afb386ae
BLAKE2b-256 db06e386594a794e83ce987a3e20f68495b52d6b9d4921a820519591aa61b1a1

See more details on using hashes here.

File details

Details for the file brainreg_napari-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for brainreg_napari-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c2e8f3043d832d6a974c8858a6dad0fa12176d816cc5fe2e6cd4e2850b981498
MD5 89affc0c1fa81a38979df1309e3746e9
BLAKE2b-256 b2b908a0e9d1579469c8ee08d2517d9cf5994e8e7fc2446039ab00e78b247be3

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