Skip to main content

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

Project description

Python Version PyPI PyPI 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.

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

Uploaded Source

Built Distributions

cellfinder-0.3.13-cp37-cp37m-win_amd64.whl (381.5 kB view details)

Uploaded CPython 3.7m Windows x86-64

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

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

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

Uploaded CPython 3.7m

cellfinder-0.3.13-cp37-cp37m-macosx_10_9_x86_64.whl (398.1 kB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

cellfinder-0.3.13-cp36-cp36m-win_amd64.whl (381.4 kB view details)

Uploaded CPython 3.6m Windows x86-64

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

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

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

Uploaded CPython 3.6m

cellfinder-0.3.13-cp36-cp36m-macosx_10_9_x86_64.whl (397.7 kB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: cellfinder-0.3.13.tar.gz
  • Upload date:
  • Size: 621.5 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.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.13.tar.gz
Algorithm Hash digest
SHA256 2566f5a0b4c3cf5549a38e73be5335f987c8cad03409358d543a5ac2cbd13b3c
MD5 95c24f270e384d1dfc9aaab99e5e7509
BLAKE2b-256 980aa75d58966cc8a1336a926e64ffb0e8f38a4f72385f916e2d216213ff6da0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 381.5 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.2.0.post20200511 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.13-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 579e501681f1afa6110fda604af65a877277d825f6c46dc649aa8cd902aac1e7
MD5 354cf65421fdabca0286901f51e335a5
BLAKE2b-256 3f3623e0d33096c6bb06fc1909232d5e02febed9802530b07b1177ac4131452f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13-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.46.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.13-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 29e1dfa8a173016a7383c475401160ac95fb52a795cba94a3718fa5b860df99f
MD5 1103d6d6d52e3d144f92a7f929b8e79c
BLAKE2b-256 724b2d54c1b129ce978dc736b7d1d2c664d861abd96eaf794bacaf34d6158d76

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13-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.46.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.13-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 c38e33d148d60c20fd9c968fa6fe5938b149c6bf006c2c242c558a4eb2879349
MD5 1528611fe0e5c0f9bec100f0e7f09a47
BLAKE2b-256 f16e9a2a2bd17fdd71c195fedd0ec56c8022e74603e99f387866d0019329c94e

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.13-cp37-cp37m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.13-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 398.1 kB
  • Tags: CPython 3.7m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0.post20200309 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.13-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 25a0367cd73ad99b1251013813f5ca6a352c28f2446e8e313a6da2a80dee8319
MD5 7e6c8a0d54380f0bc0aba5c4edfd7cfc
BLAKE2b-256 3eee7fa16f308265a995806663d2990ec62bb934200a1ce9d3620a625decd75d

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.13-cp36-cp36m-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.3.13-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 381.4 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.2.0.post20200511 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.13-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 6f0843da66c1bc882d291d617cff3ae34e48c9db23471aa950b50085f7b3b79f
MD5 911afdebc26a5bbb0f64ed7c0e7b63d6
BLAKE2b-256 307725225b90ca40b9bbd8ddcd5ed8a44f25bc3830d11a0ea2ffd6953961fa1b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13-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.46.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.13-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 6fb6c518884cbd6d79485869d6e610d6929292e703c8bfd83070179b5959a1e0
MD5 a41761d49b8724a5e3aa732b09864b18
BLAKE2b-256 1b8ed094fe290a39b3d0425d7a5bf68576a18d0a02a79b848d48faf0e00fe3fb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13-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.46.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.13-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 e888715ce9494ce70b4c702d608ccca90019c0fac6d72517853807ccba58d9e0
MD5 18b36a119a1167cedd1bb6ed599eb342
BLAKE2b-256 461355e82b8dcebd99521910b6b99e8c605f605c9946ea52cd2890744c5c2345

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.13-cp36-cp36m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.13-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 397.7 kB
  • Tags: CPython 3.6m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0.post20200309 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.13-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 7ab6a2a7dfe77e6cf04f06f19d65b2a72ee5f6179df9bd4dc4477b30a54fa8cc
MD5 416501452215bb5700a81de969b827d0
BLAKE2b-256 0e4dde8c5c920be78dd94026ef15cb433855405eb3638114a4e87d4229b17a01

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