spotmax


Namespotmax JSON
Version 1.0.7 PyPI version JSON
download
home_pageNone
SummaryAutomatic 3D detection and quantification of fluorescent objects
upload_time2024-11-13 15:50:50
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords 3d fluorescent signal analysis image analysis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. _GNU General Public License v3.0: https://github.com/ElpadoCan/SpotMAX/blob/main/LICENSE
.. _Contributing Guide: https://spotmax.readthedocs.io/en/latest/misc/contributing.html
.. _installation guide: https://spotmax.readthedocs.io/en/latest/install/index.html
.. _PyPI: https://pypi.org/project/spotmax/
.. _Documentation: https://spotmax.readthedocs.io/en/latest
.. _Examples (notebooks, parameters files, etc.): https://github.com/SchmollerLab/SpotMAX/tree/main/examples
.. _Francesco Padovani: https://www.linkedin.com/in/francesco-padovani/
.. _Cell-ACDC: https://github.com/SchmollerLab/Cell_ACDC
.. _Preprint: https://www.biorxiv.org/content/10.1101/2024.10.22.619610v1
.. _Spotiflow: https://www.biorxiv.org/content/10.1101/2024.02.01.578426v2
.. _BioImage.IO: https://www.biorxiv.org/content/10.1101/2022.06.07.495102v1
.. _thread: https://x.com/frank_pado/status/1849739617735426438

.. |build_win_pyqt5| image:: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-windows_pyqt5.yml/badge.svg
   :target: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-windows_pyqt5.yml
   :alt: Build Status (Windows PyQt5)

.. |build_ubuntu_pyqt5| image:: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-ubuntu_pyqt5.yml/badge.svg
   :target: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-ubuntu_pyqt5.yml
   :alt: Build Status (Ubuntu PyQt5)

.. |build_macos_pyqt5| image:: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-macos_pyqt5.yml/badge.svg
   :target: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-macos_pyqt5.yml
   :alt: Build Status (macOS PyQt5)

.. |build_win_pyqt6| image:: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-windows_pyqt6.yml/badge.svg
   :target: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-windows_pyqt6.yml
   :alt: Build Status (Windows PyQt6)

.. |build_macos_pyqt6| image:: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-macos_pyqt6.yml/badge.svg
   :target: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-macos_pyqt6.yml
   :alt: Build Status (macOS PyQt6)

.. |py_version| image:: https://img.shields.io/pypi/pyversions/spotmax
   :target: https://www.python.org/downloads/
   :alt: Python Version

.. |pypi_version| image:: https://img.shields.io/pypi/v/spotmax?color=red
   :target: https://pypi.org/project/cellacdc/
   :alt: PyPi Version

.. |downloads_month| image:: https://static.pepy.tech/badge/spotmax/month
   :target: https://pepy.tech/project/cellacdc
   :alt: Downloads per month

.. |license| image:: https://img.shields.io/badge/license-BSD%203--Clause-brightgreen
   :target: https://github.com/ElPadoCan/SpotMAX/blob/main/LICENSE
   :alt: License

.. |repo_size| image:: https://img.shields.io/github/repo-size/ElPadoCan/SpotMAX
   :target: https://github.com/ElPadoCan/SpotMAX
   :alt: Repository Size

.. |doi| image:: https://img.shields.io/badge/DOI-10.1101%5C2024.10.22.619610-informational
   :target: https://www.biorxiv.org/content/10.1101/2024.10.22.619610v1
   :alt: DOI

.. |docs| image:: https://readthedocs.org/projects/spotmax/badge/?version=latest
    :target: https://spotmax.readthedocs.io/en/latest/
    :alt: Documentation Status

.. |spotmaxlogo| image:: spotmax/docs/source/_static/logo.png
   :width: 64
   :target: https://github.com/ElpadoCan/SpotMAX/tree/main/spotmax/resources

|spotmaxlogo| Welcome to SpotMAX!
=================================

*Written by* `Francesco Padovani`_ *(creator of* `Cell-ACDC`_ *) with feedback 
from* **tons of people**,  *see list of authors here* `Citation`_. 

