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 brainreg)
  • 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 (brainreg)

Using brainreg, 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

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. 10.5281/zenodo.3891338

If you use any of the image registration functions in cellfinder, please also cite brainreg.

If you use this, or any other tools in the brainglobe suite, please let us know, and we'd be happy to promote your paper/talk etc.

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

Uploaded Source

Built Distributions

cellfinder-0.4.3-cp38-cp38-win_amd64.whl (344.9 kB view details)

Uploaded CPython 3.8 Windows x86-64

cellfinder-0.4.3-cp38-cp38-manylinux2014_x86_64.whl (2.0 MB view details)

Uploaded CPython 3.8

cellfinder-0.4.3-cp37-cp37m-win_amd64.whl (337.0 kB view details)

Uploaded CPython 3.7m Windows x86-64

cellfinder-0.4.3-cp37-cp37m-manylinux2014_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.7m

File details

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

File metadata

  • Download URL: cellfinder-0.4.3.tar.gz
  • Upload date:
  • Size: 148.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.3.tar.gz
Algorithm Hash digest
SHA256 eb3a0d286a6029620283fe2592cfdd8a294ef21327efb61350892ba29dbf5834
MD5 79828f3bcf2ab0badf9a43f7960f2db7
BLAKE2b-256 aefd00bdca16d1332ce0568b7d2a61f2ae19883f405ec837f7cb9a5f32603239

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.3-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: cellfinder-0.4.3-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 344.9 kB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

Hashes for cellfinder-0.4.3-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 67e11d7d5cc0a678edfea4fbf1f1fc0427007ae49053643afc8843b0cdee39d2
MD5 6d3e2f6b52b458b08f25ba4151c8e9da
BLAKE2b-256 a7be7f8e57024392523ade4aadbe909cd097d0385d772a31cfd5272cc2913573

See more details on using hashes here.

File details

Details for the file cellfinder-0.4.3-cp38-cp38-manylinux2014_x86_64.whl.

File metadata

  • Download URL: cellfinder-0.4.3-cp38-cp38-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.3-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 7d9733fd31765a57878bb69281f7bfdbb4a0f3725a1880449926a897429daccb
MD5 27ac3a2e64fec2be2def2d445d499a20
BLAKE2b-256 b87f2772b61d6be31535ae9c02072fb2820c4b96058064a082061313629c3341

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.3-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 337.0 kB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.9

File hashes

Hashes for cellfinder-0.4.3-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 df3dbf260e04167f685372bded3f3f5b5a9478de267a097dd0dff839ce3d6e47
MD5 42663e22eea149c697f2dcc94d0daefa
BLAKE2b-256 cdffd2d6482fed099a6e2cb3efaf0acac308efc381295e65fa6a1304a9420cc2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.4.3-cp37-cp37m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.7

File hashes

Hashes for cellfinder-0.4.3-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2da2b434f02d4c1be406dcdd4ae5eb19594afc68f4d2ea81815e7648b79fe23e
MD5 ab79c8de82c2c704b7c1c04ec1d5ba12
BLAKE2b-256 f31df96d5742f561a770a4f6d537596f595f6583c934d9b33127acf9854a3a43

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