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 the preprint outlining the cell detection algorithm:

Tyson, A. L., Rousseau, C. V., Niedworok, C. J., Keshavarzi, S., Tsitoura, C. and Margrie, T. W. (2020) “A deep learning algorithm for 3D cell detection in whole mouse brain image datasets’ bioRxiv, doi.org/10.1101/2020.10.21.348771

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

Uploaded Source

Built Distributions

cellfinder-0.4.5-cp38-cp38-win_amd64.whl (344.8 kB view details)

Uploaded CPython 3.8 Windows x86-64

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

Uploaded CPython 3.8

cellfinder-0.4.5-cp37-cp37m-win_amd64.whl (336.9 kB view details)

Uploaded CPython 3.7m Windows x86-64

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

Uploaded CPython 3.7m

File details

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

File metadata

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

File hashes

Hashes for cellfinder-0.4.5.tar.gz
Algorithm Hash digest
SHA256 80692032f4bbdfa733f596af35513c69ebcd217506f56adaa014c57264dcc8c4
MD5 b4c29838a50482ab9bfc4fe9b6e6dea6
BLAKE2b-256 3d8d9efcb68ab47a6f4e4a3188c7f7345956c84347c584d86a548df7a7f83ab4

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cellfinder-0.4.5-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 1ca78e75dd3c5c2ecdc72f3d2a222700cf5f2a10943b1062f2b2ab0540d3cd05
MD5 8c8a26fec36dd94866de9a09c87d7c94
BLAKE2b-256 64f7a3b192e1d4936e3a0487ae2b2e0c2880980884543edcd89cb7f7fb73f1ed

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.5-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.6.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.5-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ae8879f5a1caea34b3a23657ac621cf13ddce050f8d1195bf2c33c7e571911ea
MD5 689ac976ccf05e2f89f901fad37f239d
BLAKE2b-256 b3f38fd4ee751f16d9ffe266076993763d2109de600fac66d7271c42b9d184db

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cellfinder-0.4.5-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 298b957f5214be72b21f4cd78d0740b191a5e05293ff626c754fabd0dbe55687
MD5 5fd538dc1459e6909e726ca31abaec6b
BLAKE2b-256 bb200d15e231e5614c77887246f5c427e5a65cb6faab47facf376ac129e61a74

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.5-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.6.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.5-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 abdfdc88b42ccb62887ea547aef10f5edfe58feaaea1003d5f462c30d7f922ca
MD5 4ba7e103144d0be98f332aff24c1346f
BLAKE2b-256 8be3e68f778fd1ed427fd80f4de33770aeda03edd373d2ad03d73964b6643955

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