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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7m Windows x86-64

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

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

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

Uploaded CPython 3.7m

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

Uploaded CPython 3.6m Windows x86-64

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

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

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

Uploaded CPython 3.6m

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc5.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.12rc5.tar.gz
Algorithm Hash digest
SHA256 98596a4890fc5875a9ce3f5c0422a8f9993376c4cb7d1f97bfed4c0c2d88e837
MD5 ded46782ed4a090640c4e4137a1f54ea
BLAKE2b-256 a44609e7e44366f4a80f1b8faf0ebea6a17fc95878276e6d55283c90e30b85e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc5-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.12rc5-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 d8fe10c16aa7ec34c81cdefc19eab9bd894e6030d2abab3b5b83ff1f7d151496
MD5 a7665ee486fecc4a62b5f4501572af9e
BLAKE2b-256 6372598012e5eda40c8e6fbeb303d94af0054ba86048a6f66102e8ca80a551b0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc5-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.12rc5-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 dca160fc8e4bbcf56d532b91a3717186e0626485ebeba06c1bb07618101fe82d
MD5 eda084594319fdb0d111e13852b2ba0f
BLAKE2b-256 cddad8bc6d7719e382662dc5766ab31424a368818c2e367bde38d21e8d7862c4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc5-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.12rc5-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 4c1451e87a3f7bf13d48a928089d380746ab2393ad4469542633aae176071223
MD5 570416e17a533afbd6401991fcfa000c
BLAKE2b-256 5497c92e9139df0879f6f2d57f0a5454573a795c0aa3b4687183088df26ae1a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc5-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.12rc5-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 0adc151f66ccf7cfc8d4242c9927754b75b65e4a1f1b1ee3270f323726b0d881
MD5 b07e6ddda8e06ab493d69eaee7ab1a4a
BLAKE2b-256 85184b21485e3c7b54fee3d26575d21d669d90ebefa2b44c37df4553a984283b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc5-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.12rc5-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 51dff0edfe9e740d89ebe5826d43de86f092a7d4371a0f63f59a8ef95f4e7e93
MD5 22a0b87504419f332fd7d99f60fffb5d
BLAKE2b-256 e5fa4d930070ea253b9dba8a8ac814ff00942bcfc8838c05a7303183b8571dec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc5-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.12rc5-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 6f02969a9eb1fe2222bc4a984ce5a82bb1b72769c018ba7dea45ea0dc19542ca
MD5 28b167f61e4ecaf682cd21e984dc52c8
BLAKE2b-256 db112d5261e7cae692b03b3f0a1bbea367e1ca990a9c9812cf82537a268f0eff

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