Skip to main content

Automated 3D cell detection and registration of whole-brain images

Project description

Python Version PyPI Downloads Wheel Development Status Tests Coverage 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.8.tar.gz (158.3 kB view details)

Uploaded Source

Built Distributions

cellfinder-0.4.8-cp38-cp38-win_amd64.whl (351.1 kB view details)

Uploaded CPython 3.8 Windows x86-64

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

Uploaded CPython 3.8

cellfinder-0.4.8-cp37-cp37m-win_amd64.whl (344.0 kB view details)

Uploaded CPython 3.7m Windows x86-64

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

Uploaded CPython 3.7m

File details

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

File metadata

  • Download URL: cellfinder-0.4.8.tar.gz
  • Upload date:
  • Size: 158.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for cellfinder-0.4.8.tar.gz
Algorithm Hash digest
SHA256 bff8dbc3c4fb3ab7ebce6c8352afc474894764008b15c9d6e1ba22b4cf282c10
MD5 ee156b6a497e6875b7faed1d74a6968c
BLAKE2b-256 a5464da4a55692349e33e73fb6f794d861c1d8e4c35a1ff3a117f8ecbb706f6f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.8-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 351.1 kB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.6

File hashes

Hashes for cellfinder-0.4.8-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 555d20bc39ed4fa0df57e6e1825a2f26f7366fdf0fd4814a1e268d85fb255e72
MD5 8f92f7c4fe647507a673eed37c737534
BLAKE2b-256 1f842fc1d1a8a22dc28e40de287293f70c4b18d605eb905babb2f3dab388d10e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.8-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.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for cellfinder-0.4.8-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 d7da0b0a23b8926c98a7f8ba626bd17c7d7fd12465b536c8d2e1867445607609
MD5 7f778e57b84667fa1dbc96bbcc775b85
BLAKE2b-256 fe13ff670927466bc29cf6f542b45bb4943bd61570531b4627653f097afcd50c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.8-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 344.0 kB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9

File hashes

Hashes for cellfinder-0.4.8-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 f8f8d268f0cea82702e604b43ea0c3d8bb21a82c85e950255c5866fbdbfdb17a
MD5 97b51f0c157698426c3a5478502bfe5c
BLAKE2b-256 55eb896c578d3aea4bb91f3db905bc4e72f1ed305cf68d38ba498760426dcee9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.8-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.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for cellfinder-0.4.8-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c275a9cd31c5603556917e4ffc570e6b1c320933789958c2661bd3cf48dfd46e
MD5 3bca4d6fa8154d0da744a69134ad22aa
BLAKE2b-256 e44d009d328f22f478b0850074d21023ea9ff9d236f3247214f9308c1fdde1f6

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