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 brainreg)
  • 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 (brainreg)

Using brainreg, 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

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. 10.5281/zenodo.3891338

If you use any of the image registration functions in cellfinder, please also cite brainreg.

If you use this, or any other tools in the brainglobe suite, please let us know, and we'd be happy to promote your paper/talk etc.

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.4.1.tar.gz (147.9 kB view details)

Uploaded Source

Built Distributions

cellfinder-0.4.1-cp38-cp38-win_amd64.whl (344.9 kB view details)

Uploaded CPython 3.8 Windows x86-64

cellfinder-0.4.1-cp38-cp38-manylinux2014_x86_64.whl (2.0 MB view details)

Uploaded CPython 3.8

cellfinder-0.4.1-cp37-cp37m-win_amd64.whl (337.0 kB view details)

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.4.1-cp37-cp37m-manylinux2014_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.7m

File details

Details for the file cellfinder-0.4.1.tar.gz.

File metadata

  • Download URL: cellfinder-0.4.1.tar.gz
  • Upload date:
  • Size: 147.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.1.tar.gz
Algorithm Hash digest
SHA256 b964fc238a51c434ed4a4cf3d234dc55292cd5c5d47d5625523107ac73b6e816
MD5 2fcb5cfbb486db2f48a288765a00f036
BLAKE2b-256 b85b14dd6f1afa4bf08763d4fef998bda2e9298c91e4372d2a8721dc0b1bf227

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.1-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.4.1-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 344.9 kB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

Hashes for cellfinder-0.4.1-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 3fa684e07f044568c3b733bb9a6b02217690260785963598560d26bcf474d918
MD5 c097aebe970905930be4d6250b76bac6
BLAKE2b-256 e45a8932d4c4a8f05c4a682c96e71b266c399f95e5b6e20705413d124a0fcd65

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.1-cp38-cp38-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.4.1-cp38-cp38-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.1-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 368b58a188253ec5d37e05d553bb3e7b82a153199b0b03c5a08ac6ca3d216da2
MD5 64b747e07bc1425f64d1a005be981a4a
BLAKE2b-256 ab26c5c10670ca5dfd23fab9d6de32cd9f56456618f7a69ec91a1acab97ba580

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.1-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.4.1-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 337.0 kB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.9

File hashes

Hashes for cellfinder-0.4.1-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 e9d414003fa0fe5c702bf9f44e137e39595baed62e6254ce27199461c73268a3
MD5 392e77ff6bd134684b54f183f9e8bf58
BLAKE2b-256 5adf30bccf32015226242d2e15e1db4eb71ff758cb43f3c9523cd395d19d4d48

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.1-cp37-cp37m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.4.1-cp37-cp37m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.1-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b61b3b7e41bc01c79f2634bc43b2b9752bc6535dea009e4cf2a48ced7b83f72d
MD5 21ac6e24d5f38fac46555d4662908c0f
BLAKE2b-256 e43f37b6240a3f1de0b797856cd989f3e5b1a70076d15196462f6ec90740b75c

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