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

Uploaded Source

Built Distributions

cellfinder-0.4.7rc5-cp39-cp39-win_amd64.whl (349.9 kB view details)

Uploaded CPython 3.9 Windows x86-64

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc5.tar.gz
  • Upload date:
  • Size: 158.6 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.7rc5.tar.gz
Algorithm Hash digest
SHA256 df9ac1ded16dcf174d2195d6fc9de1b62f9d9e525283e15d069afca281e4d816
MD5 dfc3ae46c16a20931900aab964f23b93
BLAKE2b-256 1f968cb165716653ae6a93d3fdc41eb8beb7ad3a79dcb56600c65c8983d94313

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.7rc5-cp39-cp39-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.4.7rc5-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 349.9 kB
  • Tags: CPython 3.9, 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.9.0

File hashes

Hashes for cellfinder-0.4.7rc5-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 f3a04d17f7dc2aa1508f941910aa255899c7e6f326141e8b1087d0449b11a7d3
MD5 bb950742ec8bdd7f76c148b24fdb0a82
BLAKE2b-256 21af8278527e466cd5ca7aba0a1dabaf13bc5c9b5a481da8bf3afb4a77843370

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc5-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.7rc5-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ac3e4809907c507f84c748458af2e2aadde1ff8813869635ae144aae527770e6
MD5 8068b79228a24ccb30d243a92e9c3b54
BLAKE2b-256 ab381a65acb38c0048caf5796cee95f80a01700b6cb7cc73d0f4f678a9344147

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc5-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.7rc5-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 6d298efc72e9766685d2eead1c5c405a93d7a3f2200699f8f45776db6fa553e0
MD5 ccb640d83af1b4dc50c7086e447edf78
BLAKE2b-256 d197ed013017c27b4fd1111edb9f834dfab9836983bd6722fa1ec1e261345c9c

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