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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.3.14-cp37-cp37m-manylinux2014_x86_64.whl (2.4 MB view details)

Uploaded CPython 3.7m

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

Uploaded CPython 3.6m Windows x86-64

cellfinder-0.3.14-cp36-cp36m-manylinux2014_x86_64.whl (2.4 MB view details)

Uploaded CPython 3.6m

File details

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

File metadata

  • Download URL: cellfinder-0.3.14.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.14.tar.gz
Algorithm Hash digest
SHA256 d57610c9adcf86b883f2f6256ed68d5f78d9ba34e6b135be4f999cee655758d4
MD5 233c827ad5dfefa08131032b996982a5
BLAKE2b-256 11c7bdfb56aab3064292294134b227ca9cb3e3ae921b47ca32a3e3978b2bf0df

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14-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.14-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 8c8b414d9673fe3d0bf6700f2c20b2f0377d47f45244fc6569b550b3682d61bc
MD5 49177281e1944bc182b054ab31a0a35c
BLAKE2b-256 0f65cea8ff766a58b4dc25d558c2a9e634f47a06ea37c6d39b15a39140b84d2c

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14-cp37-cp37m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.14-cp37-cp37m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.4 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.14-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9a3422f9b015584ccc1db962d7d2446530977c20382660bfab39fe85e004c338
MD5 63b787ca22423aad91c3af899dde1168
BLAKE2b-256 2d2934579b6e06d87ece6a05f336e7f1223e3f6b77959d626a71e19eec5ff288

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 358.9 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.14-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 e2842d2eca78bf99e18a32c4525988187e93070bcca655750d49d64dd590b318
MD5 caa23d4bc273610b2eb1a866bbba40cc
BLAKE2b-256 92302c9f7cefe93e0f6b6919b431426aa75945090d48f4907def92e22dd487cf

See more details on using hashes here.

File details

Details for the file cellfinder-0.3.14-cp36-cp36m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.3.14-cp36-cp36m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.4 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.14-cp36-cp36m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1d14768f1360f202fe5e7749ef2d73bf575711ab389be5dee4e91179887e6b42
MD5 36dfed3b44a8796959417224d5e21c2d
BLAKE2b-256 882bbe17dd6c92fb034a0840c3f6060b7911aae6a04d6494409a5334051922f7

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