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

Uploaded Source

Built Distributions

cellfinder-0.4.4-cp38-cp38-win_amd64.whl (344.9 kB view details)

Uploaded CPython 3.8 Windows x86-64

cellfinder-0.4.4-cp38-cp38-manylinux2014_x86_64.whl (2.0 MB view details)

Uploaded CPython 3.8

cellfinder-0.4.4-cp37-cp37m-win_amd64.whl (337.0 kB view details)

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.4.4-cp37-cp37m-manylinux2014_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.7m

File details

Details for the file cellfinder-0.4.4.tar.gz.

File metadata

  • Download URL: cellfinder-0.4.4.tar.gz
  • Upload date:
  • Size: 148.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.4.tar.gz
Algorithm Hash digest
SHA256 4d2df91e7fd960d19bf575c9401ccd58c46da006754396718fd904474e09ce68
MD5 9918134126bb35f5dd03e486f65824bf
BLAKE2b-256 5997a8c49d7797265d5120c2262de15778ea9bc7b37f67540ea540b0d11d73e5

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.4-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.4.4-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 344.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.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for cellfinder-0.4.4-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 0ea1568a03213e59bbc3adcb1e373b3807639dec575734d37cc9ca2e7aa49f4e
MD5 29e83073947704e3005e373692314d62
BLAKE2b-256 b51966f35f22eaa41ef69c95042196fd00c3effa2dc9f17fc78ab51bc715deb8

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.4-cp38-cp38-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.4.4-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.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.4-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a37e6d44f11d90ae5df858c098914e2149d7c4942978b0b5fed8737e8894dd0e
MD5 0de68661b2babbda4898629f6ca77c24
BLAKE2b-256 551685788593217933c98b554e34bdbcd5027648bc0c63e9ff3a805de34b9b85

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.4-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.4.4-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 337.0 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.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.9

File hashes

Hashes for cellfinder-0.4.4-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 50bd6b147c8f4061afe06d922464a57a28a839949f2373343d5152e639461cea
MD5 4207c5473669a9d804a03be9c0043f79
BLAKE2b-256 bfbfcf131357a396e5646475f49bc6749e25b636bba437ef1994a12cf8536405

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.4-cp37-cp37m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.4.4-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.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.4-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9750d2c4aa4eb12cded497194bc1f2230ed4b2c346a95a7063e4816947fcb891
MD5 e43606b32341d4c223ebe624acdf5212
BLAKE2b-256 cbde0a93fc459e254d5efe58eb2f6bb7b3c8df4d403578045dc0f5a122491d5f

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