Skip to main content

Automated 3D cell detection and registration of whole-brain images

Project description

Python Version PyPI Downloads 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. See the documentation for details.

Heatmaps of detected cells:

heatmap

Mapping non-cellular volumes in standard space:

Virus injection site within the superior colliculus.

(Data courtesy of @FedeClaudi and brainrender) injection

Mapping of probe tracks in standard space:

Neuropixels probe in primary visual cortex.

(Data courtesy of @velezmat). injection

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

Uploaded Source

Built Distributions

cellfinder-0.3.14rc3-cp37-cp37m-win_amd64.whl (359.1 kB view details)

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.3.14rc3-cp37-cp37m-manylinux2010_x86_64.whl (2.2 MB view details)

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

cellfinder-0.3.14rc3-cp37-cp37m-manylinux1_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.7m

cellfinder-0.3.14rc3-cp36-cp36m-win_amd64.whl (359.0 kB view details)

Uploaded CPython 3.6m Windows x86-64

cellfinder-0.3.14rc3-cp36-cp36m-manylinux2010_x86_64.whl (2.2 MB view details)

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

cellfinder-0.3.14rc3-cp36-cp36m-manylinux1_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.6m

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc3.tar.gz
  • Upload date:
  • Size: 606.2 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.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc3.tar.gz
Algorithm Hash digest
SHA256 41945b08b02746c6af9f073ead5427ed17c5e0599716ebb31db04a5e6db91845
MD5 e502f3313c6c298498acc440431c0ca1
BLAKE2b-256 d1bbc027020671c6e6967bf213241bc4bd0c41d9435657a8a7c92e3cc65ab633

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc3-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 359.1 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/47.1.1.post20200604 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.14rc3-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 855ab8504f3db954b0c81e9d6d436afe956835eda761348e018c330fdfc4bee3
MD5 d7a6ec54ddf56e190fb404167d5a227e
BLAKE2b-256 ff741be1c5bfad5b5d3b8e381d2ae35aa7e1da48e2be6414ee6a38b5003569f5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc3-cp37-cp37m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 2.2 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.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc3-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 8518a0160846b98d65c90d45708ddf501ca63788a47d6f0138366345948bd31c
MD5 723045f966291efddbbab1ab72d0af09
BLAKE2b-256 e83f4b23ea07a6d3c332f9818800beb4d7d57c394647bd76f1d8521228533984

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc3-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 2.2 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.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc3-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 7c9f499a3ca60272152d400d11b3f2994b258b095d466c46e8705450134436f8
MD5 0d4dc0a5fb449613831d0aaa7b9bdc8c
BLAKE2b-256 222fcc763f02d21b1b62b7b7c130b51eb31aa11edafd1accd120f8bcfb9aac81

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc3-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 359.0 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/47.1.1.post20200604 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.14rc3-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 c29b26702b536890399cfe9dbf49202392e5edda754abcedefef81d9d862ee72
MD5 07092697d0a0afa714e41f4149b230fc
BLAKE2b-256 086f1b3827788b49d7c80b412ead34cd9ac5ce80a941b40e22151f7dbb10bb1c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc3-cp36-cp36m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 2.2 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.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc3-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 b6fabb8305f219eac08297d8b7be073d8d0e6a6c6811a338341b2397070daa51
MD5 f618d3fa96f7c6cdbcefb74cdd958993
BLAKE2b-256 4bf43dc22560b83ae364f735d50f6db97a0b60dd69fe75a5beaf304c3d36719b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc3-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 2.2 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.1 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc3-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 322d7d7bd6de872675585cfa47b393c216dee2ec9a78f4b579f1d56d9765e357
MD5 3e90d75e7d410dff5a251c5ca11e7433
BLAKE2b-256 d3b73e8ab0b750ff3e32772e05f2387636ba43aa5866a394df0a2f526c360661

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