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

Uploaded Source

Built Distributions

cellfinder-0.3.9rc1-cp37-cp37m-manylinux2010_x86_64.whl (1.7 MB view details)

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

cellfinder-0.3.9rc1-cp37-cp37m-manylinux1_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.7m

cellfinder-0.3.9rc1-cp36-cp36m-manylinux2010_x86_64.whl (1.7 MB view details)

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

cellfinder-0.3.9rc1-cp36-cp36m-manylinux1_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.6m

File details

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

File metadata

  • Download URL: cellfinder-0.3.9rc1.tar.gz
  • Upload date:
  • Size: 158.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.43.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.9rc1.tar.gz
Algorithm Hash digest
SHA256 42ed72fe52c15b6e8559acf008a7728ce20b7e46401daf13be751b13464b91e1
MD5 c70f9919c13f4aad1064eb59985cb022
BLAKE2b-256 9bb33ebcb73c6137a97beb52fefd3a2e6be8da503c72be966c25880bd9405da7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.9rc1-cp37-cp37m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 1.7 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.43.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.9rc1-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 e268b134dbe6a5b155aaf48e2e3517248fdd7a27f246088a4567feb2a8eb6229
MD5 8ab073285d7964ac96b818d636bea78d
BLAKE2b-256 042303da4c8626c0ffc7213598044f4af9c49b5e4944863724dbd917058999bc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.9rc1-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 1.7 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.43.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.9rc1-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 59b6d45fd017aff78842f894d0d60eee3b6ce45b0b13ee17277689cd999c89c9
MD5 7f006ad05b47383c365b506d5d05852a
BLAKE2b-256 7fc2224c6dcc1ecf238e29133c8b0e50933e0a1510188fbdf1b5406c65d6fd61

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.9rc1-cp36-cp36m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 1.7 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.43.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.9rc1-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 2b5c7e7489beacce5cb7f9a057c23dc60293b54c9e06fa88cfe52c02b02e7a7b
MD5 2ed00cf768e61d63263b25d89b2d49c9
BLAKE2b-256 87806c782304cd6a36d15c574bca77b6cef2d5eb4491330d080665c110188d62

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.9rc1-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 1.7 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.43.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.9rc1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 e00c8eadab3c5fc4f2ed114bff8aee29fa0dab572ac07584dcbb1e6f7a5de241
MD5 aca8bc20f08598d944f9ea9c64b5b2c3
BLAKE2b-256 f46be8de78377cac1aba35f92eb29eab221e11f46cc57f035d97ec976c3f256e

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