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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.8 Windows x86-64

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

File metadata

  • Download URL: cellfinder-0.4.7rc4.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.7rc4.tar.gz
Algorithm Hash digest
SHA256 b6f3eaa23395afc06fe2f3835495d010206281a2400461e296e4cfdef504ce32
MD5 e78957c7778241c95de60d1eefffba13
BLAKE2b-256 9b281160989d4650bc06e37a8a4d550a776f92a0c01ddde50ab28f5545dd8d33

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc4-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.7rc4-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 ce5a5f658e2597006efc791b14398d5d9188b29bbfb187fcf28820f07d59cde7
MD5 0313feedcede522e7b28e4c97be0a41a
BLAKE2b-256 296bbbfd573e84292459bf1fc8b4eacc0cfda395e23a5797c1f26bc6cc92a518

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc4-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.7rc4-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 d13f90359c06c0d3827ff13ea599cf805a337b7b37aea21245281a74de76853d
MD5 d8781f6ae534108fd608a5ded1d2b75f
BLAKE2b-256 b69e6b940b31f60c528aa5f9c6e28584df36e8f0e9cd18ee47b0b77effeb4819

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc4-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.7rc4-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 30536e933cb3a9f275989c46194fcaf7d79ea92616f67787c6d90533d886cf34
MD5 84c888cbb851e8dc815df3609e276c1d
BLAKE2b-256 8cc4d5d026b735ab96102ffab506af2fb1bf2f3d096338f1bbd631688520ba99

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc4-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.7rc4-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4d9317c5f7b7b4ff2187c5ddec997d904181a3dec1011aa68d524ca48b8e4c89
MD5 5b8e96da25dd0857bb3a12bf88b8832e
BLAKE2b-256 4ef091b302161c8b43c7cff8105da3be11e6d58eb6761c2546f5f5144ec4b4a6

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