Skip to main content
Pre-release

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

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.

Metadata

Release files for cellfinder 0.3.14rc2

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.14rc2
File Size Uploaded Provenance Actions
cellfinder-0.3.14rc2.tar.gz 606.7 kB Without provenance Details for cellfinder-0.3.14rc2.tar.gz

Built distributions (wheels)

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

Total release size: 10.3 MB

Release files / cellfinder-0.3.14rc2.tar.gz

Download URL cellfinder-0.3.14rc2.tar.gz
Size 606.7 kB
Tags Source
SHA-256 checksum
How to use checksums
fdbaec549d3cd1eb08734bd653f872eb97df8f74708829bbe7b14a529372b471
BLAKE2b-256 checksum
How to use checksums
5c779855baf9816e7460b5d0fa6fb34ad5417d8a99507ce297e14c48172dd732
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.46.0 CPython/3.6.7

Release files / cellfinder-0.3.14rc2-cp37-cp37m-win_amd64.whl

Download URL cellfinder-0.3.14rc2-cp37-cp37m-win_amd64.whl
Size 360.2 kB
Tags CPython 3.7 CPython 3.7 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
1e15946b4b44e52fa1e7d0ee4a690dbc35c243bfc5ac61ed0137f8f4fee80934
BLAKE2b-256 checksum
How to use checksums
1adc6ff9be74f26af954121d9bdf472696f0dc7140efe7680fe8a363da718939
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.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

Release files / cellfinder-0.3.14rc2-cp37-cp37m-manylinux2010_x86_64.whl

Download URL cellfinder-0.3.14rc2-cp37-cp37m-manylinux2010_x86_64.whl
Size 2.2 MB
Tags CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums
2ffe84206012e7a0c952f8ad673ce140b4b2bb04ff11bfa186f4f5cb64e2009c
BLAKE2b-256 checksum
How to use checksums
f70f363997bfbeeca3136f8428dd5527ef33a0f259a9e950f1fe9499fb900dbc
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.46.0 CPython/3.6.7

Release files / cellfinder-0.3.14rc2-cp37-cp37m-manylinux1_x86_64.whl

Download URL cellfinder-0.3.14rc2-cp37-cp37m-manylinux1_x86_64.whl
Size 2.2 MB
Tags CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
7373da3c3b8bc11b150930b9333209b177a82f0c29ef12f63bc12644a7ec8b38
BLAKE2b-256 checksum
How to use checksums
d9289d9123af18d07add04ae10ab495ab945418b0bc85973d6b11aaedf543930
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.46.0 CPython/3.6.7

Release files / cellfinder-0.3.14rc2-cp36-cp36m-win_amd64.whl

Download URL cellfinder-0.3.14rc2-cp36-cp36m-win_amd64.whl
Size 360.0 kB
Tags CPython 3.6 CPython 3.6 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
fd933c2aafaba95e80190333f432e0d2e6de80e1c5eee4957a291590e5cba306
BLAKE2b-256 checksum
How to use checksums
457206dbeee08b913fbe54d7136536b89125f810f23ed19402d42e9b374b4930
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.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10

Release files / cellfinder-0.3.14rc2-cp36-cp36m-manylinux2010_x86_64.whl

Download URL cellfinder-0.3.14rc2-cp36-cp36m-manylinux2010_x86_64.whl
Size 2.2 MB
Tags CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.12+ x86-64
SHA-256 checksum
How to use checksums
b29e3d8bc08048fff7cac4f6c882cbe35b7b19a95340bf6ad6297023f8d4f48f
BLAKE2b-256 checksum
How to use checksums
dbd348e9b29b4583c113814a3dce3a5503455d65576b897e235f43bdd1af659b
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.46.0 CPython/3.6.7

Release files / cellfinder-0.3.14rc2-cp36-cp36m-manylinux1_x86_64.whl

Download URL cellfinder-0.3.14rc2-cp36-cp36m-manylinux1_x86_64.whl
Size 2.2 MB
Tags CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
05e3258ec0d3afcce7f9310e5e00a1059ec44d79b1a78e6e7226ec6c811a4bf9
BLAKE2b-256 checksum
How to use checksums
7c14f074dacbf66b823fc470c3e07b5ad1c8449df5e9cd9cdc25a707f888b925
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.46.0 CPython/3.6.7

Security for cellfinder 0.3.14rc2

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