Skip to main content
Pre-release

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

Python Version PyPI Downloads Wheel Development Status Tests Coverage 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, UCL 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 the preprint outlining the cell detection algorithm:

Tyson, A. L., Rousseau, C. V., Niedworok, C. J., Keshavarzi, S., Tsitoura, C., Cossell, L., Strom, M. and Margrie, T. W. (2021) “A deep learning algorithm for 3D cell detection in whole mouse brain image datasets’ bioRxiv, doi.org/10.1101/2020.10.21.348771

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.

Metadata

Release files for cellfinder 0.4.11rc6

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.4.11rc6
File Size Uploaded Provenance Actions
cellfinder-0.4.11rc6.tar.gz 130.0 kB Without provenance Details for cellfinder-0.4.11rc6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cellfinder 0.4.11rc6
File Interpreter ABI Platform Actions
cellfinder-0.4.11rc6-py3-none-any.whl Python 3 none any Details for cellfinder-0.4.11rc6-py3-none-any.whl

Total release size: 161.8 kB

Release files / cellfinder-0.4.11rc6.tar.gz

Download URL cellfinder-0.4.11rc6.tar.gz
Size 130.0 kB
Tags Source
SHA-256 checksum
How to use checksums
e2551a66409039ab9b196e35771ee8c47a5572cd922f51616bd94b16c3771ac4
BLAKE2b-256 checksum
How to use checksums
44fcea3db79e848bb3833066630e446fa5c7ecdcd43f305c83e7f60a08a5b83c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / cellfinder-0.4.11rc6-py3-none-any.whl

Download URL cellfinder-0.4.11rc6-py3-none-any.whl
Size 31.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1e0e9ee9a8d8bbea2d9edb8c7c71f8eb245be0aee9e34dd0ca0b594882011734
BLAKE2b-256 checksum
How to use checksums
1460389aa34ba1c0346501d132386fa2fc3b59098fb9a666d074a62d77bf194a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Security for cellfinder 0.4.11rc6

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