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

Uploaded Source

Built Distributions

cellfinder-0.3.13rc0-cp37-cp37m-win_amd64.whl (382.3 kB view details)

Uploaded CPython 3.7m Windows x86-64

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

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

cellfinder-0.3.13rc0-cp37-cp37m-macosx_10_9_x86_64.whl (398.9 kB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

cellfinder-0.3.13rc0-cp36-cp36m-win_amd64.whl (382.2 kB view details)

Uploaded CPython 3.6m Windows x86-64

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

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

cellfinder-0.3.13rc0-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.13rc0.tar.gz.

File metadata

  • Download URL: cellfinder-0.3.13rc0.tar.gz
  • Upload date:
  • Size: 622.3 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.13rc0.tar.gz
Algorithm Hash digest
SHA256 6b549a65ee3519731b7625e85e1da3bc465f9e612d0a30accf1245b02f2c6c00
MD5 33ac07ae0f37e714694005b2312f64db
BLAKE2b-256 7997817872493cb7e4044f3ec244caf76ea5e88ae3d26229c578207126be6103

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc0-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 382.3 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.46.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.13rc0-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 7deb932d2d07f7c1091a702e10b823c02fa18fadc8b54f8c675ed12590ca325b
MD5 7656f5fd1c2df9cec19b2d1ff32ed606
BLAKE2b-256 e167436dfbe94e6a28415afedc11abc565793a457433baef518736ec484bf3bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc0-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.13rc0-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 d9b151f6c963c19371ed0134d95c0f6d27b81ed40080d00a97e971b0864c34d1
MD5 698da9ccfa2e81661a8dca081515947a
BLAKE2b-256 eadc721c9783e69c08d7986f9de7834c491928f768b31f4a1fa57f7ded1c55ad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc0-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.13rc0-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 152c5ea401f1c1a9e3ead8f4a661eb79a20ec623321d1142d330ac3e35c01887
MD5 5b93fad5f9793662c7d5b698ed3833e3
BLAKE2b-256 fa04fb67743767b642b77dc1b73a2953cfb7556b69f99360be545f2368304ed4

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.13rc0-cp37-cp37m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.13rc0-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 398.9 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.46.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.13rc0-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 3e1dbe6017a90dbaeae3d24126850e44f761cd3d48d033592858d61976ea91a1
MD5 accc3a89c70e64da493c1264ad8fa0a3
BLAKE2b-256 4e060b9a182275959ddc3c9e4adb24490c3d7d4d5f9c1592e0206858827287bd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc0-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 382.2 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.46.0 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.13rc0-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 ebd965537dc72d8d697064c0b82190df7b7bcec34e67629d07dc3b0655af2c83
MD5 4bba9a615311bdbf6e63f6bd7aa4f031
BLAKE2b-256 6bf700b890ad0fb966bd7f2364e745dccda8a3cc65819df7fbaeae017bf00127

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc0-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.13rc0-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 50a365ea0249c969636880b7a9ac1826b08f047ac295186018eadd02c347737c
MD5 97578142fedc4f60823e13c390c8c326
BLAKE2b-256 63e8ac859e438ca37d5990fe1b7de7dae95ef6433bfb03bd556aefb2b9ca04b3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc0-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.13rc0-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 31d7d91b589ad83f22eff9fb1e0a57f7c1e75722011cac94569e2d21808d0be2
MD5 a6b96dd7fb21872c4037a7fcea07083c
BLAKE2b-256 d8a30219a3b7f30bc3e1e4ba03e97bdde8e5e5e4cbe1d6dded725e044c1128ae

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.13rc0-cp36-cp36m-macosx_10_9_x86_64.whl.

File metadata

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

File hashes

Hashes for cellfinder-0.3.13rc0-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 0be235197921916d24b2059ecba49ee9c9448a24e1573b89079372d815a10c6c
MD5 961183be85ac514a4d813563b6291371
BLAKE2b-256 b8b845b0fb8cd537c2092ff923367b39a8fd805513673fe11a422552bdbeb3d8

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