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

Uploaded Source

Built Distributions

cellfinder-0.3.13rc4-cp37-cp37m-win_amd64.whl (381.5 kB view details)

Uploaded CPython 3.7m Windows x86-64

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

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

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

Uploaded CPython 3.7m

cellfinder-0.3.13rc4-cp37-cp37m-macosx_10_9_x86_64.whl (398.1 kB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

cellfinder-0.3.13rc4-cp36-cp36m-win_amd64.whl (381.4 kB view details)

Uploaded CPython 3.6m Windows x86-64

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

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

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

Uploaded CPython 3.6m

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

File metadata

  • Download URL: cellfinder-0.3.13rc4.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.13rc4.tar.gz
Algorithm Hash digest
SHA256 b3274dbd8af104b45e3897fd289683d6b23542ad116a6343c6eb083915b685f5
MD5 e1c04060f7eddb472c45c0fe3ea999f2
BLAKE2b-256 77a80c7216f976d65ca47a6d9fc7ebea2072e68dd657001f6de025ca6bd64d41

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc4-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 381.5 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.13rc4-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 9aa2be9a33709e4508006781a88e2cea922795064e4e4d8571f75d8e932a73b8
MD5 9efa40d7ac931b522254d171e84e8791
BLAKE2b-256 70dc5186d41baf9fea2616c5f54191759660cd084388bb5e4906bfc3c44b34f0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc4-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.13rc4-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 248478891d85cc272e973be7b8554b4db95838479a55e647cd859ebfdbfa0215
MD5 5edc9ac9e6a3adfdb8e9059e1b9cbf64
BLAKE2b-256 e35e9e57da41d1aef0ee1ad72d4117bdcb06b8c483df810fa684b46cc9326952

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc4-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.13rc4-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 c93a78816110136c8bce1c616a7346870184d18d67f0cf11abca54b4307e1591
MD5 27df092ae5ecc7046b07fdd935119804
BLAKE2b-256 3783121b05ebe5a6f3aea30e5fb4e3931cdf7395c3a6d9ff019292a928ae592d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc4-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 398.1 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.13rc4-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 b00ae640c647493ae5c2eb08af4a6bd1a480799910343e53894297e2cfcddcb3
MD5 dc46ce638b0617d9f2cf884e520ee9e0
BLAKE2b-256 3a9b20a299512c9c80a7d42efee3093be2a4eca61878d9fe0b781e61a23e4c2c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc4-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 381.4 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.13rc4-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 eb67a545497147d1c71a0fb42a53af0206cdcb851cdc0f97a227759c098f3819
MD5 ebd956e5ce0f897f4c2e8c84412b056e
BLAKE2b-256 bf782413c905b7fed79dde763f21b9a3ecbc1a65e8baaa17f4110c2628578cd6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc4-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.13rc4-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 00c004f3ad4377d238d017fe51718a5cde0d544e265d6fd823532d6b618a1b19
MD5 96aa8154a7a060cd7265e8870ccc4906
BLAKE2b-256 770ecc7b1ac8c567e843d3fe0cbd18bb7183007e83482fd460e392ba4ad64993

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc4-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.13rc4-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 cab81a39121af8ed8e2e8405087a4a000ac610d1a89cf00900829f8ca820fa0b
MD5 c02e69d917df34f279bdbc2ec9dbf72e
BLAKE2b-256 f368c41b66427c8a7c42a5f4c69733f8797cb79424526dc05637e981196152a6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc4-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.13rc4-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 5a1be441773467e32b76982a934f041044de71c8f6e62ed45320f6df3e022acd
MD5 fe2660fc07fe7a23c54251a3bc58f179
BLAKE2b-256 175d8a1ea3f3ac034c7b002671278afcb19b476482d55cd84d08ab068baa9041

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