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

Uploaded Source

Built Distributions

cellfinder-0.3.13rc3-cp37-cp37m-win_amd64.whl (381.6 kB view details)

Uploaded CPython 3.7m Windows x86-64

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

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

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

Uploaded CPython 3.7m

cellfinder-0.3.13rc3-cp37-cp37m-macosx_10_9_x86_64.whl (398.2 kB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

cellfinder-0.3.13rc3-cp36-cp36m-win_amd64.whl (381.5 kB view details)

Uploaded CPython 3.6m Windows x86-64

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

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

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

Uploaded CPython 3.6m

cellfinder-0.3.13rc3-cp36-cp36m-macosx_10_9_x86_64.whl (397.8 kB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

File details

Details for the file cellfinder-0.3.13rc3.tar.gz.

File metadata

  • Download URL: cellfinder-0.3.13rc3.tar.gz
  • Upload date:
  • Size: 621.9 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.13rc3.tar.gz
Algorithm Hash digest
SHA256 26e8ddaeec476eacf1a370a82ce0e70f1a0bb909578a9ad0f5505f8f73655fef
MD5 5625aab9c041b60a6f58ed343f6a47a2
BLAKE2b-256 b76f717450117beffe293917fd2da0243625ade81845449bc96e927d4adba496

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc3-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 381.6 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.13rc3-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 7bbd19a4684b04edc963128ddeb317b3bc2ee93dabc1306d801b80bb87faf316
MD5 a454d2d350926fe52c7d8ad6f2c229ce
BLAKE2b-256 fc220a59c4399d0681db73af4e9a50c449058ae2ddafaca9c3ba188d441c4d0f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc3-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.13rc3-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 c12726be1aace81e0a0a3253e5137767bd756baee34c40faab2682a07d81fab6
MD5 b384fda158cbf709b585a31641efbbd3
BLAKE2b-256 d605341d6a23613589496668f6e0a75aec267880eae933429ef4ae2c3ba1ef4d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc3-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.13rc3-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 302c69f5ebf12ccc93f1a09875327cbe0127cc8ae383d993f5c048e24ee452b6
MD5 4f0f44d0623670182567ee1988932ca4
BLAKE2b-256 8864261f559053f294f968bfa99c988bdd7a0db4b96c55160afa227a485fc47f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc3-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 398.2 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.0.0.post20200309 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.13rc3-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 59908310664416d97a37e547c4442256e514741432b148207509528ec9bfc838
MD5 4cbad711caf77e461995c3781f81fe6a
BLAKE2b-256 2584561f92b2f29288bc455b62ab2b451f993e54d479290a519b3a50a858eb13

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc3-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 381.5 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.13rc3-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 7f8d2d03ede40648856bc0c6b6aa18032cb516c45842913fc10e602682cdb576
MD5 65e3b02184045dfd94795d59770f482b
BLAKE2b-256 2289df4f8ea04af8c45640ea08ef84800f77e54c161a26755b4abd71ac83a5bf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc3-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.13rc3-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 92ad4dade6a1fd3e842db610f8ee2a7ed16dc2c5adaee182afb6393f7b14b9ea
MD5 4e0638e38ee2a935b58ed5cc18a80f0a
BLAKE2b-256 1d562bb4a43e9c47a82cf258bd81686b6ae3177c837b422b4c85d8448172d5f9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc3-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.13rc3-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 cb0a7b4f14da0fad9815e2298798914433ec384f88262e0896eab749dabe8b43
MD5 99932d1470da4c3ed308864197ee1e6a
BLAKE2b-256 081b7f914886f0ba2fdb36b8c81002f76ba83dfe43ed2877c7dff8956ce2194c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc3-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 397.8 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.0.0.post20200309 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.13rc3-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 940de466b19beefeabf4e8fa8ca0c8294d3a575e020dd0d4fd433683a2df9a57
MD5 118fbc515985ea7ed6e0d5feaab58ee3
BLAKE2b-256 b86825963ef8c944cab2dc8d882cf1c6498a59ecf1c85582aed83bbd5305bacc

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