Metadata-Version: 2.4
Name: obj.mpp
Version: 2026.4
Summary: Object/pattern detection using a Marked Point Process
Home-page: https://src.koda.cnrs.fr/eric.debreuve/Obj.MPP/
Author: Eric Debreuve
Author-email: eric.debreuve@cnrs.fr
License: CeCILL-2.1
Project-URL: Documentation, https://src.koda.cnrs.fr/eric.debreuve/Obj.MPP/-/wikis/home
Project-URL: Source, https://src.koda.cnrs.fr/eric.debreuve/Obj.MPP/
Keywords: image,signal,object detection,pattern detection,marked point process
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: CEA CNRS Inria Logiciel Libre License, version 2.1 (CeCILL-2.1)
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
Requires-Dist: Pillow
Requires-Dist: conf-ini-g
Requires-Dist: imageio
Requires-Dist: json-any
Requires-Dist: logger-36
Requires-Dist: matplotlib
Requires-Dist: mpss_tools_36
Requires-Dist: networkx
Requires-Dist: numpy
Requires-Dist: p-pattern
Requires-Dist: platformdirs
Requires-Dist: rich
Requires-Dist: scikit-image
Requires-Dist: scipy
Requires-Dist: value_factory
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

..
   SEE COPYRIGHT and LICENCE NOTICES: files README-COPYRIGHT-utf8.txt and
   README-LICENCE-utf8.txt at project source root.

.. |PROJECT_NAME|      replace:: Obj.MPP
.. |SHORT_DESCRIPTION| replace:: Object/pattern detection using a Marked Point Process

.. |PYPI_NAME_LITERAL| replace:: ``obj.mpp``
.. |PYPI_PROJECT_URL|  replace:: https://pypi.org/project/obj.mpp/
.. _PYPI_PROJECT_URL:  https://pypi.org/project/obj.mpp/

.. |DOCUMENTATION_URL| replace:: https://src.koda.cnrs.fr/eric.debreuve/Obj.MPP/-/wikis/home
.. _DOCUMENTATION_URL: https://src.koda.cnrs.fr/eric.debreuve/Obj.MPP/-/wikis/home

.. |DEPENDENCIES_MANDATORY| replace:: Pillow, conf-ini-g, imageio, json-any, logger-36, matplotlib, mpss_tools_36, networkx, numpy, p-pattern, platformdirs, rich, scikit-image, scipy, value_factory
.. |DEPENDENCIES_OPTIONAL|  replace:: None



===================================
|PROJECT_NAME|: |SHORT_DESCRIPTION|
===================================



Documentation
=============

The documentation is available at |DOCUMENTATION_URL|_.



Installation
============

This project is published
on the `Python Package Index (PyPI) <https://pypi.org/>`_
at: |PYPI_PROJECT_URL|_.
It should be installable from Python distribution platforms or Integrated Development Environments (IDEs).
Otherwise, it can be installed from a command console using `pip <https://pip.pypa.io/>`_:

+--------------+-------------------------------------------------------+----------------------------------------------------------+
|              | For all users (after acquiring administrative rights) | For the current user (no administrative rights required) |
+==============+=======================================================+==========================================================+
| Installation | ``pip install`` |PYPI_NAME_LITERAL|                   | ``pip install --user`` |PYPI_NAME_LITERAL|               |
+--------------+-------------------------------------------------------+----------------------------------------------------------+
| Update       | ``pip install --upgrade`` |PYPI_NAME_LITERAL|         | ``pip install --user --upgrade`` |PYPI_NAME_LITERAL|     |
+--------------+-------------------------------------------------------+----------------------------------------------------------+



Dependencies
============

The development relies on several packages:

- Mandatory: |DEPENDENCIES_MANDATORY|
- Optional:  |DEPENDENCIES_OPTIONAL|

The mandatory dependencies, if any, are installed automatically by `pip <https://pip.pypa.io/>`_, if they are not already, as part of the installation of |PROJECT_NAME|.
Python distribution platforms or Integrated Development Environments (IDEs) should also take care of this.
The optional dependencies, if any, must be installed independently by following the related instructions, for added functionalities of |PROJECT_NAME|.



Implementation notes
====================

- 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.
- When using the refinement step, 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: the reset of the refinement-related counter after application had been forgotten.



Acknowledgments
===============

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
    :target: https://pycqa.github.io/isort/

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

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*.
