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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7m Windows x86-64

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

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

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

Uploaded CPython 3.7m

cellfinder-0.3.12-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.12-cp36-cp36m-win_amd64.whl (382.1 kB view details)

Uploaded CPython 3.6m Windows x86-64

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

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

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

Uploaded CPython 3.6m

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

Uploaded CPython 3.6m macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: cellfinder-0.3.12.tar.gz
  • Upload date:
  • Size: 610.8 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.12.tar.gz
Algorithm Hash digest
SHA256 49546cb62fde842aa6b9fd719b3a8095e021cd7dee9a0fbd1881d6fd5f1ec0c4
MD5 c4fb4718c04addd9854cee7bda40ab01
BLAKE2b-256 1fef1332107f74ef182381fff199f194725404c2ad9ed04f4354e1a3fe654d0c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12-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.12-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 050fd017d4467c2552841d47d6e8bc5f54452dc1568590efb056fabd34e647a9
MD5 4386e8f3ea291f711dfe230007e537db
BLAKE2b-256 71d61aa5bc821ccc9e4a902740651b03535c579049bd7244cdb4ee55c6aa43dd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12-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.12-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 13324da4340da797b0b09914e60eb76dc0d73199c9adacc662e34dabbc75c280
MD5 e1578964be3e8b8b32057a4349249e24
BLAKE2b-256 c7564d7505f0412468f4dfd7b09ec02f4290da920df605b190411d3f5cc16375

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12-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.12-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 89ba8b7a2039284a41dae399bbf218cb5d3a951cf6a07f18c3384ad500834926
MD5 600a42c5c8f59e4b4699ba611776aa2b
BLAKE2b-256 1536ae99f74da147c8597a64655f765467cae45bb99daf0ae3148b20616847cf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12-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.12-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 abaf6763678e13bbd16ad571c943d48b8c3e6863676cd870cc4d9f71eac73820
MD5 a517584e8228e73519cc32f7e24db959
BLAKE2b-256 b6f5ef01391532099fa66ca7a7dfa99ac19be05a4a07014051c06dc047d4cc3a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12-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.12-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 fdf00f8348827447b4417c8fcc2f3c0888aa6c3571e0728be2dba7cf87998015
MD5 1fd2c89c52541e67bd46a650897277f4
BLAKE2b-256 65e7d2bd33e63dc749a6d5427495f27f98d2bb8bf14c99ccd6d91b4262b880cf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12-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.12-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 5de5a360fc45d14daa84c0d36934904229381fddc2053610c409d99c3b539d1c
MD5 46635df555e2b08b3368389240bfed6e
BLAKE2b-256 71aaf14f9ce7679ce098ed4d1ea25479b33594c629cd32f5a97e74788641e44b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12-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.12-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 0df09778591650846fd9aa2a132bed7ab38b8f347a4de23ac2bf8631f62f208c
MD5 9ea9b82fb8e2e60c37c91e2f46f88890
BLAKE2b-256 a1cb8558af6407bd67600d4c10372bc09fca4f50b9d3dcfdf5278b7211d115ba

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.12-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 398.4 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.12-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 27cb205e3950653d9f3881918fd7fc1e1683986d9789681220c18783abfdf4d3
MD5 35958c06251fcf64202f9d5edc6fa90f
BLAKE2b-256 ed7d9ab10856e27250ba3cf7bb2f86782fed8b0b1e6c43d4fce3f0449457fedb

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