Skip to main content

Automated 3D cell detection and registration of whole-brain images

Project description

Python Version PyPI Downloads 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. See the documentation for details.

Heatmaps of detected cells:

heatmap

Mapping non-cellular volumes in standard space:

Virus injection site within the superior colliculus.

(Data courtesy of @FedeClaudi and brainrender) injection

Mapping of probe tracks in standard space:

Neuropixels probe in primary visual cortex.

(Data courtesy of @velezmat). injection

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

Uploaded Source

Built Distributions

cellfinder-0.3.15rc0-cp37-cp37m-win_amd64.whl (359.2 kB view details)

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.3.15rc0-cp36-cp36m-win_amd64.whl (359.0 kB view details)

Uploaded CPython 3.6m Windows x86-64

File details

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

File metadata

  • Download URL: cellfinder-0.3.15rc0.tar.gz
  • Upload date:
  • Size: 606.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.15rc0.tar.gz
Algorithm Hash digest
SHA256 eb5590bbf5b6e4e07eaeac21fdb0e1ef740003dd7ecf6135e071557aab9779c4
MD5 f29f493db2db68cf1d2de78f9fb08887
BLAKE2b-256 a558f46e1fa16073442f932cc3455c26b51bc1854a1e38453f717106d9b4cbe5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.15rc0-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 359.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.24.0 setuptools/47.3.0.post20200616 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.15rc0-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 6ec21555d1313b563bda31bfec6a3b91865d1095b67357339bdd40a1b7b75331
MD5 80b9c50c3ab13eb851b782f55c9172a0
BLAKE2b-256 3f9f61f1de041037ad64ac444b4990a979a9495e78936f4d3b9a8bbae03dbf9a

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.15rc0-cp37-cp37m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.15rc0-cp37-cp37m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.15rc0-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 de5581bb38e918876071d66993cc81f72fcd4b9754bbc0712de842f1d87d3567
MD5 5184bffad7687379dc9e2106e491f700
BLAKE2b-256 c7e6631ee9b70a9b89a85b44450960a0f7e82531c77ec2d81f3addce104cf64f

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.15rc0-cp36-cp36m-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.3.15rc0-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 359.0 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.24.0 setuptools/47.3.0.post20200616 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.15rc0-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 1b818ffcd4b1ef4f8aa74faa953f6720dd4bbb0c84421de72d55787649a8c5d2
MD5 52843ed3fb2ec74eae018ed2d9018b4c
BLAKE2b-256 60c4173a73c5750495075f8fddccadba7d5fbc3e3897a7457ba58be0d350cbf8

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.15rc0-cp36-cp36m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.15rc0-cp36-cp36m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.15rc0-cp36-cp36m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f2938b9cc5d3005af0cd2689ea3e5d7d75933812e42a5cc9a04852b2ba994a72
MD5 a9b8c90cb02f7f91ebad7792aae4db11
BLAKE2b-256 5382655b01cdbe1f57d07498dd12e875f1a847b8ca14e8ec3d7d24323f7341a7

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