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

This version

0.4.6

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

Uploaded Source

Built Distributions

cellfinder-0.4.6-cp38-cp38-win_amd64.whl (344.9 kB view details)

Uploaded CPython 3.8 Windows x86-64

cellfinder-0.4.6-cp37-cp37m-win_amd64.whl (336.9 kB view details)

Uploaded CPython 3.7m Windows x86-64

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

Uploaded CPython 3.7m

File details

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

File metadata

  • Download URL: cellfinder-0.4.6.tar.gz
  • Upload date:
  • Size: 147.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.6.tar.gz
Algorithm Hash digest
SHA256 f83eafddc76076c0900d692f620ebbc61bb3644ef37a5260a4eeb306cba010e8
MD5 120a516c6fe24f4d740f65aaf785aaa0
BLAKE2b-256 e8b37a5d2f8d593c79967d7e3479c66ebf1c4557b80e01f097289184198a7d2d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.6-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 344.9 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.24.0 setuptools/50.3.0.post20201103 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for cellfinder-0.4.6-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 c5f9c457ebae4f37cd3f0ceb823b9abf75cebb76d48d3b0f1de1731d81847a23
MD5 276cf45ad784a967bafa921094502319
BLAKE2b-256 e8a872592756c359a77d48230ad10c229b276988151f5e1187d1ee5173ebd1ea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.6-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.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.6-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 45921f038e3892e9dc5486e67c6b4e340695882830210fee31a8f861e9bdbe1d
MD5 6c540c37455a374c6f03dc10e0ccd1c7
BLAKE2b-256 18bce743a06532a57e421b5c98f0447d2d300031aee5c0beb5a638d9a4c7a4c9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.6-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 336.9 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.24.0 setuptools/50.3.0.post20201103 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.9

File hashes

Hashes for cellfinder-0.4.6-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 398605b28985ac98c0112bfc3f6cb02a656a0c157e4c83809f59c5433c2c6523
MD5 a4e471c706f8d0b935cca10bfa0322e0
BLAKE2b-256 da819658ea9bd0dabbd3b2b280674af5e19b5502f7a002e822f4ec885570b382

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.6-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.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.6-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 86b8df6ba521ad5a6c28a604301f68afdbaf1f68dafd6ad8c9ca00ee6041545d
MD5 f93da0fa6ccf9d097b04c97c281fdc5e
BLAKE2b-256 607d2944569e6390f7a6e5297e9ae72aa58733546c6b60bb3fa831bc9bcf737e

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