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

Uploaded Source

Built Distributions

cellfinder-0.3.12rc0-cp37-cp37m-win_amd64.whl (387.3 kB view details)

Uploaded CPython 3.7m Windows x86-64

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

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

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

Uploaded CPython 3.7m

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc0.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.12rc0.tar.gz
Algorithm Hash digest
SHA256 431f2aaa384851828b5dcf01fb7cd4f4365f2346b018951552b493b6d02ffc3d
MD5 1f8b7b184176a504c6e13881f586f081
BLAKE2b-256 3e4b0932a265ffb7fc114c0d709a1eaccd6e702c0994e966589863784793cfd2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc0-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 387.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.45.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.12rc0-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 946fbf8a5dcc3c97902cfe7b4b02c4143eafad4affb382e0005277a7cc186f29
MD5 5694f92ea88524ad20681533e5c37422
BLAKE2b-256 b4d0f0e5b820f409ff70e042f5e659001fcb1b9644929214ebd9b341199a9758

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc0-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.12rc0-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 08da4c9cf09cdf25782d688822091dd0f440d0245b0d62eee90d3b322b192c2d
MD5 76b3c2f675ebe2c5a9f021bccdf902db
BLAKE2b-256 39f505db6b4d505a2fd6b4b988198d8309aa4b17077827f0ed455c9cb325885f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc0-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.12rc0-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 38f04e39e5fff1646705d1c1d6ff23a2a7fe9ea669d50efac1bfadcf3d900a33
MD5 9dceb8f716960e8bacde2671c318c106
BLAKE2b-256 7a9fd4e62f1c862410d77befcc4ac178c1ee88d0d8611550e25659c9741724a0

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