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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.8 Windows x86-64

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

Uploaded CPython 3.7m Windows x86-64

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc7.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.7rc7.tar.gz
Algorithm Hash digest
SHA256 9ecb1eb3bb6c798afc8f0dca1e223546f60ae406867afc1b53bf08a8d14fa100
MD5 e40e7e0668061d79686118466e85398b
BLAKE2b-256 9cf42a76871f6aed43932106efe94804c94da8e67a0f102dced414c8778f1b39

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc7-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 351.4 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.7rc7-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 ad6a0b9cc3c9c24432b0667ec6a83db5af176867571db9016bd2ecb5930e03d3
MD5 2f67fcab1e03e55d46800e0f4f432ddf
BLAKE2b-256 dba7d6c3a3adcb339c2d8599a9abddf9cfc415ea90089d00271fad53d2075287

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc7-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.7rc7-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 7a431c34be5f922b4bf3ad67457137dd1f6bf35faf2ff1777512082c626a8563
MD5 3305a0045cac36fbfdc0c0276cf905ca
BLAKE2b-256 98466b5d9569644c9e23f7b24e4d38dfa967b03efc65b1d935245ec084b84226

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc7-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 344.3 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.7rc7-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 7c31c4e68600d99821d345b3090af74ab921502eaefc52dde08e791d283f41e9
MD5 e83d423580e6fff92525b77844dd8e7a
BLAKE2b-256 ca94003a112388883417cf9bedc30622dca03a94d235fb7792ce67c327a18f3c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc7-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.7rc7-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f327028fb7fb24675f697c21fbfcaf73aaedf3cde2ced6311a18efeb2c716efa
MD5 26ff57eda261383802e52f63db7e8dbb
BLAKE2b-256 fed9ab6589e0caafb5aa4946424bcc37c6706b48e9563392df939916ef1e7266

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