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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7m Windows x86-64

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

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

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

Uploaded CPython 3.7m macOS 10.9+ x86-64

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

Uploaded CPython 3.6m Windows x86-64

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

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

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

Uploaded CPython 3.6m macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc1.tar.gz
  • Upload date:
  • Size: 622.3 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.13rc1.tar.gz
Algorithm Hash digest
SHA256 edf33e12291ac1366096aeec836a711f75079de61f085ee1d8029073a4d31ac7
MD5 688bdbae97a70d6af7a8230d5c573ace
BLAKE2b-256 70aa06f5f68c07f39ffad737ed81a61e630b89ba3fd3a57339e4ae875933ac63

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc1-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 382.3 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.46.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.13rc1-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 b58c0e69e1800ceee1d0f7bb69d2df03018d1d9c89e3176ad19bf68d4ecc9aca
MD5 82b10cf5d0b393370532d0bd98c293b2
BLAKE2b-256 23f3951cd6379763d507686e2c28b1a3a9828f74fb5d6271b44d7839434b2fd5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc1-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.13rc1-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 8c451a94afaa3349deee717e7cbeb7fb3e5d4db84ca6428875a663d362b4d880
MD5 ad666af0802a5e08069659d977055c6b
BLAKE2b-256 654c8e5c2793b2d2fb13cc61d7b720317f958be5029e601b2c34798312d328a0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc1-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.13rc1-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 862ae3727cfccfad0b0afe4ce5e632ff5dcd45463e8fd2221062ee23d66fba45
MD5 287569c471df0a225d20ef3faf02cac2
BLAKE2b-256 5f77bff24148d51b88aaa374eacf6e9252e69e40c1159edb4a7462ed73e5fb0c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc1-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 398.9 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.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.13rc1-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 784f2cdccc1d14cd9248a142a07be8961a6e845202ad622e002f326a6f8d2082
MD5 9235f701713cba782f196de77860666c
BLAKE2b-256 76ab7c96f1c2f93c6a5e0bf4cb3e5eea3f32f6670383e2875377f26686839507

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc1-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 382.2 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.46.0 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.13rc1-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 eab3a240fc246aaa5af2a8aa3835754bc1b4d8525464d7db83df825fb22c2d74
MD5 f7105e4dce51f5dfd689b0201cb4e682
BLAKE2b-256 b8573ad246cee820cc413f21ff2e3f21e7bb0e08bb9ffb469dce69d95e2bca5d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc1-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.13rc1-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 7e91be3051fb83e8c24d98c98795be95a11855cc3b2890c3f3454bad6c90a6c2
MD5 9e52541411772b0b1add16f1cbc5891c
BLAKE2b-256 a927c74fa60e53ef61b809bd4b122d7373e4ea5d57cc8e8f3250c3d5ed38c875

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc1-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.13rc1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 d1551affc13f1c1e32340514c4c63314dea6fe668d96eddeed63600faf0cc0e9
MD5 c84a8008a14cf4ca14d6153bfa28efa4
BLAKE2b-256 c2ed8868997c24da75fac329db89de0b438062b0ab196b9158216d91719ada67

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc1-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 398.5 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.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.13rc1-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 5794157cd25749ed9a51d6916b2317158ff54626cbbc021456edd4bfc7a66793
MD5 04b4e18926fca677581b536a1758ba51
BLAKE2b-256 0dc6a8aaf4a39c4322a4f06182efe5b933e396f1e4a63de2f7da75d9372fb993

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