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

Uploaded Source

Built Distributions

cellfinder-0.3.14rc8-cp37-cp37m-win_amd64.whl (359.1 kB view details)

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.3.14rc8-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.14rc8.tar.gz.

File metadata

  • Download URL: cellfinder-0.3.14rc8.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.23.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.14rc8.tar.gz
Algorithm Hash digest
SHA256 409affb743072152bacc52e5f5f9c2cfe52dd08738b07702621f24e0807aedd0
MD5 37d582520f987c439c092360ee56e9e2
BLAKE2b-256 55521950af95f0d49976d695c3d9de3dfddc3007f44aeb77933577efce594c6d

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc8-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc8-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 359.1 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/47.1.1.post20200604 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.14rc8-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 f4a78ce9b4bfbf99dc2dabf9788ffebf8091c09a41c28510b54db9a4a5a010ad
MD5 da55a69e403915e9a6266df81461f220
BLAKE2b-256 76308a5d61c4b7457d04d2a9efaeb8ca8af8310cabfc733a05d3dffd9df933db

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc8-cp37-cp37m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc8-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.23.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.14rc8-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 6c5387c4a7b5ea07d925b8eb251e9d8a114f463df74b731d9e61ec4e1a446dd8
MD5 7cd430bcf1342b6a7137e5da0607fc8f
BLAKE2b-256 d46672b68efc6a0237d5a671d413ef48151f7c34d54d2fd09cf09f02f31d4170

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc8-cp36-cp36m-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc8-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.23.0 setuptools/47.1.1.post20200604 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.14rc8-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 a6fa9f7907d9438f2b41d5a7076580c640a10302718abef97fc34d78d3ad1a4a
MD5 f788afbc89d54a9cb6bc2342c6d7c4e3
BLAKE2b-256 fc470e4422f3159332a958f762cdd255eb1a31c13604a1d74119a43f3c6ede6d

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc8-cp36-cp36m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc8-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.23.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.14rc8-cp36-cp36m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 533d24c12f5b8044428f857ecfc211f457f4436232c78192ce00b6a1b88bbb36
MD5 794b3b7075c79abf84e441d7bce81eff
BLAKE2b-256 32df01704bf0d599ff4b9e232cdf5ece92905d690046671187394612a031da7e

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