Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Python Version PyPI Wheel Development Status Travis Coverage Status Dependabot Status Code style: black Gitter DOI Generic badge

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.

Metadata

Release files for cellfinder 0.3.12rc0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cellfinder 0.3.12rc0
File Size Uploaded Provenance Actions
cellfinder-0.3.12rc0.tar.gz 611.2 kB Without provenance Details for cellfinder-0.3.12rc0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for cellfinder 0.3.12rc0
File Interpreter ABI Platform Actions
cellfinder-0.3.12rc0-cp37-cp37m-win_amd64.whl CPython 3.7 CPython 3.7 pymalloc Windows x86-64 Details for cellfinder-0.3.12rc0-cp37-cp37m-win_amd64.whl
cellfinder-0.3.12rc0-cp37-cp37m-manylinux2010_x86_64.whl CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.12+ x86-64 Details for cellfinder-0.3.12rc0-cp37-cp37m-manylinux2010_x86_64.whl
cellfinder-0.3.12rc0-cp37-cp37m-manylinux1_x86_64.whl CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.5+ x86-64 Details for cellfinder-0.3.12rc0-cp37-cp37m-manylinux1_x86_64.whl

Total release size: 5.6 MB

Release files / cellfinder-0.3.12rc0.tar.gz

Download URL cellfinder-0.3.12rc0.tar.gz
Size 611.2 kB
Tags Source
SHA-256 checksum
How to use checksums
431f2aaa384851828b5dcf01fb7cd4f4365f2346b018951552b493b6d02ffc3d
BLAKE2b-256 checksum
How to use checksums
3e4b0932a265ffb7fc114c0d709a1eaccd6e702c0994e966589863784793cfd2
Upload date
Uploaded using Trusted Publishing?
What is 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.45.0 CPython/3.6.7

Release files / cellfinder-0.3.12rc0-cp37-cp37m-win_amd64.whl

Download URL cellfinder-0.3.12rc0-cp37-cp37m-win_amd64.whl
Size 387.3 kB
Tags CPython 3.7 CPython 3.7 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
946fbf8a5dcc3c97902cfe7b4b02c4143eafad4affb382e0005277a7cc186f29
BLAKE2b-256 checksum
How to use checksums
b4d0f0e5b820f409ff70e042f5e659001fcb1b9644929214ebd9b341199a9758
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

Release files / cellfinder-0.3.12rc0-cp37-cp37m-manylinux2010_x86_64.whl

Download URL cellfinder-0.3.12rc0-cp37-cp37m-manylinux2010_x86_64.whl
Size 2.3 MB
Tags CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums
08da4c9cf09cdf25782d688822091dd0f440d0245b0d62eee90d3b322b192c2d
BLAKE2b-256 checksum
How to use checksums
39f505db6b4d505a2fd6b4b988198d8309aa4b17077827f0ed455c9cb325885f
Upload date
Uploaded using Trusted Publishing?
What is 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.45.0 CPython/3.6.7

Release files / cellfinder-0.3.12rc0-cp37-cp37m-manylinux1_x86_64.whl

Download URL cellfinder-0.3.12rc0-cp37-cp37m-manylinux1_x86_64.whl
Size 2.3 MB
Tags CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
38f04e39e5fff1646705d1c1d6ff23a2a7fe9ea669d50efac1bfadcf3d900a33
BLAKE2b-256 checksum
How to use checksums
7a9fd4e62f1c862410d77befcc4ac178c1ee88d0d8611550e25659c9741724a0
Upload date
Uploaded using Trusted Publishing?
What is 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.45.0 CPython/3.6.7

Security for cellfinder 0.3.12rc0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page