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 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. 10.5281/zenodo.3891338

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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.8 Windows x86-64

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

Uploaded CPython 3.7m Windows x86-64

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

Uploaded CPython 3.7m

File details

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

File metadata

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

File hashes

Hashes for cellfinder-0.4.0.tar.gz
Algorithm Hash digest
SHA256 ed6bcfdbd5d4405795035b1ac76c1cbf7d34da3724b65b3b4fb3f60ef618e8aa
MD5 18a16dd88ab14e2373759a4b1c1b81fa
BLAKE2b-256 0b5c2c6c5dff0be52d5af307070ab79102aceb01c84501c790c999309ab7d71d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.0-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.5.0.1 requests/2.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

Hashes for cellfinder-0.4.0-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 ee701136eae0cf6ea78698579eb076f858dfc620d795545e370eedbf85d58987
MD5 badb8a2793f7d532f7ae39b5620e48c6
BLAKE2b-256 c6d5e5f4902b5bde526e385a169ff011c32d9b952b9479cc7dfe314181312be5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.0-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.5.0.1 requests/2.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.9

File hashes

Hashes for cellfinder-0.4.0-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 ed167986facc62aa1e7d3aa5e52aacc401d6a979f4754f21da665f042c1d9bd8
MD5 198f5ed0ea202eb76fcd25f43d3bd1d8
BLAKE2b-256 ac66cf94ea1f485d32630c2b3289247e86a1a6e75212dfafc2d3009777eb2327

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.0-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.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.0-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 94497df45993bc6657319fd88c0fb961a994decffbb27f437990c3e3344d65ee
MD5 e1ac273a227f5f44bb0a4f6faac1b18e
BLAKE2b-256 4e20be9500e7bd32900c1515eeedeaa7cd174e7cdfaa8925dd183ad20df7870a

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