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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7m Windows x86-64

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

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

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

Uploaded CPython 3.7m

cellfinder-0.3.13rc5-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.13rc5-cp36-cp36m-win_amd64.whl (381.4 kB view details)

Uploaded CPython 3.6m Windows x86-64

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

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

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

Uploaded CPython 3.6m

cellfinder-0.3.13rc5-cp36-cp36m-macosx_10_9_x86_64.whl (397.7 kB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc5.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.13rc5.tar.gz
Algorithm Hash digest
SHA256 bd64c1044b9d3b739ce28644f7673b10217a79f91ca5fa9fc0059f282a8ba9eb
MD5 621e52a5635ac122c6b1f68df17cb7ac
BLAKE2b-256 8d6138317058b3f618e6a17a3525907159ea38835703d2ee19cb641230b24114

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc5-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.13rc5-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 7ec2751601a5afbece40c590c622b6509f893382dcb6d0559774a5eda6e0e419
MD5 ee16a1c5fb01f03b5fbc3b46a225566e
BLAKE2b-256 c37f36f53a6210208666714c09eb5e7c203d3c1af6217ff2f6820406c8c42821

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc5-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.13rc5-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 a140a8515b806ab8dfc81fbcdf6cf1dab36de1d1505ee029b576e599e02d9fdd
MD5 d0608a64e5043796f904af0f3b8253d4
BLAKE2b-256 a714e2623940eb16e88779eaa75b80d6f636d988243bcffcb47ed685eb78e028

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc5-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.13rc5-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 516600d7de1a0086178f519411231afad5aa8ecf6d8708e01ba8991fdeb07bba
MD5 410a506ec8514af8fa2c3f00614e530c
BLAKE2b-256 383bc24083aa2015dc656745a1267c0aadbb67e7410e6fe4385082595fd83aab

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc5-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.13rc5-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 ea68cda38a28a6be4c58f1564208fc784c9c102533a7f8ead7dd72aa67018c70
MD5 c9752a9185661fc2a0a129ff70920e92
BLAKE2b-256 17777a56de918ca09761cabd7a38a1d705af3c22e9e6e9cb0b4e15b2ef246fad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc5-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.13rc5-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 71ff5ba0a17c955ab755b51174652322fde0a322d1ad7ad1f80ab4c70e52ac11
MD5 9d6184446c89c1a69845cae14adc2e14
BLAKE2b-256 c564ee718a1bd24d0a66e4136dd664d7d9d997a879ccac6b3e957ea498ea3194

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc5-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.13rc5-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 6deee997582ec1ad979e1fa732eb845e8a1eec98130f1b346df191ff961d07ed
MD5 2151250b1faf817779c039e90c37547b
BLAKE2b-256 a03a3f663c912fc8c2d7b1875fa33eeb49bcabe98e32673aaf874d404df5d1a9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc5-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.13rc5-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 f3b31538b1eb0a33b7d8e535b3d8a9bef6ef43142884248397f5dce945b618dd
MD5 582e5e6b15a6079f99a35c17e9ea8eb5
BLAKE2b-256 6228a2d5b6208e16fa6a0a329be65f4583dff862c3b67ca0441a39cd2fca29fa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.13rc5-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 397.7 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.13rc5-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 6b1cd665b40e9af908502e13f5432082bbc45a8aa62460117b4c397fb227f03d
MD5 a3cafb02504e3678b0aca6da491a1b66
BLAKE2b-256 0584f427a7330b6d4211bd5c4e26b7c338f13ef70f538d896fa97894da81df52

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