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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.8 Windows x86-64

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

Uploaded CPython 3.8

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

Uploaded CPython 3.7m Windows x86-64

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

Uploaded CPython 3.7m

File details

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

File metadata

  • Download URL: cellfinder-0.4.2.tar.gz
  • Upload date:
  • Size: 148.0 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.2.tar.gz
Algorithm Hash digest
SHA256 eec49838644e869d7ed9922e24b37359890147b3de6dccbe0560fbdf836e8672
MD5 f2aa3e1092e32acb07b49e949f96ccb8
BLAKE2b-256 116c20645e8fa1bf3b504dec702c164749ea478c74563626e410e2b19a0b30a6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.2-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.2-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 9657db42dc9aa0a41da6dee943f4dbaa3656da4511dc32da1fe0bb3821ab7b1d
MD5 f6a96e061e9d27f7fdadeacae07eb10b
BLAKE2b-256 bd752019561a9e4ef61ccbecfeb700faf3c164120e1680fa6f3f12145cd69354

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.2-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.2-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 51f123486a42b37ae7e55778a0033408745bd5c83cddd20ab8f61dc37b538aa6
MD5 299691ecd547b5decfb1a2d539eba682
BLAKE2b-256 67487978971f6e78416a85580458b21fce523dbb3c10b88022dca8d338e66483

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.2-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.2-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 2881d9f285ddcaabd0b5ac5603c29575b32f1572aee68657a9d01067587cfa03
MD5 4f2a80a9d6059184affb10aefe8ef753
BLAKE2b-256 f9f8fa91e9a8484d4689af620da39bed807656505e4e0e795ea9dba3cb246746

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.2-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.2-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 62ebc1f79817452f4c5e940fc8de059e4cf23bac9a9d217a7fc3884097c300de
MD5 134c6ae10379bf011f4ffa5cb2f371cc
BLAKE2b-256 693422ba778fe0b3af53e0eff8d2cf8ca2c6588a5ad2a7b670cd40908d84b975

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