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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7m Windows x86-64

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

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

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

Uploaded CPython 3.7m

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

Uploaded CPython 3.7m macOS 10.9+ x86-64

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

Uploaded CPython 3.6m Windows x86-64

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

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

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

Uploaded CPython 3.6m

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

Uploaded CPython 3.6m macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc2.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.13rc2.tar.gz
Algorithm Hash digest
SHA256 bccb0563eee1271a59dbf7351298962ada0c1850530fa2d67254e387071f349d
MD5 5e8c7351cd3a401d13eb1a08a827281c
BLAKE2b-256 6e54e8a74479a765780cbce0b2a6242987a8ccecf624a8f7bcc8f25bbf75e5ad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc2-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 382.4 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.13rc2-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 ce00568ba23639ec9d8ec2fca3a5ad46008662807f62669648125ff166963a58
MD5 1ffa8aa38cd89c5a64fa154b49ea0a82
BLAKE2b-256 f1580026b69f2ae2cde7d9b1951d6f74be0cb0c46f967cb95404898e9fa9fa63

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc2-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.13rc2-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 a6e39270d6e9d386735c189736dc3f221e732718242c87aecf9e0787e1f5cd69
MD5 5bc0fbfc5967bf7d2c14588223616e62
BLAKE2b-256 11857ba2c4acdc2f17cd5d6f8f7de7e2c0f16e1a59217eccb85131a6d6919da9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc2-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.13rc2-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 040f10f09344360724a8c5de802773952de47ff30f44dfdca7e5b5628e5e2010
MD5 48941bce58378b68eab4979fad8bc7a7
BLAKE2b-256 f4a2668d6724101923d51856b29e10e0c37bd96c9bac8b2840633eb86fcd223f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc2-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 399.0 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.13rc2-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 3b7d1a65f6401116f747b3277f79e2bdd9e40cca540a1d0d4672030bb1edf4be
MD5 a91667eb388574af6c144b66a78d8754
BLAKE2b-256 0afec2e738bd430fc48014276a62d61d04aa632f2934e02eb279b750d2b56af5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc2-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 382.3 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.13rc2-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 6d7a8510c4e51e1bb697d7fcc07cc137ea7fbc46627f908888a2748a7e6e731a
MD5 9d87c36a501befb00c3fcf4d5fe70696
BLAKE2b-256 0fef7f1e5ac453baf4bac1d18775b7a56458024366eb93798d6fb6397167bc18

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc2-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.13rc2-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 a46900ec3b6c52791e5bc8d0549b72c47439df8e49a32003621b067db558cc7b
MD5 047fe74f3d11d7ee36bf50b77d5f7fc2
BLAKE2b-256 ddb01f5be3f033100eb4a6db7efb3a9d214f0c6a0c0db197b6256ab3a20d3b52

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc2-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.13rc2-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 46057597db38ba761ad90f856f82e660e7bf79b2958375b96bc235739b8af12f
MD5 406e62fcc971e48bcd649ddd4807c6e2
BLAKE2b-256 071cbaa96a4d0c4e6536255b1ebc6b19e67d7e980c635bf56fe1e454b2655bed

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc2-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 398.6 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.13rc2-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 9238eea0887c956fddec94fd20dce23a3e83acc0ad9a19bae8903476382a466e
MD5 db24e322a270076a231a7583eb39984a
BLAKE2b-256 043c9836d8a62ec71f200393d891497b744475069b0f6282e3c741f329b614d9

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