Skip to main content

Automated 3D cell detection and registration of whole-brain images

Project description

Python Version PyPI Downloads Wheel Development Status Travis Coverage Status Dependabot Status Code style: black Gitter DOI Contributions Website Twitter

Cellfinder

Whole-brain cell detection, registration and analysis.


Cellfinder is a collection of tools from the Margrie Lab and others at the Sainsbury Wellcome Centre for the analysis of whole-brain imaging data such as serial-section imaging and lightsheet imaging in cleared tissue.

The aim is to provide a single solution for:

  • Cell detection (initial cell candidate detection and refinement using deep learning).
  • Atlas registration (using brainreg)
  • Analysis of cell positions in a common space

Installation is with pip install cellfinder.

Basic usage:

cellfinder -s signal_images -b background_images -o output_dir --metadata metadata

Full documentation can be found here.

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 questions or issues, please get in touch by email, gitter or by raising an issue.


Illustration

Introduction

cellfinder takes a stitched, but otherwise raw whole-brain dataset with at least two channels:

  • Background channel (i.e. autofluorescence)
  • Signal channel, the one with the cells to be detected:

raw Raw coronal serial two-photon mouse brain image showing labelled cells

Cell candidate detection

Classical image analysis (e.g. filters, thresholding) is used to find cell-like objects (with false positives):

raw Candidate cells (including many artefacts)

Cell candidate classification

A deep-learning network (ResNet) is used to classify cell candidates as true cells or artefacts:

raw Cassified cell candidates. Yellow - cells, Blue - artefacts

Registration and segmentation (brainreg)

Using brainreg, cellfinder aligns a template brain and atlas annotations (e.g. the Allen Reference Atlas, ARA) to the sample allowing detected cells to be assigned a brain region.

This transformation can be inverted, allowing detected cells to be transformed to a standard anatomical space.

raw ARA overlaid on sample image

Analysis of cell positions in a common anatomical space

Registration to a template allows for powerful group-level analysis of cellular disributions. (Example to come)

Examples

(more to come)

Tracing of inputs to retrosplenial cortex (RSP)

Input cell somas detected by cellfinder, aligned to the Allen Reference Atlas, and visualised in brainrender along with RSP.

brainrender

Data courtesy of Sepiedeh Keshavarzi and Chryssanthi Tsitoura. Details here

Citing cellfinder

If you find cellfinder useful, and use it in your research, please cite the preprint outlining the cell detection algorithm:

Tyson, A. L., Rousseau, C. V., Niedworok, C. J., Keshavarzi, S., Tsitoura, C. and Margrie, T. W. (2020) “A deep learning algorithm for 3D cell detection in whole mouse brain image datasets’ bioRxiv, doi.org/10.1101/2020.10.21.348771

If you use any of the image registration functions in cellfinder, please also cite brainreg.

If you use this, or any other tools in the brainglobe suite, please let us know, and we'd be happy to promote your paper/talk etc.

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

cellfinder-0.4.7.tar.gz (158.4 kB view details)

Uploaded Source

Built Distributions

cellfinder-0.4.7-cp38-cp38-win_amd64.whl (351.2 kB view details)

Uploaded CPython 3.8 Windows x86-64

cellfinder-0.4.7-cp38-cp38-manylinux2014_x86_64.whl (2.0 MB view details)

Uploaded CPython 3.8

cellfinder-0.4.7-cp37-cp37m-win_amd64.whl (344.1 kB view details)

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.4.7-cp37-cp37m-manylinux2014_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.7m

File details

Details for the file cellfinder-0.4.7.tar.gz.

File metadata

  • Download URL: cellfinder-0.4.7.tar.gz
  • Upload date:
  • Size: 158.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

File hashes

Hashes for cellfinder-0.4.7.tar.gz
Algorithm Hash digest
SHA256 2e26211f49436202504bb183bbf949e1d4049b06b17bf4abbfa1e99725185768
MD5 5ad161379222565697d2843a9a7729af
BLAKE2b-256 4f64f9496921290d86a669b0d11ccbe2b2f944790e46de0311060d5ac5a65433

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.7-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.4.7-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 351.2 kB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.8.6

File hashes

Hashes for cellfinder-0.4.7-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 6d172f8805e2d7c7e6be61b2845bdd52322e75300cad38a1e5950802e381a4b8
MD5 ab79a5e648787c934eaebe8f820f6651
BLAKE2b-256 cccc49d77f082ef4c4f3c7553225930fe22adaf9c90fa44504c99236ed7040eb

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.7-cp38-cp38-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.4.7-cp38-cp38-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

File hashes

Hashes for cellfinder-0.4.7-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b717a987c34811381bd9ee5c307e05c3d0548fe8e425b6ebd9ee03643b9a4be4
MD5 f323e20debd37545523cfe7fce2757cd
BLAKE2b-256 af67a6a974617a4054d2e305ecb067c4d6f50b8596b25b1fd1633125fdcc0661

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.7-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.4.7-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 344.1 kB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.7.9

File hashes

Hashes for cellfinder-0.4.7-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 dce0ed53b184f1df6e2a102d2e35cefd3d16e471825f0e70583096a4b361fb49
MD5 a4715b1041426548818d23b0ca0199cf
BLAKE2b-256 6184abafd461805a711d63b9b7d1f005a6730bd0220ea1cb93d67905f32acf3a

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.7-cp37-cp37m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.4.7-cp37-cp37m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

File hashes

Hashes for cellfinder-0.4.7-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 cd225e0d7a8bf8b931fffc6db7cd7727cb4ef08763549af00a154ed1ee043be9
MD5 e030f6b224b495dd0588166b985ee04f
BLAKE2b-256 49c8dd50dbe67042c242d3be342b31f7db18aac7cd2acde6797676666824a725

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