Skip to main content

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

Project description

Python Version PyPI Wheel Development Status Travis Coverage Status Dependabot Status Code style: black Gitter DOI Generic badge

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 amap)
  • 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 (amap)

Using amap, 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

Additional tools

cellfinder is packaged with neuro which provides additional tools for the analysis of visualisation of whole-brain imaging data.

Heatmaps of detected cells:

heatmap

Mapping non-cellular volumes in standard space:

injection Virus injection site within the superior colliculus. (Data courtesy of @FedeClaudi and brainrender)

Citing cellfinder

If you find cellfinder useful, and use it in your research, please cite this repository:

Adam L. Tyson, Charly V. Rousseau, Christian J. Niedworok and Troy W. Margrie (2020). cellfinder: automated 3D cell detection and registration of whole-brain images. doi:10.5281/zenodo.3665329

If you use any of the image registration functions in cellfinder, please also cite amap.

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

Uploaded Source

Built Distributions

cellfinder-0.3.8-cp37-cp37m-manylinux2010_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.7m manylinux: glibc 2.12+ x86-64

cellfinder-0.3.8-cp37-cp37m-manylinux1_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.7m

cellfinder-0.3.8-cp36-cp36m-manylinux2010_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.6m manylinux: glibc 2.12+ x86-64

cellfinder-0.3.8-cp36-cp36m-manylinux1_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.6m

File details

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

File metadata

  • Download URL: cellfinder-0.3.8.tar.gz
  • Upload date:
  • Size: 157.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.8.tar.gz
Algorithm Hash digest
SHA256 950c55574cc5e6cce99e1b51c111c320e3233cbce6f7f42b47a79fd48df22e62
MD5 288900341f4c246d4a8446549ebc06f0
BLAKE2b-256 21f68933a2db9dd11e3061377a4ee54dd5f83c2edb40f76289d05c50b05aa781

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.8-cp37-cp37m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.8-cp37-cp37m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: CPython 3.7m, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.8-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 8e7b90d802059218d5aadcb96b1dcfa4f0f4e8ee5c54159b3cb4aa49aea9de10
MD5 6d3be71fd6314fac33fc33872935f08a
BLAKE2b-256 c0e001f5c0bfd7630209d82e4ffd7eeba84b821b9885cfddcdfe8103c2f97c39

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.8-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.8-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.8-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 9d9f2648e76c946fd11ff8423c27717521523be26c45f25949e5c40d7a2b4304
MD5 d4ca37161caf14a443bccd534937684f
BLAKE2b-256 b6875018bbc6bfa86d96e9e4f27504724b3f1b938b038d14be3fa25803da8dd8

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.8-cp36-cp36m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.8-cp36-cp36m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: CPython 3.6m, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.8-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 bcae9d0cf334aafb22adc2bc5d7bb79526508d3166a63e9e47a314d2f121f126
MD5 c2323334acb75eb586c598e2156cdb6d
BLAKE2b-256 5099035b6b2ce0f4183f4ebcd856f5c779d92585f8d3ca537f7f9e93e7817662

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.8-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.8-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.8-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 4b90fa5d2b159dc22ed7662ea66449083618de9bd5a776014175671254a99175
MD5 b5ed32a65c808cdf0d50265beba6339f
BLAKE2b-256 a0c26b785fc3e462feed59b881d658f9622df1fb543f437af7e9770715bd5015

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