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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.8 Windows x86-64

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

File metadata

  • Download URL: cellfinder-0.4.7rc6.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.7rc6.tar.gz
Algorithm Hash digest
SHA256 a8c193b340832946930fa5f3adaf4cc8fc39f98e93eb4d9cf4ceefb7a3366f4f
MD5 8d7b1d5abab80243ef0e91e55d98504b
BLAKE2b-256 2315ea05ef343221b2284daf35e46db7cbcfacd70d8286d2fb2f833ea82d5b93

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc6-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.7rc6-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 5b56dfd4c39cc7f97f1b4b86a60d84a2bc115313251010a4534aea2c25e8ffd8
MD5 b9eca54c2feb739425eff5dd31e25b5c
BLAKE2b-256 6ea7650c0f5dbee17b48ace556ecd1ef352ed611c979d68d09fe4a3df96c5e0f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc6-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.7rc6-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 13781b4599b80b69a5016919bcf0ac15309f5a0e718d07dfb20e506e2e973d4a
MD5 ccb214b1da102e1e19175b6a974a7d57
BLAKE2b-256 0ab2cc4c7a43dbdef8ba40f96d92267ccb404e1a5c0e07058cc76575e286dae2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc6-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.7rc6-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 497ed4e72e4f7cabfd13f7aeb71c0b26d3868293e8b3fa655020826c0e53807d
MD5 61a4ab564f50a42921848cae243058bd
BLAKE2b-256 56436f30d3e8be71d7f1c3eda5f770f137147de9686a871d9484b84e493d0c94

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.7rc6-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.7rc6-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f24f621988af2f9f65b14297e08c9387bdb333402c2e4365b29aed4c4ec30b43
MD5 e011c7e85d9ef400841f5fea2521d2ed
BLAKE2b-256 adfd494666a70020f99c8a4379a09cdb037749897c6ad9dbf0796f4086482609

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