Skip to main content

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

Project description

Python Version PyPI Wheel Development Status Travis Coverage Status Dependabot Status Code style: black Gitter DOI Generic badge

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.

Heatmaps of detected cells:

heatmap

Mapping non-cellular volumes in standard space:

injection Virus injection site within the superior colliculus. (Data courtesy of @FedeClaudi and brainrender)

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

Uploaded Source

Built Distributions

cellfinder-0.3.12rc8-cp37-cp37m-win_amd64.whl (382.2 kB view details)

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.3.12rc8-cp37-cp37m-manylinux2010_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.7m manylinux: glibc 2.12+ x86-64

cellfinder-0.3.12rc8-cp37-cp37m-manylinux1_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.7m

cellfinder-0.3.12rc8-cp37-cp37m-macosx_10_9_x86_64.whl (398.8 kB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

cellfinder-0.3.12rc8-cp36-cp36m-win_amd64.whl (382.1 kB view details)

Uploaded CPython 3.6m Windows x86-64

cellfinder-0.3.12rc8-cp36-cp36m-manylinux2010_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.6m manylinux: glibc 2.12+ x86-64

cellfinder-0.3.12rc8-cp36-cp36m-manylinux1_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.6m

cellfinder-0.3.12rc8-cp36-cp36m-macosx_10_9_x86_64.whl (398.5 kB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

File details

Details for the file cellfinder-0.3.12rc8.tar.gz.

File metadata

  • Download URL: cellfinder-0.3.12rc8.tar.gz
  • Upload date:
  • Size: 611.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.45.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.12rc8.tar.gz
Algorithm Hash digest
SHA256 f98af62e0f19327fac7a4946aef60b8ad2b95c7cc11194480456e255d0b519f3
MD5 180d017bb967af2edacd34a179720635
BLAKE2b-256 4b069d93c897a6024c4e269222ba6cc47b95b6ac170ced1a60aa03edab7b6cad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc8-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 382.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.23.0 setuptools/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.12rc8-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 0608488ec62eaf043dca6c4b092111ecc2504005c624434af1ec59dd5aadb386
MD5 fd1976324758c22cf6d7598c5370c11e
BLAKE2b-256 181f00262a765ee709ef1a5e99daaa236f4c65966abe62a7065ab62e467ee4a9

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.12rc8-cp37-cp37m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.12rc8-cp37-cp37m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: CPython 3.7m, manylinux: glibc 2.12+ x86-64
  • 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.45.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.12rc8-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 59ea96b3d526286071fa1fd79a29e0de0f5b7d41c5334e3a1d181c92d1c21407
MD5 6b3d00ba243ba993868209f0b5c749eb
BLAKE2b-256 37ac00b45d927cfa887af6b9384dd9206207c512dccc93d105250b680dd0b3d0

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.12rc8-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.12rc8-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 2.3 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.45.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.12rc8-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 ed9b6ed4a7c19ce20a5ada607e512097918ceb5ccc1a7e4b43c7911a9e40c65b
MD5 11a310b1c6b5d0e3eb5b967ad3ebb915
BLAKE2b-256 21b675315074351e461bba918104f850dbd1140ff54f8e1c4b4ad4834c3a62de

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.12rc8-cp37-cp37m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.12rc8-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 398.8 kB
  • Tags: CPython 3.7m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.12rc8-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 ba46b047f3a7c3e387b554d8670467db157d16daec87ea8f9572f8d0d97a2703
MD5 a8757ce80f026137411d17a751c1c447
BLAKE2b-256 5a510fe1828f56fa04945b2724191b06fa5f275a732cf5ad87b03285500ca123

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12rc8-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 382.1 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/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.12rc8-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 686f60d1c785e1b6aa7d21330a296c1d262155c2d18c6be5632459846be5d01e
MD5 a75b997289f4c6365365a857a41f706c
BLAKE2b-256 32874c5d0c3bbde4ae490cef5efb6bf7099002f88ee65e2e0263d48690f5f484

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.12rc8-cp36-cp36m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.12rc8-cp36-cp36m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: CPython 3.6m, manylinux: glibc 2.12+ x86-64
  • 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.45.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.12rc8-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 ae6831aeb2963a5f803d2cad7cf6d78bcf8ee0853716d89fc0b897c48d53fb08
MD5 55b7e1dc9fd52a4e8363ecc93c32b946
BLAKE2b-256 54d8c52aba4f98b898ce93c27ddedc254df859661f580d6df2f3f6d5c3557b79

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.12rc8-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.12rc8-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 2.3 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.45.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.12rc8-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 cd263b9e4629e6b2754e428df9e2b84a232286bc82e521fdd9a601413450e5c1
MD5 aaa64aadf189701b4e546de4759a77db
BLAKE2b-256 4cd1b477db3f062467a5fd3f7b676349779fe61e7a9837a4f92adef8a2151270

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.12rc8-cp36-cp36m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.12rc8-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 398.5 kB
  • Tags: CPython 3.6m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.12rc8-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 1ce95f0adac64b3271499fce86881ea58219a7db7b85ca6d23657fc25e842ffe
MD5 f9ef19cfb143799e435124dc97e6f747
BLAKE2b-256 c0fe7b72313b2337916b3f522cde7bb03cd38a773b3ac95cb6d4a7a0ef14f69f

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