|build_win_pyqt5| |build_ubuntu_pyqt5| |build_macos_pyqt5| |build_win_pyqt6|
|build_macos_pyqt6| |py_version| |pypi_version| |downloads_month| |license|
|repo_size| |doi| |docs|

A generalist framework for multi-dimensional automatic spot detection and quantification
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you need to **analyse fluorescence microscopy data** you are probably in the 
right place.

SpotMAX will help you with these **two tasks**:

1. Detect and quantify **globular-like structures** (a.k.a. "spots")
2. Segment and quantify **fluorescently labelled structures**

SpotMAX excels in particularly challenging situations, such as 
**low signal-to-noise ratio** and **high spot density**.

It supports **2D, 3D, 4D, and 5D data**, i.e., z-stacks, timelapse, and multiple 
fluorescence channels (and combinations thereof).

Installation
------------

SpotMAX is published on `PyPI`_, therefore it can simply be installed with::

    pip install spotmax

Depending on how you plan to use it, you will need additional packages. 
See here for the `installation guide`_

Resources
---------

- `Documentation`_
- `Examples (notebooks, parameters files, etc.)`_
- `Preprint`_
- X/Twitter `thread`_
- Publication (working on it 🚀)

.. _Citation:

Citation
--------

If you use SpotMAX in your work, please cite the following preprint:

   Padovani, F., Čavka, I., Neves, A. R. R., López, C. P., Al-Refaie, N., 
   Bolcato, L., Chatzitheodoridou, D., Chadha, Y., Su, X.A., Lengefeld, J., 
   Cabianca D. S., Köhler, S., Schmoller, K. M. *SpotMAX: a generalist 
   framework for multi-dimensional automatic spot detection and quantification*,
   bioRxiv (2024) doi: 10.1101/2024.10.22.619610

**IMPORTANT**! If you use Spotiflow or any of the models available at the BioImage.IO Model Zoo make sure to cite those too, here are the links:

- `Spotiflow`_
- `BioImage.IO`_ Model Zoo

Contact
-------

**Do not hesitate to contact us** here on GitHub (by opening an issue)
or directly at the email elpado6872@gmail.com for any problem and/or feedback
on how to improve the user experience!

Contributing
------------

At SpotMAX we encourage contributions to the code! Please read our 
`Contributing Guide`_ 
to get started.

License
-------

