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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.8 Windows x86-64

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

Uploaded CPython 3.7m Windows x86-64

File details

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

File metadata

  • Download URL: cellfinder-0.4.7a0.tar.gz
  • Upload date:
  • Size: 153.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.4.7a0.tar.gz
Algorithm Hash digest
SHA256 c587a117eb36fa59e63e380e4009c1e351f0bfa3f7ae1bcdd13f502562b55b50
MD5 4d2f67b112f4f233138b21caa060b73c
BLAKE2b-256 bee34791172e449dab788748048625414419ce0bf0565b82e87a8bb3c5e4157e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7a0-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 374.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.25.0 setuptools/50.3.1.post20201107 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.8.5

File hashes

Hashes for cellfinder-0.4.7a0-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 c6c44ab7c24f74d3d1201fb56481409f6c802f2a2849778e370fa46b13a15b6a
MD5 9f4b6624e64bed7ff26ad59f1b62e993
BLAKE2b-256 15861060c9b90c5eeb7e857241dff78e58fa3c647e4a9dae3885ee62bf27d5c8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7a0-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 382.2 kB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.4.7a0-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 56ee28068d214b5de60b36aaccda99ed521244bfde74dd42a67a70926645fd8f
MD5 4447d638f5664800673bb21ece3db92d
BLAKE2b-256 5a39022d7a4b9b75b56cc87b0a4ad38e287caaa6ba14ba7d998df947ef26c7c8

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