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

Uploaded Source

Built Distributions

cellfinder-0.3.12rc7-cp37-cp37m-win_amd64.whl (382.2 kB view details)

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.3.12rc7-cp37-cp37m-manylinux2010_x86_64.whl (2.3 MB view details)

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

cellfinder-0.3.12rc7-cp37-cp37m-manylinux1_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.7m

cellfinder-0.3.12rc7-cp36-cp36m-win_amd64.whl (382.1 kB view details)

Uploaded CPython 3.6m Windows x86-64

cellfinder-0.3.12rc7-cp36-cp36m-manylinux2010_x86_64.whl (2.3 MB view details)

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

cellfinder-0.3.12rc7-cp36-cp36m-manylinux1_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.6m

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc7.tar.gz
  • Upload date:
  • Size: 611.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.45.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.12rc7.tar.gz
Algorithm Hash digest
SHA256 d7c6ecf87c64fc27b86bac898fb28b8a55fa6b90899467447b581743ba470686
MD5 a5b5f8597a181ad1827da8334eeee1c2
BLAKE2b-256 bf69feeee4fe7b76df9e54f097fe541ba2ad7dfff28be53530248b9fb8a7ff8f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc7-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 382.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/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.12rc7-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 3a595825c53c4be9b09325cb10800bfaed2dc2fd2635d0f32e36c29b2ea1179b
MD5 f63de65fa9e8ed264303ccfeecba6a07
BLAKE2b-256 5f019bab858a47540f7162154ffd28865d6cc00be61b8b2deb16847bef05435e

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.12rc7-cp37-cp37m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.12rc7-cp37-cp37m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 2.3 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.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.12rc7-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 2b4478227446a264ac75b159842aae3bc8ea58ed2f32248fb77d2b72469878ce
MD5 71d0c89088b840b5523092838fd704c6
BLAKE2b-256 5e5388796602805adf71d2ff6606fdad946b85e5bf5cce26b8b19d4dc2dde2a4

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.12rc7-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.12rc7-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 2.3 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.45.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.12rc7-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 b00ee4db52b47ada7d6e9508f35bc0805d289d4c11a44774ef20284892a5d8f9
MD5 d35e2810e0e637993996f3d34649da8c
BLAKE2b-256 c27c39f612e91147461f2bd954d6309a0d5aff8d4024e859170e8c117ff0620c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc7-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 382.1 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/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.12rc7-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 74860fbb178ee63ff332c6c72441fd73c20139d704968077fa9a7cefcbb664fd
MD5 9e896073085585b49bfe29a901f6dd1f
BLAKE2b-256 e110ff30bd64c3fd9b010ed3727a95c38026adc09108312b4568354d89344458

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.12rc7-cp36-cp36m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.12rc7-cp36-cp36m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 2.3 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.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.12rc7-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 5e2dfb87124b98d92dad2b2dea68d89e1140dd6c8051fbea8730eff648e654ef
MD5 2de8a061e549e8c63f59d824e7d4fc1d
BLAKE2b-256 066eb66e39a5bfc0847cb1efbade0704f5ba3b5cad9e92c3bae80e15f9e33ef1

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.12rc7-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.12rc7-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 2.3 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.45.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.12rc7-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 2804bef43ea544bfce0e285ce40bce71200565b276585aac6a20070cb93e1e59
MD5 423abe21b22b0faf7f50e21dd3abfe48
BLAKE2b-256 72271aa77269cbd6bc12ca120d85893dd0244d5eff808b1d45239a82e5728fa5

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