RLEMaskLib 0.0.0__tar.gz

rlemasklib-0.0.0/.github/workflows/python-publish.yml

@@ -0,0 +1,35 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install build dependencies
+        run: python -m pip install --upgrade build
+
+      - name: Build package distribution
+        run: python -m build --sdist
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

rlemasklib-0.0.0/.gitignore

@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+src/rlemasklib/rlemasklib_cython.c
+src/rlemasklib/oop_cython.c

rlemasklib-0.0.0/.readthedocs.yaml

@@ -0,0 +1,16 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.10"
+  commands:
+    - python -m pip install .
+    - python -m pip install --no-cache-dir -r docs/requirements.txt
+    - python -m sphinx -E -b html docs $READTHEDOCS_OUTPUT/html
+
+sphinx:
+   configuration: docs/conf.py

rlemasklib-0.0.0/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2023-2025, Istvan Sarandi
+Copyright (c) 2014, Piotr Dollar and Tsung-Yi Lin
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies,
+either expressed or implied, of the FreeBSD Project.

rlemasklib-0.0.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include src/rlemasklib/c/*.h
+include src/rlemasklib/c/*.c

rlemasklib-0.0.0/Makefile

@@ -0,0 +1,7 @@
+all:
+	python setup.py build_ext --inplace
+	rm -rf build
+
+install:
+	python setup.py build_ext install
+	rm -rf build

rlemasklib-0.0.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: RLEMaskLib
+Version: 0.0.0
+Summary: Manipulate run-length-encoded image masks
+Author-email: István Sárándi <istvan.sarandi@uni-tuebingen.de>
+License: Copyright (c) 2023-2025, Istvan Sarandi
+        Copyright (c) 2014, Piotr Dollar and Tsung-Yi Lin
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+        ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+        The views and conclusions contained in the software and documentation are those
+        of the authors and should not be interpreted as representing official policies,
+        either expressed or implied, of the FreeBSD Project.
+Project-URL: Homepage, https://github.com/isarandi/rlemasklib
+Project-URL: Repository, https://github.com/isarandi/rlemasklib
+Project-URL: Documentation, https://rlemasklib.readthedocs.io/
+Project-URL: Issues, https://github.com/isarandi/rlemasklib/issues
+Project-URL: Changelog, https://github.com/isarandi/rlemasklib/releases
+Project-URL: Author, https://istvansarandi.com
+Keywords: computer-vision,cython,image-processing,segmentation,run-length-encoding,rle,image-segmentation,mask,compression-algorithm,image-mask,runlengthencoding,run-length,image-masking
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Cython
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Dynamic: license-file
+
+# RLEMaskLib: Run-Length Encoded Mask Operations
+![Read the Docs](https://img.shields.io/readthedocs/rlemasklib) ![PyPI - Version](https://img.shields.io/pypi/v/rlemasklib)
+
+This library provides efficient run-length encoded (RLE) operations for binary masks in Python. It is designed to be fast and memory efficient, and is particularly useful for working with large datasets. The library provides an intuitive and extensive object-oriented interface as well as a simpler functional one. To achieve high efficiency, the core functionality is implemented in C, and wrapped via Cython.
+
+RLEMaskLib is fully compatible with the COCO mask format (in the form of dictionaries) but can also work directly with runlength sequences.
+
+The library provides many operations on masks, including:
+
+- Set operations (complement, difference, symmetric difference) and custom boolean functions.
+- Crop, pad, tile, concatenate
+- Connected components extraction
+- Warp (affine, perspective, lens distortion)
+- Transpose, flip, rotate by multiples of 90 degrees
+- Binary morphology: dilate, erode, open, close
+- Convolve with arbitrary kernels
+- Directly create fully foreground and fully background masks
+- Decompress of COCO's compressed RLE format to integer run-lengths, and vice versa
+- Extra compression (optional) using gzip on top of the LEB128-like encoding used by the COCO API (~40% reduction beyond
+  the COCO compression)
+- Object-oriented and functional APIs.
+
+
+This library originates as a fork of the [COCO API](https://github.com/cocodataset/cocoapi)'s `pycocotools.mask` module (which was originally written by Piotr Dollár and Tsung-Yi Lin) but now mostly consists of new code.
+
+
+## Installation
+
+```bash
+pip install rlemasklib
+```
+
+## Documentation
+
+See [https://rlemasklib.readthedocs.io/](https://rlemasklib.readthedocs.io/).

rlemasklib-0.0.0/README.md

@@ -0,0 +1,35 @@
+# RLEMaskLib: Run-Length Encoded Mask Operations
+![Read the Docs](https://img.shields.io/readthedocs/rlemasklib) ![PyPI - Version](https://img.shields.io/pypi/v/rlemasklib)
+
+This library provides efficient run-length encoded (RLE) operations for binary masks in Python. It is designed to be fast and memory efficient, and is particularly useful for working with large datasets. The library provides an intuitive and extensive object-oriented interface as well as a simpler functional one. To achieve high efficiency, the core functionality is implemented in C, and wrapped via Cython.
+
+RLEMaskLib is fully compatible with the COCO mask format (in the form of dictionaries) but can also work directly with runlength sequences.
+
+The library provides many operations on masks, including:
+
+- Set operations (complement, difference, symmetric difference) and custom boolean functions.
+- Crop, pad, tile, concatenate
+- Connected components extraction
+- Warp (affine, perspective, lens distortion)
+- Transpose, flip, rotate by multiples of 90 degrees
+- Binary morphology: dilate, erode, open, close
+- Convolve with arbitrary kernels
+- Directly create fully foreground and fully background masks
+- Decompress of COCO's compressed RLE format to integer run-lengths, and vice versa
+- Extra compression (optional) using gzip on top of the LEB128-like encoding used by the COCO API (~40% reduction beyond
+  the COCO compression)
+- Object-oriented and functional APIs.
+
+
+This library originates as a fork of the [COCO API](https://github.com/cocodataset/cocoapi)'s `pycocotools.mask` module (which was originally written by Piotr Dollár and Tsung-Yi Lin) but now mostly consists of new code.
+
+
+## Installation
+
+```bash
+pip install rlemasklib
+```
+
+## Documentation
+
+See [https://rlemasklib.readthedocs.io/](https://rlemasklib.readthedocs.io/).

rlemasklib-0.0.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

rlemasklib-0.0.0/docs/_static/styles/my_theme.css

@@ -0,0 +1,76 @@
+@import url("theme.css");
+@import url("https://fonts.googleapis.com/css2?family=Mona+Sans:ital,wght@0,200..900;1,200..900&family=Geist:wght@100..900&&family=JetBrains+Mono:ital,wght@0,100..800;1,100..800&family=Outfit:wght@100..900&display=swap");
+
+/*@media (min-width: 960px) {
+    .bd-page-width {
+        max-width: 120rem;
+    }
+}*/
+
+#rtd-footer-container {
+    margin-top: 0 !important;
+}
+
+html[data-theme="light"] {
+    --pst-color-table-row-hover-bg: #dfc6ff;
+    --pst-color-link-hover: #845818;
+}
+
+html[data-theme="dark"] {
+    --pst-color-table-row-hover-bg: #41296c;
+    --pst-color-inline-code: #dd8cd4;
+}
+
+
+html[data-theme="dark"] dt:target {
+    background-color: #4f4500;
+}
+
+html[data-theme="dark"] .linkcode-link {
+    color: #9090ff;
+}
+
+html[data-theme="dark"] table.indextable tr.cap {
+    background-color: #464646;
+}
+
+html[data-theme="dark"] a:visited {
+    color: #9E67D0;
+}
+
+.navbar-brand .logo__title {
+    font-family: "Mona Sans", sans-serif;
+    font-size: 2.5rem;
+    font-weight: 400;
+    font-style: normal;
+}
+
+:root {
+    --pst-font-family-monospace: "JetBrains Mono", monospace;
+    --pst-font-family-heading: "Mona Sans", sans-serif;
+    --pst-font-family-base: "Mona Sans", sans-serif;
+}
+
+body {
+    font-weight: 450;
+}
+
+.bd-main .bd-content .bd-article-container {
+  max-width: 100%;  /* default is 60em */
+}
+
+/*.bd-sidebar-primary {
+    max-width: 20%;
+}*/
+
+/* Ensure links in code blocks are underlined */
+.highlight a {
+    text-decoration: underline;
+    color: #394198; /* Adjust color as needed */
+}
+
+/* For additional emphasis, change hover effect */
+.highlight a:hover {
+    text-decoration: underline;
+    color: #9090ff;
+}

