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

Uploaded Source

Built Distributions

cellfinder-0.4.7rc9-cp38-cp38-win_amd64.whl (351.2 kB view details)

Uploaded CPython 3.8 Windows x86-64

cellfinder-0.4.7rc9-cp37-cp37m-win_amd64.whl (344.1 kB view details)

Uploaded CPython 3.7m Windows x86-64

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc9.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.7rc9.tar.gz
Algorithm Hash digest
SHA256 d4c8c6fb5a7e1ca623ce1708ee65639b6e5d71688c62d98a1f8b05f4a20be28e
MD5 e6cb6d39afe854d20d52bbcbeccae5a5
BLAKE2b-256 db4058476a276277383e6c9465f374dba89a00519f6223898f3c1d80a67942ab

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc9-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 351.2 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.7rc9-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 6553b2bad2f4611f3ca1e2dd7305d98bf3412771424d2eb92fb4e9a6bfce7f6c
MD5 a16441ae9943a9dcaabe47f954819986
BLAKE2b-256 0700a8cdbddd7e792a76dd5400083e57fb1d47d35a5ecf6af31a2426189aa415

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc9-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.7rc9-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1507f7ad66f4e48dfea0048ae7e2f5e5fd3d7a1fb79998653f7cccb68efd560c
MD5 d7672295a64d8a618fa05e7f2f2d0073
BLAKE2b-256 1f7c7bd0263124a4403d1a703a867c5e63844bf9f51bfd1fba9689b765a6628f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc9-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 344.1 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.7rc9-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 7830b1f52ba7fef8efd26db4ea09c366cb09a5eb963e9a1ff9141dfb23bd2557
MD5 cf5eb9775dfd4b8021a9389d1b99ef54
BLAKE2b-256 c9a57bf181414c1bd85f14f5816f4540441fb00478362e1f3850603cfb2363b2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc9-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.7rc9-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 903001165b7b0a6c8a73c32b64422cf7494f483aca545cb6256d3fd966f09da9
MD5 305793f53764faceaada9dd48f244711
BLAKE2b-256 0e830baa4cfd632b7f0f6a8ae8520e2829ac9a872b20c1e73ba8f44700fc9a78

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