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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7m Windows x86-64

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

Uploaded CPython 3.6m Windows x86-64

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc6.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.14rc6.tar.gz
Algorithm Hash digest
SHA256 994ad757f2194dbcebf964c15e558d5be2b57aeddeee7274216c6de67c7b248d
MD5 a2bd6c7ea9dcc6f7556610f2f8aa8f0d
BLAKE2b-256 25692d1868df9e8ef480aba5ef236f42c5ce6937a21f9923df221d04db96d5df

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc6-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 359.2 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.14rc6-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 bf683032933306ef1d452bd35e01da754c6d92989931d2463fdad23ff2072fb6
MD5 90a14e5a7744ef748749023e9bacb7c4
BLAKE2b-256 a3d87345669fb4bb7a02ad52c522e3c54cf3bb3bb1bb4b0dbd5cf612653d9cba

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc6-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.14rc6-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b61cd8cb6ea8b5cbf5262394f4930e23bf9d34457ec8c7b311741af1aab1513c
MD5 bcdb225955b2f7cdb26cf244e1c8191d
BLAKE2b-256 d49517bcdc17272d20b06721932e618d202ded31845753ee2f6098c080ad5be7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc6-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.14rc6-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 824f160b46beffb6e5b5a58d684f12076cd049e7ab96d8df308ce04cea18adbd
MD5 2933873ec9b148b90f2c70dd2ef0c52a
BLAKE2b-256 c5184a82ac802fca291819e7bd2f43570daeebf44237204af1aab60d3315e4e5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc6-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.14rc6-cp36-cp36m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a672c1fd401cebda48ec5cafa320b077634c65e0e40ae129144b409128fbd9ea
MD5 5b5cf79d35ee65b505ce7a6c8ff668e3
BLAKE2b-256 9143fdd4f1ddbba01e9776c97c26a1b52b8f57c0925a99ceca6449a4f40a0135

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