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 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. See the documentation for details.

Heatmaps of detected cells:

heatmap

Mapping non-cellular volumes in standard space:

Virus injection site within the superior colliculus.

(Data courtesy of @FedeClaudi and brainrender) injection

Mapping of probe tracks in standard space:

Neuropixels probe in primary visual cortex.

(Data courtesy of @velezmat). injection

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.14rc7.tar.gz (606.2 kB view details)

Uploaded Source

Built Distributions

cellfinder-0.3.14rc7-cp37-cp37m-win_amd64.whl (359.2 kB view details)

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.3.14rc7-cp36-cp36m-win_amd64.whl (359.0 kB view details)

Uploaded CPython 3.6m Windows x86-64

File details

Details for the file cellfinder-0.3.14rc7.tar.gz.

File metadata

  • Download URL: cellfinder-0.3.14rc7.tar.gz
  • Upload date:
  • Size: 606.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc7.tar.gz
Algorithm Hash digest
SHA256 2a4a8bce49230f6893d49873800d2adb172e8d7b2bf89c289c25cb63d15fb616
MD5 be4fbf54f008482a4850bb47c046b21d
BLAKE2b-256 6b1e9bfe9cdaf12d25f577d48a7ee8d66230c992df1b78ca382a6bb4825354a4

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc7-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc7-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 359.2 kB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1.post20200604 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.14rc7-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 95dd8e324bcffca62e2b80a24237fc5ca39a52110216cb4b1a54e1fe9dc3bfa4
MD5 09f77bb9e79a51f22d489d6b2861e3eb
BLAKE2b-256 8583d6864a089ef0519441681de9d78beae2cdd2ff3bfeddd7a48e26f33a4346

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc7-cp37-cp37m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc7-cp37-cp37m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc7-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 13887addc72b942441b4487dd6d2f7b7056a5fb5bee6ec4f70237737bc7932a7
MD5 6b94c1430d08d995182ac2779de2d720
BLAKE2b-256 815d1d098917afaad8398059abd492972890160f086def68869399456b059e2b

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc7-cp36-cp36m-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc7-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 359.0 kB
  • Tags: CPython 3.6m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1.post20200604 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.14rc7-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 f5111f0f7ab1eb171b5a24ed39c367b05dfd426da963862ee037812e3e99e3d9
MD5 80002e390e8f19bf2df08ad47d2f6885
BLAKE2b-256 f08e57f693c348830aa219e180a774936c6577ae36a3cfed432fb4d935b093d2

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc7-cp36-cp36m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc7-cp36-cp36m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc7-cp36-cp36m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5cf1db2356d19c6ffda4b6c5660fc9d6ef1f87c6d229f07e605edecd07da833f
MD5 4592bffc5ae7391667a358bb042e93e5
BLAKE2b-256 153a03bcf603527c0c3ed56567c588688923c6b2dcbc7e09a6bc9afcb022d75f

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