rlemasklib-0.0.0/docs/_templates/autoapi/index.rst

@@ -0,0 +1,11 @@
+API Reference
+=============
+
+Start at :class:`rlemasklib.RLEMask` to explore the object-oriented API.
+
+.. toctree::
+   :titlesonly:
+
+   {% for page in pages|selectattr("is_top_level_object") %}
+   {{ page.include_path }}
+   {% endfor %}

rlemasklib-0.0.0/docs/_templates/autoapi/python/attribute.rst

@@ -0,0 +1 @@
+{% extends "python/data.rst" %}

rlemasklib-0.0.0/docs/_templates/autoapi/python/class.rst

@@ -0,0 +1,150 @@
+:html_theme.sidebar_secondary.remove: true
+
+{% if obj.display %}
+   {% if is_own_page %}
+{{ obj.name }}
+{{ "=" * obj.name | length }}
+
+   {% endif %}
+   {% set visible_children = obj.children|selectattr("display")|list %}
+   {% set own_page_children = visible_children|selectattr("type", "in", own_page_types)|list %}
+   {% if is_own_page and own_page_children %}
+.. toctree::
+   :hidden:
+
+      {% for child in own_page_children %}
+   {{ child.include_path }}
+      {% endfor %}
+
+   {% endif %}
+.. py:{{ obj.type }}:: {% if is_own_page %}{{ obj.id }}{% else %}{{ obj.short_name }}{% endif %}{% if obj.args %}({{ obj.args }}){% endif %}
+
+   {% for (args, return_annotation) in obj.overloads %}
+      {{ " " * (obj.type | length) }}   {{ obj.short_name }}{% if args %}({{ args }}){% endif %}
+
+   {% endfor %}
+   {% if obj.bases %}
+      {% if "show-inheritance" in autoapi_options %}
+
+   Bases: {% for base in obj.bases %}{{ base|link_objs }}{% if not loop.last %}, {% endif %}{% endfor %}
+      {% endif %}
+
+
+      {% if "show-inheritance-diagram" in autoapi_options and obj.bases != ["object"] %}
+   .. autoapi-inheritance-diagram:: {{ obj.obj["full_name"] }}
+      :parts: 1
+         {% if "private-members" in autoapi_options %}
+      :private-bases:
+         {% endif %}
+
+      {% endif %}
+   {% endif %}
+   {% if obj.docstring %}
+
+   {{ obj.docstring|indent(3) }}
+   {% endif %}
+   {% for obj_item in visible_children %}
+      {% if obj_item.type not in own_page_types %}
+
+   {{ obj_item.render()|indent(3) }}
+      {% endif %}
+   {% endfor %}
+   {% if is_own_page and own_page_children %}
+      {% set visible_attributes = own_page_children|selectattr("type", "equalto", "attribute")|list %}
+      {% if visible_attributes %}
+Attributes
+----------
+
+.. autoapisummary::
+
+         {% for attribute in visible_attributes %}
+   {{ attribute.id }}
+         {% endfor %}
+
+
+      {% endif %}
+      {% set visible_properties = own_page_children|selectattr("type", "equalto", "property")|list %}
+      {% if visible_properties %}
+Properties
+----------
+
+.. autoapisummary::
+
+            {% for property in visible_properties %}
+   {{ property.id }}
+            {% endfor %}
+
+
+      {% endif %}
+      {% set visible_exceptions = own_page_children|selectattr("type", "equalto", "exception")|list %}
+      {% if visible_exceptions %}
+Exceptions
+----------
+
+.. autoapisummary::
+
+         {% for exception in visible_exceptions %}
+   {{ exception.id }}
+         {% endfor %}
+
+
+      {% endif %}
+      {% set visible_classes = own_page_children|selectattr("type", "equalto", "class")|list %}
+      {% if visible_classes %}
+Classes
+-------
+
+.. autoapisummary::
+
+         {% for klass in visible_classes %}
+   {{ klass.id }}
+         {% endfor %}
+
+
+      {% endif %}
+
+      {% set static_methods = own_page_children|selectattr("type", "equalto", "method")|selectattr("properties", "defined")|selectattr("properties", "equalto", ["staticmethod"])|list %}
+      {% set class_methods = own_page_children|selectattr("type", "equalto", "method")|selectattr("properties", "defined")|selectattr("properties", "equalto", ["classmethod"])|list %}
+      {% set instance_methods = own_page_children|selectattr("type", "equalto", "method")|rejectattr("properties", "equalto", ["staticmethod"])|rejectattr("properties", "equalto", ["classmethod"])|list %}
+
+      {% if instance_methods %}
+Instance Methods
+----------------
+
+.. autoapisummary::
+
+         {% for method in instance_methods %}
+   {{ method.id }}
+         {% endfor %}
+
+
+      {% endif %}
+      {% if class_methods %}
+Class Methods
+-------------
+
+.. autoapisummary::
+
+         {% for method in class_methods %}
+   {{ method.id }}
+         {% endfor %}
+
+
+      {% endif %}
+      {% if static_methods %}
+Static Methods
+--------------
+
+.. autoapisummary::
+
+         {% for method in static_methods %}
+   {{ method.id }}
+         {% endfor %}
+
+
+      {% endif %}
+   {% endif %}
+{% endif %}
+
+
+.. footbibliography::

