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

Uploaded Source

Built Distribution

cellfinder-1.6.0-py3-none-any.whl (93.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cellfinder-1.6.0.tar.gz
Algorithm Hash digest
SHA256 8775910ebb79b0029e94e2a4bb5ee39603d2d3ae2e04692d829b9e5575700fb0
MD5 e2c79b59f4e16e62bcbd1c3b0b93b690
BLAKE2b-256 41bda03e4b2d2d7be16298e0a29b4cac542a55e36b15e090edd34afc5c3f83f7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cellfinder-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 93.9 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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a50546ac06170541a8fb76a407da62d5b677038bf47dd45b6ee9b7005bd28f5
MD5 443b9becea7bc5e3654f2ed491253ce2
BLAKE2b-256 25527e667dc7ed31815c90f4edde8623f30588b63e74d4456e63203c9822e715

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