SpotMAX is licensed under the `GNU General Public License v3.0`_

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "spotmax",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "3D fluorescent signal analysis, image analysis",
    "author": null,
    "author_email": "Francesco Padovani <francesco.padovani@helmholtz-munich.de>",
    "download_url": "https://files.pythonhosted.org/packages/39/b6/82814d24f43bfccece16241b8f4b492d0d070922dd9fc9fd0ae9f29d4968/spotmax-1.0.7.tar.gz",
    "platform": null,
    "description": ".. _GNU General Public License v3.0: https://github.com/ElpadoCan/SpotMAX/blob/main/LICENSE\r\n.. _Contributing Guide: https://spotmax.readthedocs.io/en/latest/misc/contributing.html\r\n.. _installation guide: https://spotmax.readthedocs.io/en/latest/install/index.html\r\n.. _PyPI: https://pypi.org/project/spotmax/\r\n.. _Documentation: https://spotmax.readthedocs.io/en/latest\r\n.. _Examples (notebooks, parameters files, etc.): https://github.com/SchmollerLab/SpotMAX/tree/main/examples\r\n.. _Francesco Padovani: https://www.linkedin.com/in/francesco-padovani/\r\n.. _Cell-ACDC: https://github.com/SchmollerLab/Cell_ACDC\r\n.. _Preprint: https://www.biorxiv.org/content/10.1101/2024.10.22.619610v1\r\n.. _Spotiflow: https://www.biorxiv.org/content/10.1101/2024.02.01.578426v2\r\n.. _BioImage.IO: https://www.biorxiv.org/content/10.1101/2022.06.07.495102v1\r\n.. _thread: https://x.com/frank_pado/status/1849739617735426438\r\n\r\n.. |build_win_pyqt5| image:: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-windows_pyqt5.yml/badge.svg\r\n   :target: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-windows_pyqt5.yml\r\n   :alt: Build Status (Windows PyQt5)\r\n\r\n.. |build_ubuntu_pyqt5| image:: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-ubuntu_pyqt5.yml/badge.svg\r\n   :target: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-ubuntu_pyqt5.yml\r\n   :alt: Build Status (Ubuntu PyQt5)\r\n\r\n.. |build_macos_pyqt5| image:: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-macos_pyqt5.yml/badge.svg\r\n   :target: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-macos_pyqt5.yml\r\n   :alt: Build Status (macOS PyQt5)\r\n\r\n.. |build_win_pyqt6| image:: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-windows_pyqt6.yml/badge.svg\r\n   :target: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-windows_pyqt6.yml\r\n   :alt: Build Status (Windows PyQt6)\r\n\r\n.. |build_macos_pyqt6| image:: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-macos_pyqt6.yml/badge.svg\r\n   :target: https://github.com/ElPadoCan/SpotMAX/actions/workflows/build-macos_pyqt6.yml\r\n   :alt: Build Status (macOS PyQt6)\r\n\r\n.. |py_version| image:: https://img.shields.io/pypi/pyversions/spotmax\r\n   :target: https://www.python.org/downloads/\r\n   :alt: Python Version\r\n\r\n.. |pypi_version| image:: https://img.shields.io/pypi/v/spotmax?color=red\r\n   :target: https://pypi.org/project/cellacdc/\r\n   :alt: PyPi Version\r\n\r\n.. |downloads_month| image:: https://static.pepy.tech/badge/spotmax/month\r\n   :target: https://pepy.tech/project/cellacdc\r\n   :alt: Downloads per month\r\n\r\n.. |license| image:: https://img.shields.io/badge/license-BSD%203--Clause-brightgreen\r\n   :target: https://github.com/ElPadoCan/SpotMAX/blob/main/LICENSE\r\n   :alt: License\r\n\r\n.. |repo_size| image:: https://img.shields.io/github/repo-size/ElPadoCan/SpotMAX\r\n   :target: https://github.com/ElPadoCan/SpotMAX\r\n   :alt: Repository Size\r\n\r\n.. |doi| image:: https://img.shields.io/badge/DOI-10.1101%5C2024.10.22.619610-informational\r\n   :target: https://www.biorxiv.org/content/10.1101/2024.10.22.619610v1\r\n   :alt: DOI\r\n\r\n.. |docs| image:: https://readthedocs.org/projects/spotmax/badge/?version=latest\r\n    :target: https://spotmax.readthedocs.io/en/latest/\r\n    :alt: Documentation Status\r\n\r\n.. |spotmaxlogo| image:: spotmax/docs/source/_static/logo.png\r\n   :width: 64\r\n   :target: https://github.com/ElpadoCan/SpotMAX/tree/main/spotmax/resources\r\n\r\n|spotmaxlogo| Welcome to SpotMAX!\r\n=================================\r\n\r\n*Written by* `Francesco Padovani`_ *(creator of* `Cell-ACDC`_ *) with feedback \r\nfrom* **tons of people**,  *see list of authors here* `Citation`_. \r\n\r\n|build_win_pyqt5| |build_ubuntu_pyqt5| |build_macos_pyqt5| |build_win_pyqt6|\r\n|build_macos_pyqt6| |py_version| |pypi_version| |downloads_month| |license|\r\n|repo_size| |doi| |docs|\r\n\r\nA generalist framework for multi-dimensional automatic spot detection and quantification\r\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\n\r\nIf you need to **analyse fluorescence microscopy data** you are probably in the \r\nright place.\r\n\r\nSpotMAX will help you with these **two tasks**:\r\n\r\n1. Detect and quantify **globular-like structures** (a.k.a. \"spots\")\r\n2. Segment and quantify **fluorescently labelled structures**\r\n\r\nSpotMAX excels in particularly challenging situations, such as \r\n**low signal-to-noise ratio** and **high spot density**.\r\n\r\nIt supports **2D, 3D, 4D, and 5D data**, i.e., z-stacks, timelapse, and multiple \r\nfluorescence channels (and combinations thereof).\r\n\r\nInstallation\r\n------------\r\n\r\nSpotMAX is published on `PyPI`_, therefore it can simply be installed with::\r\n\r\n    pip install spotmax\r\n\r\nDepending on how you plan to use it, you will need additional packages. \r\nSee here for the `installation guide`_\r\n\r\nResources\r\n---------\r\n\r\n- `Documentation`_\r\n- `Examples (notebooks, parameters files, etc.)`_\r\n- `Preprint`_\r\n- X/Twitter `thread`_\r\n- Publication (working on it \ud83d\ude80)\r\n\r\n.. _Citation:\r\n\r\nCitation\r\n--------\r\n\r\nIf you use SpotMAX in your work, please cite the following preprint:\r\n\r\n   Padovani, F., \u010cavka, I., Neves, A. R. R., L\u00f3pez, C. P., Al-Refaie, N., \r\n   Bolcato, L., Chatzitheodoridou, D., Chadha, Y., Su, X.A., Lengefeld, J., \r\n   Cabianca D. S., K\u00f6hler, S., Schmoller, K. M. *SpotMAX: a generalist \r\n   framework for multi-dimensional automatic spot detection and quantification*,\r\n   bioRxiv (2024) doi: 10.1101/2024.10.22.619610\r\n\r\n**IMPORTANT**! If you use Spotiflow or any of the models available at the BioImage.IO Model Zoo make sure to cite those too, here are the links:\r\n\r\n- `Spotiflow`_\r\n- `BioImage.IO`_ Model Zoo\r\n\r\nContact\r\n-------\r\n\r\n**Do not hesitate to contact us** here on GitHub (by opening an issue)\r\nor directly at the email elpado6872@gmail.com for any problem and/or feedback\r\non how to improve the user experience!\r\n\r\nContributing\r\n------------\r\n\r\nAt SpotMAX we encourage contributions to the code! Please read our \r\n`Contributing Guide`_ \r\nto get started.\r\n\r\nLicense\r\n-------\r\n\r\nSpotMAX is licensed under the `GNU General Public License v3.0`_\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Automatic 3D detection and quantification of fluorescent objects",
    "version": "1.0.7",
    "project_urls": {
        "Author contact": "https://schmollerlab.com/francescopadovani",
        "Homepage": "https://github.com/ElpadoCan/SpotMAX",
        "Schmoller lab": "https://schmollerlab.com/"
    },
    "split_keywords": [
        "3d fluorescent signal analysis",
        " image analysis"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d81d78a7d024aed917521abed430bbf4858ee1236ae400eaf2c252c8281caf20",
                "md5": "649d7f47f491f3b91f50e40fcd6b0937",
                "sha256": "e3627e79f7eb12e63ecda932c2ef10ffb8a82c03dd1aba070580aec42643ea30"
            },
            "downloads": -1,
            "filename": "spotmax-1.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "649d7f47f491f3b91f50e40fcd6b0937",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 12951262,
            "upload_time": "2024-11-13T15:50:47",
            "upload_time_iso_8601": "2024-11-13T15:50:47.979290Z",
            "url": "https://files.pythonhosted.org/packages/d8/1d/78a7d024aed917521abed430bbf4858ee1236ae400eaf2c252c8281caf20/spotmax-1.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "39b682814d24f43bfccece16241b8f4b492d0d070922dd9fc9fd0ae9f29d4968",
                "md5": "82e8b0803a0987b748146ae411651a96",
                "sha256": "d2238d4304197f2a0066c8813672996299c169d7b103374a14c2f8badcd099a6"
            },
            "downloads": -1,
            "filename": "spotmax-1.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "82e8b0803a0987b748146ae411651a96",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 12825435,
            "upload_time": "2024-11-13T15:50:50",
            "upload_time_iso_8601": "2024-11-13T15:50:50.854757Z",
            "url": "https://files.pythonhosted.org/packages/39/b6/82814d24f43bfccece16241b8f4b492d0d070922dd9fc9fd0ae9f29d4968/spotmax-1.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-13 15:50:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ElpadoCan",
    "github_project": "SpotMAX",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "spotmax"
}
        
Elapsed time: 3.28406s