rlemasklib-0.0.0/docs/_templates/autoapi/python/data.rst

@@ -0,0 +1,42 @@
+:html_theme.sidebar_secondary.remove: true
+
+{% if obj.display %}
+   {% if is_own_page %}
+{{ obj.name }}
+{{ "=" * obj.name | length }}
+
+   {% endif %}
+.. py:{{ obj.type }}:: {% if is_own_page %}{{ obj.id }}{% else %}{{ obj.name }}{% endif %}
+   {% if obj.annotation is not none %}
+
+   :type: {% if obj.annotation %} {{ obj.annotation }}{% endif %}
+   {% endif %}
+   {% if obj.value is not none %}
+
+      {% if obj.value.splitlines()|count > 1 %}
+   :value: Multiline-String
+
+   .. raw:: html
+
+      <details><summary>Show Value</summary>
+
+   .. code-block:: python
+
+      {{ obj.value|indent(width=6,blank=true) }}
+
+   .. raw:: html
+
+      </details>
+
+      {% else %}
+   :value: {{ obj.value|truncate(100) }}
+      {% endif %}
+   {% endif %}
+
+   {% if obj.docstring %}
+
+   {{ obj.docstring|indent(3) }}
+   {% endif %}
+{% endif %}
+
+.. footbibliography::

rlemasklib-0.0.0/docs/_templates/autoapi/python/exception.rst

@@ -0,0 +1 @@
+{% extends "python/class.rst" %}