Skip to main content

Automated 3D cell detection in large microscopy images

Project description

Python Version PyPI Downloads Wheel Development Status Tests codecov Code style: black Imports: isort pre-commit Contributions Twitter

cellfinder

cellfinder is software for automated 3D cell detection in very large 3D images (e.g., serial two-photon or lightsheet volumes of whole mouse brains). There are three different ways to interact and use it, each with different user interfaces and objectives in mind. For more details, head over to the documentation website.

At a glance:

  • There is a command-line interface called brainmapper that integrates with brainreg for automated cell detection and classification. You can install it through brainglobe-workflows.
  • There is a napari plugin for interacting graphically with the cellfinder tool.
  • There is a Python API to allow users to integrate BrainGlobe tools into their custom workflows.

Installation

You can find the installation instructions on the BrainGlobe website, which will go into more detail about the installation process if you want to minimise your installation to suit your needs. However, we recommend that users install cellfinder either through installing BrainGlobe version 1, or (if you also want the command-line interface) installing brainglobe-workflows.

# If you want to install all BrainGlobe tools, including cellfinder, in a consistent manner with one command:
pip install brainglobe>=1.0.0
# If you want to install the brainmapper CLI tool as well:
pip install brainglobe-workflows>=1.0.0

If you only want the cellfinder package by itself, you can pip install it alone:

pip install cellfinder>=1.0.0

Be sure to specify a version greater than version v1.0.0 - prior to this version the cellfinder package had a very different structure that is incompatible with BrainGlobe version 1 and the other tools in the BrainGlobe suite. See our blog posts for more information on the release of BrainGlobe version 1.

Seeking help or contributing

We are always happy to help users of our tools, and welcome any contributions. If you would like to get in contact with us for any reason, please see the contact page of our website.

Citation

If you find this package useful, and use it in your research, please cite the following paper:

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’ PLOS Computational Biology, 17(5), e1009074 https://doi.org/10.1371/journal.pcbi.1009074

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.

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-1.7.0.tar.gz (83.5 kB view details)

Uploaded Source

Built Distribution

cellfinder-1.7.0-py3-none-any.whl (94.6 kB view details)

Uploaded Python 3

File details

Details for the file cellfinder-1.7.0.tar.gz.

File metadata

  • Download URL: cellfinder-1.7.0.tar.gz
  • Upload date:
  • Size: 83.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cellfinder-1.7.0.tar.gz
Algorithm Hash digest
SHA256 a711112f04c98aa7e659a7409741f385e6f9abd762b88805945fb4bec50ea113
MD5 09783877f3626e7a987e5a66ee7fb6d7
BLAKE2b-256 e660d2373160c00233bbf283638e6a6ebca727b2f7f868f9bfba2d590052a298

See more details on using hashes here.

File details

Details for the file cellfinder-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: cellfinder-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 94.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cellfinder-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff36e4c5677549503c373f3b1837cbebddf5cd39bda58549a8f71979e74c2860
MD5 d31443d22ec7271181e028fc5474b372
BLAKE2b-256 c6570e11456c9e728dbcc9fc1ca0bbed22dbaa785d57e756e9fe017bb40167b6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page