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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.7m Windows x86-64

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

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

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

Uploaded CPython 3.7m

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

Uploaded CPython 3.6m Windows x86-64

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

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

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

Uploaded CPython 3.6m

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc1.tar.gz
  • Upload date:
  • Size: 606.7 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.14rc1.tar.gz
Algorithm Hash digest
SHA256 1b1c1e8ec5001a1c33077eb1139fa3b8c1dc966bf3cee395a887f9dbadd56a1d
MD5 4d1d45d62e559cef84de345af0bc1bf7
BLAKE2b-256 960c6208a9494bc5f2a767a7869c926710eaf47ba58bdede6519419a7a8b5474

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc1-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 360.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/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for cellfinder-0.3.14rc1-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 1417dc840f970e234b86a7fcdbd508c89806b9fd73bdb6539e1d167698fec554
MD5 74351e84da19cc3b7edff1a67976a6cb
BLAKE2b-256 0307f7c5b0b4bc8aae53ab3ce8e1cf2e7c37d3d8a534e125405569db6622f05f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc1-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.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc1-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 c7012d5851ca1011e52878c13c50f3890d4d5ecf7480349272d6fee2c1f60247
MD5 0f7de2806d472f2cc2c17dba5978f73e
BLAKE2b-256 ddd5f15dbafbdd62ad484c3629c8abedfe3b36e6417cd1fc2a2766b7e35e59bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc1-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.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc1-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 c33fd018320b5824effc87eaf131c8621819f2a698cb071676ae37803fd0e558
MD5 eb08540ddabcd88052e94f890e336abe
BLAKE2b-256 1dbd66269a902955819333902c0c57e46dc193591f0c47f681884587f1068d5d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc1-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 360.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/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10

File hashes

Hashes for cellfinder-0.3.14rc1-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 09fb4f54196e1652f6a382fa179a3c326c4408ff22de956952bf184558443536
MD5 55f26774da79716964875227d1851d33
BLAKE2b-256 e1ceabf6c941640b5dfb15a6e2f9e1babf04d227977f152fcda39c7d02e69e15

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc1-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.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc1-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 818b5a197e337434258d4ec1ccbe180d254bb3593e9943175f8106e18a9b40e8
MD5 4a10d9ac56d49f80c3b7ccd87ffa3c24
BLAKE2b-256 b86405c09670c38975ae792dbc63051842b8cc264565ed47923b3c86891c9d4b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-0.3.14rc1-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.0 CPython/3.6.7

File hashes

Hashes for cellfinder-0.3.14rc1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 da97fbf61efa1488aa2293df78b18d9eb044fe916f21dcd8a9d65730a33004bc
MD5 0e767e6c2a235923849341d7747cd945
BLAKE2b-256 cb68a6c441a985346ebb119f70ae4b723f094e0f95da1fbc85fc1bea7870f9ef

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