obj.mpp


Nameobj.mpp JSON
Version 2023.3 PyPI version JSON
download
home_pagehttps://gitlab.inria.fr/edebreuv/Obj.MPP
SummaryObject/pattern detection using a Marked Point Process
upload_time2023-05-03 15:19:47
maintainer
docs_urlNone
authorEric Debreuve
requires_python>=3.8
licenseCeCILL-2.1
keywords signal image image analysis object detection pattern detection marked point process
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Obj.MPP: Object/pattern detection using a Marked Point Process
==============================================================

Illustration
------------

Looking for disk-like objects (*other shapes available*) centered in the green region-of-interest:

.. _К562_(Light_microscopy): https://commons.wikimedia.org/wiki/File:%D0%9A562_(Light_microscopy).JPG

.. figure:: documentation/sphinx/graphics/obj-mpp-circle.png
   :alt:   Grayscale image

   Image source: `К562_(Light_microscopy)`_

   | Creative Commons Attribution-Share Alike 4.0 International
   | (https://creativecommons.org/licenses/by-sa/4.0/deed.en)



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

The ``Obj.MPP`` project is published on the `Python Package Index (PyPI) <https://pypi.org>`_ at: `https://pypi.org/project/obj.mpp <https://pypi.org/project/obj.mpp>`_. It requires version 3.8, or newer, of the interpreter. It should be installable from Python distribution platforms or Integrated Development Environments (IDEs). Otherwise, it can be installed from a command-line console:

- For all users, after acquiring administrative rights:
    - First installation: ``pip install obj.mpp``
    - Installation update: ``pip install --upgrade obj.mpp``
- For the current user (no administrative rights required):
    - First installation: ``pip install --user obj.mpp``
    - Installation update: ``pip install --user --upgrade obj.mpp``



Documentation
-------------

The Obj.MPP documentation is hosted at `edebreuv.gitlabpages.inria.fr/Obj.MPP <https://edebreuv.gitlabpages.inria.fr/Obj.MPP>`_.



Contributions
-------------

The optional, periodic detection refinement step is not part of the original Marked Point Process object detection method (see the Gamal Eldin *et al* reference in the documentation). It is an heuristic addition. While using Obj.MPP on images containing many objects with this refinement step on, Xavier Descombes noticed that, after some iterations, each iteration was taking very long to complete. He hypothesized that the refinement step was applied in each iteration instead of happening with the specified period. He was right since I had forgotten to reset the refinement-related counter after application.

Some features of Obj.MPP were added upon request:

- Florence Besse and Fabienne de Graeve requested the possibility to ignore some image segments in the computation of an object quality. Note that this can also be done by writing a dedicated quality function, although it requires coding skills of course.
- Xavier Descombes requested the possibility to combine the object quality with the object area in order to favor a larger, encompassing object over smaller adjacent objects, or not. Note that this can also be done by writing a dedicated quality function, although it requires coding skills of course.



Thanks
------

The project is developed with `PyCharm Community <https://www.jetbrains.com/pycharm>`_.

The development relies on several open-source packages (see ``install_requires`` in ``setup.py``).

The code is formatted by `Black <https://github.com/psf/black>`_, *The Uncompromising Code Formatter*.

The imports are ordered by `isort <https://github.com/timothycrosley/isort>`_... *your imports, so you don't have to*.

The HTML documentation is generated by `SPHINX <https://www.sphinx-doc.org>`_, *Python Documentation Generator*.

The package requirement list is generated by `pigar <https://github.com/damnever/pigar>`_.

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.inria.fr/edebreuv/Obj.MPP",
    "name": "obj.mpp",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "signal,image,image analysis,object detection,pattern detection,marked point process",
    "author": "Eric Debreuve",
    "author_email": "eric.debreuve@univ-cotedazur.fr",
    "download_url": "",
    "platform": null,
    "description": "Obj.MPP: Object/pattern detection using a Marked Point Process\n==============================================================\n\nIllustration\n------------\n\nLooking for disk-like objects (*other shapes available*) centered in the green region-of-interest:\n\n.. _\u041a562_(Light_microscopy): https://commons.wikimedia.org/wiki/File:%D0%9A562_(Light_microscopy).JPG\n\n.. figure:: documentation/sphinx/graphics/obj-mpp-circle.png\n   :alt:   Grayscale image\n\n   Image source: `\u041a562_(Light_microscopy)`_\n\n   | Creative Commons Attribution-Share Alike 4.0 International\n   | (https://creativecommons.org/licenses/by-sa/4.0/deed.en)\n\n\n\nInstallation\n-------------\n\nThe ``Obj.MPP`` project is published on the `Python Package Index (PyPI) <https://pypi.org>`_ at: `https://pypi.org/project/obj.mpp <https://pypi.org/project/obj.mpp>`_. It requires version 3.8, or newer, of the interpreter. It should be installable from Python distribution platforms or Integrated Development Environments (IDEs). Otherwise, it can be installed from a command-line console:\n\n- For all users, after acquiring administrative rights:\n    - First installation: ``pip install obj.mpp``\n    - Installation update: ``pip install --upgrade obj.mpp``\n- For the current user (no administrative rights required):\n    - First installation: ``pip install --user obj.mpp``\n    - Installation update: ``pip install --user --upgrade obj.mpp``\n\n\n\nDocumentation\n-------------\n\nThe Obj.MPP documentation is hosted at `edebreuv.gitlabpages.inria.fr/Obj.MPP <https://edebreuv.gitlabpages.inria.fr/Obj.MPP>`_.\n\n\n\nContributions\n-------------\n\nThe optional, periodic detection refinement step is not part of the original Marked Point Process object detection method (see the Gamal Eldin *et al* reference in the documentation). It is an heuristic addition. While using Obj.MPP on images containing many objects with this refinement step on, Xavier Descombes noticed that, after some iterations, each iteration was taking very long to complete. He hypothesized that the refinement step was applied in each iteration instead of happening with the specified period. He was right since I had forgotten to reset the refinement-related counter after application.\n\nSome features of Obj.MPP were added upon request:\n\n- Florence Besse and Fabienne de Graeve requested the possibility to ignore some image segments in the computation of an object quality. Note that this can also be done by writing a dedicated quality function, although it requires coding skills of course.\n- Xavier Descombes requested the possibility to combine the object quality with the object area in order to favor a larger, encompassing object over smaller adjacent objects, or not. Note that this can also be done by writing a dedicated quality function, although it requires coding skills of course.\n\n\n\nThanks\n------\n\nThe project is developed with `PyCharm Community <https://www.jetbrains.com/pycharm>`_.\n\nThe development relies on several open-source packages (see ``install_requires`` in ``setup.py``).\n\nThe code is formatted by `Black <https://github.com/psf/black>`_, *The Uncompromising Code Formatter*.\n\nThe imports are ordered by `isort <https://github.com/timothycrosley/isort>`_... *your imports, so you don't have to*.\n\nThe HTML documentation is generated by `SPHINX <https://www.sphinx-doc.org>`_, *Python Documentation Generator*.\n\nThe package requirement list is generated by `pigar <https://github.com/damnever/pigar>`_.\n",
    "bugtrack_url": null,
    "license": "CeCILL-2.1",
    "summary": "Object/pattern detection using a Marked Point Process",
    "version": "2023.3",
    "project_urls": {
        "Documentation": "https://edebreuv.gitlabpages.inria.fr/Obj.MPP",
        "Homepage": "https://gitlab.inria.fr/edebreuv/Obj.MPP",
        "Source": "https://gitlab.inria.fr/edebreuv/Obj.MPP"
    },
    "split_keywords": [
        "signal",
        "image",
        "image analysis",
        "object detection",
        "pattern detection",
        "marked point process"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "45941d10df9f50132aed99d8ed7700efee0a4292dd2e76e865a86bac5b529aee",
                "md5": "2dbb32568909519bf08b9706d079e0ee",
                "sha256": "de765620631cc254f0885896180f7d2f858400f026dfde862419e544cf3c7b2d"
            },
            "downloads": -1,
            "filename": "obj.mpp-2023.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2dbb32568909519bf08b9706d079e0ee",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 236416,
            "upload_time": "2023-05-03T15:19:47",
            "upload_time_iso_8601": "2023-05-03T15:19:47.766624Z",
            "url": "https://files.pythonhosted.org/packages/45/94/1d10df9f50132aed99d8ed7700efee0a4292dd2e76e865a86bac5b529aee/obj.mpp-2023.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-03 15:19:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "obj.mpp"
}
        
Elapsed time: 0.06255s