Skip to main content

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

Project description

Python Version PyPI PyPI 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.

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

Uploaded Source

Built Distributions

cellfinder-0.3.14rc0-cp37-cp37m-win_amd64.whl (383.7 kB view details)

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.3.14rc0-cp37-cp37m-manylinux2010_x86_64.whl (2.3 MB view details)

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

cellfinder-0.3.14rc0-cp37-cp37m-manylinux1_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.7m

cellfinder-0.3.14rc0-cp36-cp36m-win_amd64.whl (383.6 kB view details)

Uploaded CPython 3.6m Windows x86-64

cellfinder-0.3.14rc0-cp36-cp36m-manylinux2010_x86_64.whl (2.3 MB view details)

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

cellfinder-0.3.14rc0-cp36-cp36m-manylinux1_x86_64.whl (2.3 MB view details)

Uploaded CPython 3.6m

File details

Details for the file cellfinder-0.3.14rc0.tar.gz.

File metadata

  • Download URL: cellfinder-0.3.14rc0.tar.gz
  • Upload date:
  • Size: 623.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.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc0.tar.gz
Algorithm Hash digest
SHA256 0fa76fb8d523704ec8de417f40b58283e8deaca49fb4b07f0872f2343cdb0e16
MD5 4867884f294ed9369c16a439450710b7
BLAKE2b-256 c94e39cddd507c42e4b4c20db84622b5f07291a0a969f39a9461905be78b6b56

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc0-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 383.7 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.2.0.post20200511 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.14rc0-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 d3905321b429dcdfd09e3e61a813f53381c7e796b62f9581ea770733602631b3
MD5 0927d7f28e23cbb11a29cf6c55fae395
BLAKE2b-256 c027f0fa0c00cc67fe476672d60d6578b6e71ba8379238c5224a2b4a74b9dcb1

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc0-cp37-cp37m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc0-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.46.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc0-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 e367c126d9b00cf92f3bd40a14650c9fb8bbbd98579888f7fbfe2b85c36c91d2
MD5 966c2fb34564778e86d876bceed5bcb3
BLAKE2b-256 be95b956091c791eafa4aa556489f2c1a8abbc88f52b0c966870ec57afd03d4f

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc0-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc0-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.46.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc0-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 abade9701dfc2a22961a1c121944f7af8a2b931343290bcda2197e8a86edc85d
MD5 76763e99a4d19fad2f2fd28ad5692036
BLAKE2b-256 e40ae25fb7ec2dc67b58ab443d75db2c610519f84846352be3f2ab38f849d7d6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc0-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 383.6 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.2.0.post20200511 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.14rc0-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 00766d65479f09ff098ca7958300702f98cf85d9efb63278db80d74a281c46dd
MD5 fc246cacf9d496619f9b5ca6c9a0301b
BLAKE2b-256 af07bd6068d07860c66d0607d98089432475d83a692b3b07fd5071934fdf0baa

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc0-cp36-cp36m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc0-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.46.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc0-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 cb737d4a3551195af97e30a8edc222a491d7661e115a8bf699185ac51347f82b
MD5 58315f84a19a1c9e980f0e9b95bf7806
BLAKE2b-256 792198b97cc0e326e3b9d967f21d285de7e5ebe317d2e93afec4d0097a9ec6b9

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14rc0-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.14rc0-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.46.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc0-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 bcd28f536f7ba4844bc49f46e7fdac694768abf1246f7677f3be9f8a84a339a5
MD5 aa7efd10059edb0a6ce3784a9c334cbc
BLAKE2b-256 6f784978b8cd21167da21132995be71b8fe62cc007dcde5da76caa613294b69d

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