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.12rc6

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.12rc6
File Size Uploaded Provenance Actions
cellfinder-0.3.12rc6.tar.gz 611.2 kB Without provenance Details for cellfinder-0.3.12rc6.tar.gz

Built distributions (wheels)

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

Total release size: 10.6 MB

Release files / cellfinder-0.3.12rc6.tar.gz

Download URL cellfinder-0.3.12rc6.tar.gz
Size 611.2 kB
Tags Source
SHA-256 checksum
How to use checksums
5240c6b9bca4eca199feb1aec1629b9251d457facdee461b4e65210bf55d52fb
BLAKE2b-256 checksum
How to use checksums
a9c462a7fa3f5b716f5ddf4e3605392ae80b9175b4fbfa63659c052545fd5ec5
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.12rc6-cp37-cp37m-win_amd64.whl

Download URL cellfinder-0.3.12rc6-cp37-cp37m-win_amd64.whl
Size 382.2 kB
Tags CPython 3.7 CPython 3.7 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
75586306e62f4737843bbbc4d30101eccb877f6b2780204933ddae4e7b89a240
BLAKE2b-256 checksum
How to use checksums
81e867170a148f5ad6a193af3a2007d5b19d78dd28f80054ed9b55fed4ad082b
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.12rc6-cp37-cp37m-manylinux2010_x86_64.whl

Download URL cellfinder-0.3.12rc6-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
2b7d00a486b3824e58e4bea6c5f8b5b8ea436e6fbcb05fafef170a6aae924edf
BLAKE2b-256 checksum
How to use checksums
a52e97481d781166a3aeb192d073e4a64b8a9a99f10e693bbebaa6a6e9898080
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.12rc6-cp37-cp37m-manylinux1_x86_64.whl

Download URL cellfinder-0.3.12rc6-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
8c734032a12970db3abc4d2a75ef1f42aaf33deb3be575ca9f5d30436a1d12a1
BLAKE2b-256 checksum
How to use checksums
d542cec7f4b495e9d66a2bb04cd50a3f5db3d69907c701fb0834afedd05da530
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.12rc6-cp36-cp36m-win_amd64.whl

Download URL cellfinder-0.3.12rc6-cp36-cp36m-win_amd64.whl
Size 382.1 kB
Tags CPython 3.6 CPython 3.6 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
a7c1afe26aad06ace8e3fe934db419bd532bdf4affa9113154e1cc89709232e3
BLAKE2b-256 checksum
How to use checksums
d56ff2d8901256ec2194f958e0bb6006db32e4b2fe47cfda65cfe113b553326e
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.6.10

Release files / cellfinder-0.3.12rc6-cp36-cp36m-manylinux2010_x86_64.whl

Download URL cellfinder-0.3.12rc6-cp36-cp36m-manylinux2010_x86_64.whl
Size 2.3 MB
Tags CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums
fbad179fa48e72267503728815033198986c0cb602cb3b871e619c7a42150762
BLAKE2b-256 checksum
How to use checksums
31f08dda1c0bd955e57270f427583ce41d0ccf0513b23a10242a6e855c905ab5
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.12rc6-cp36-cp36m-manylinux1_x86_64.whl

Download URL cellfinder-0.3.12rc6-cp36-cp36m-manylinux1_x86_64.whl
Size 2.3 MB
Tags CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
f316f562641da9e004bf8b85303629cf1e916ad177a44ae7177f2da536d37912
BLAKE2b-256 checksum
How to use checksums
49a871da952ca3a456de9642f155e8751db57bf5a9f0bfc6cd7bcdeaeceab3e5
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.12rc6

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