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

Uploaded Source

Built Distributions

cellfinder-0.4.7rc3-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.7rc3.tar.gz.

File metadata

  • Download URL: cellfinder-0.4.7rc3.tar.gz
  • Upload date:
  • Size: 158.7 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.7rc3.tar.gz
Algorithm Hash digest
SHA256 60a6fa34e30c254e925d92750ba9a4b21981aa81734203e30b47eb8f84bb6789
MD5 018e4e27b6fd529f7a9b62da14dd9a7f
BLAKE2b-256 de5a633acba836e0907447c897eabad9b43daf191bf88c26a7a14e38104eaf43

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc3-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.7rc3-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 911484d659de8e1cd89fa4cdcd0c37e6b453e912142340e921d2050dfb1c596d
MD5 793cd6039fac9053e91c2546a0f284f0
BLAKE2b-256 8dfa473c61fa00d8df7c87cdba49c165f593d83e3837de49a8a2dcd4a102d6ad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc3-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.7rc3-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 8e80209053c661a3cf62ab62a804795ca7629a51bfc5df36e07bf6fa4ae4a47d
MD5 f597d1e51dbadb9e7a343bbf2458b605
BLAKE2b-256 07176f003ef376e8894950a8c5d6cd0bdfedc5c5ebe47cd5e7c5e64e12d87e15

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc3-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.7rc3-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 7469aeccfba39bc5e6b6bbb268eda00c4df63fa6122aa7576ad43b2483245e7c
MD5 f8e7d0b0f89424b0bb6217d858d4f87a
BLAKE2b-256 35b00b504b3eb6ddd0f513745b6fad5f4cb4392eb8c8598d998faa99f0666c4f

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