PyPatchMatch 2.0.1__py3-none-win_amd64.whl → 2.0.2__py3-none-win_amd64.whl

patchmatch/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '2.0.1'
-__version_tuple__ = version_tuple = (2, 0, 1)
+__version__ = version = '2.0.2'
+__version_tuple__ = version_tuple = (2, 0, 2)
 
 __commit_id__ = commit_id = None

patchmatch/patch_match.py

@@ -17,7 +17,6 @@ from __future__ import annotations
 
 import ctypes
 import logging
-import math
 import operator
 from collections.abc import Callable
 from typing import SupportsIndex, TypeAlias
@@ -44,7 +43,9 @@ ImageLike: TypeAlias = np.ndarray | Image.Image
 
 try:
     _lib: ctypes.CDLL | None = load_library()
-except OSError as e:
+except (OSError, AttributeError) as e:
+    # AttributeError: a library without the PM_* functions, e.g. one that 1.x
+    # compiled into the package directory and that pip does not remove on upgrade
     _lib = None
     logger.warning("patchmatch failed to load: %s", e)
 
@@ -54,6 +55,9 @@ patchmatch_available = _lib is not None
 # The native code computes 2 * patch_size + 1 as a C int.
 _MAX_PATCH_SIZE = (2**31 - 2) // 2
 
+# The native code takes a C float, which turns larger weights into infinity.
+_MAX_GUIDE_WEIGHT = float(np.finfo(np.float32).max)
+
 
 def _get_lib() -> ctypes.CDLL:
     if _lib is None:
@@ -62,10 +66,17 @@ def _get_lib() -> ctypes.CDLL:
 
 
 def set_random_seed(seed: int) -> None:
+    """Set the seed of the randomized search of all following inpaintings.
+
+    Every inpainting starts from this seed, so equal inputs give equal results. The
+    native code keeps it as a 32-bit unsigned int, so ``seed`` is taken modulo
+    ``2**32``: ``2**32`` behaves like 0 and -1 like ``2**32 - 1``.
+    """
     _get_lib().PM_set_random_seed(ctypes.c_uint(seed))
 
 
 def set_verbose(verbose: bool) -> None:
+    """Print the progress of all following inpaintings to stderr if ``verbose``."""
     _get_lib().PM_set_verbose(ctypes.c_int(verbose))
 
 
@@ -96,8 +107,7 @@ def inpaint(
     lib = _get_lib()
     patch_size = _check_patch_size(patch_size)
     image, mask, global_mask = _prepare_inputs(image, mask, global_mask)
-    # OpenCV 4.6 turns an empty image into one of shape (0, 0, 1)
-    if image.size == 0:
+    if not _has_holes(mask, global_mask):
         return image.copy()
 
     if global_mask is None:
@@ -140,15 +150,16 @@ def inpaint_regularity(
         raise ValueError("ijmap must only contain finite values")
     ijmap = np.ascontiguousarray(ijmap)
 
-    # the native code divides by 1 + guide_weight and indexes a table with the result
+    # the native code divides by 1 + guide_weight and indexes a table with the result;
+    # the comparison also rejects NaN
     guide_weight = float(guide_weight)
-    if not (math.isfinite(guide_weight) and guide_weight >= 0):
+    if not 0 <= guide_weight <= _MAX_GUIDE_WEIGHT:
         raise ValueError(
-            f"guide_weight must be a finite number >= 0, got {guide_weight}"
+            f"guide_weight must be between 0 and {_MAX_GUIDE_WEIGHT:g}, "
+            f"got {guide_weight}"
         )
 
-    # OpenCV 4.6 turns an empty image into one of shape (0, 0, 1)
-    if image.size == 0:
+    if not _has_holes(mask, global_mask):
         return image.copy()
 
     args = (ijmap, ctypes.c_int(patch_size), ctypes.c_float(guide_weight))
@@ -194,6 +205,19 @@ def _prepare_inputs(
     return image, mask, global_mask
 
 
+def _has_holes(mask: np.ndarray, global_mask: np.ndarray | None) -> bool:
+    """Whether a hole lies outside the global mask.
+
+    Otherwise the result equals the input, but the native code still runs every
+    level of the pyramid. This also covers empty images, which OpenCV 4.6 would
+    return with the shape (0, 0, 1).
+    """
+    holes = mask != 0
+    if global_mask is not None:
+        holes &= global_mask == 0
+    return bool(holes.any())
+
+
 def _call(func: Callable[..., CMatT], *args: object) -> np.ndarray:
     """Call ``func`` with arrays converted to pymats and copy the result."""
     lib = _get_lib()

{pypatchmatch-2.0.1.dist-info → pypatchmatch-2.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyPatchMatch
-Version: 2.0.1
+Version: 2.0.2
 Summary: This library implements the PatchMatch based inpainting algorithm.
 Keywords: inpainting,patchmatch,image-processing,opencv
 Author-Email: The InvokeAI Project <lincoln.stein@gmail.com>, Jiayuan Mao <maojiayuan@gmail.com>, Kyle Schouviller <kyle0654@hotmail.com>, Matthias Wild <mauwii@outlook.de>, Younesse ANDAM <younesse.andam@gmail.com>
@@ -42,7 +42,7 @@ and Python interfaces. This implementation is heavily based on the implementatio
 Younesse ANDAM: [younesse-cv/PatchMatch](https://github.com/younesse-cv/PatchMatch),
 with some bug fixes, and updates.
 
-![Birdhouses removed from a photo by patchmatch.inpaint](https://raw.githubusercontent.com/mauwii/PyPatchMatch/v2.0.1/examples/images/readme_example.jpg)
+![Birdhouses removed from a photo by patchmatch.inpaint](https://raw.githubusercontent.com/mauwii/PyPatchMatch/v2.0.2/examples/images/readme_example.jpg)
 
 From left to right: the photo, the input of
 [examples/py_example.py](https://github.com/mauwii/PyPatchMatch/blob/main/examples/py_example.py)
@@ -99,11 +99,12 @@ The previous import path `from patchmatch import patch_match` keeps working.
 pixels in each direction. Larger patches follow larger structures but are much slower;
 the default of 15 compares 31x31 patches, the examples use 3.
 
-`patchmatch.set_random_seed(seed)` sets the seed of the randomized search and
-`patchmatch.set_verbose(True)` prints the progress of the native code to stderr.
-`patchmatch.inpaint_regularity(image, mask, ijmap)` additionally guides the search with
-a regularity map, an HxWx3 float32 array with the regularity coordinates of each pixel
-in its first two channels. Its `guide_weight` must be at least 0.
+`patchmatch.set_random_seed(seed)` sets the seed of the randomized search, modulo
+`2**32`, and `patchmatch.set_verbose(True)` prints the progress of the native code to
+stderr. `patchmatch.inpaint_regularity(image, mask, ijmap)` additionally guides the
+search with a regularity map, an HxWx3 float32 array with the regularity coordinates of
+each pixel in its first two channels. Its `guide_weight` must be between 0 and the
+largest float32, about 3.4e38.
 
 C++ (see
 [examples/cpp_example.cpp](https://github.com/mauwii/PyPatchMatch/blob/main/examples/cpp_example.cpp),

pypatchmatch-2.0.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+patchmatch/__init__.py,sha256=Xg_AyDjCY9obrk95tzu6h0ox1fttEczi_OKu3ycsSvM,345
+patchmatch/_lib.py,sha256=KKEeHtn4I0IcRdG49FQV_xpezcar9LqlGD-kvf-pZiM,3740
+patchmatch/_version.py,sha256=ipBLbz_DzIdbN7o8rhQ_qQaSGyFnROBxzHlE8soIfNw,544
+patchmatch/patch_match.py,sha256=NPTKbLRc3IzbooV_5hu_imxBEZ2gbWyKLS0XRnjIVOE,9434
+patchmatch/patchmatch.dll,sha256=AQ_VgCwUpN7pisGgAOl5CtfIPWFIi3jrNwrd2-HkA90,1537024
+patchmatch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pypatchmatch-2.0.2.dist-info/METADATA,sha256=_hbdKCIKVMDP-ETiQmkwRsg4moMJrsu3yEakEGygFjk,8564
+pypatchmatch-2.0.2.dist-info/WHEEL,sha256=QOQSSLDAidk39OMVpTfE4kjgcxpaKg4ohhjJQ7vAJpA,102
+pypatchmatch-2.0.2.dist-info/licenses/LICENSE,sha256=6VGSBzoFC-2RWaUpfSom3IlBW3AZfOwDuZrVzOmfN_E,1101
+pypatchmatch-2.0.2.dist-info/licenses/opencv/dlpack-LICENSE,sha256=Po9rw5J2pYbWDIxars4v-YkmIYHPKz0qEo21j5epMAw,11345
+pypatchmatch-2.0.2.dist-info/licenses/opencv/flatbuffers-LICENSE.txt,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+pypatchmatch-2.0.2.dist-info/licenses/opencv/opencv-LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+pypatchmatch-2.0.2.dist-info/licenses/opencv/SoftFloat-COPYING.txt,sha256=DFsINlE22lJjnXd_Hr_AOYiwFp2AZVyQxZ8bP6PlJqI,1732
+pypatchmatch-2.0.2.dist-info/licenses/opencv/zlib-LICENSE,sha256=4y_04A2dlJMFN2NSkdo55-YScDM0v2_ejH8Whv6KRaI,1002
+pypatchmatch-2.0.2.dist-info/sboms/opencv.cdx.json,sha256=ATex-BysD8SgsmzwbF8T3jwHedHA_RBYyqgJlC-Amew,866
+pypatchmatch-2.0.2.dist-info/RECORD,,

pypatchmatch-2.0.1.dist-info/RECORD

@@ -1,16 +0,0 @@
-patchmatch/__init__.py,sha256=Xg_AyDjCY9obrk95tzu6h0ox1fttEczi_OKu3ycsSvM,345
-patchmatch/_lib.py,sha256=KKEeHtn4I0IcRdG49FQV_xpezcar9LqlGD-kvf-pZiM,3740
-patchmatch/_version.py,sha256=WnxfkVM6f3yHRZ22_TrCwE0MZX8yBFCWY5wMK7somiQ,544
-patchmatch/patch_match.py,sha256=WgStWyICUp97keT5CROxC1o-FjwlzhawcNUVst_Uolo,8328
-patchmatch/patchmatch.dll,sha256=yTDQlh4qliiHO64wdf8ec8b_jlVkf1vXkq-ajboj88E,1537024
-patchmatch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pypatchmatch-2.0.1.dist-info/METADATA,sha256=N2aNBni4y1UmC4zfGZnG7V9kaUAydDgymP4cyrYvATM,8510
-pypatchmatch-2.0.1.dist-info/WHEEL,sha256=QOQSSLDAidk39OMVpTfE4kjgcxpaKg4ohhjJQ7vAJpA,102
-pypatchmatch-2.0.1.dist-info/licenses/LICENSE,sha256=6VGSBzoFC-2RWaUpfSom3IlBW3AZfOwDuZrVzOmfN_E,1101
-pypatchmatch-2.0.1.dist-info/licenses/opencv/dlpack-LICENSE,sha256=Po9rw5J2pYbWDIxars4v-YkmIYHPKz0qEo21j5epMAw,11345
-pypatchmatch-2.0.1.dist-info/licenses/opencv/flatbuffers-LICENSE.txt,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-pypatchmatch-2.0.1.dist-info/licenses/opencv/opencv-LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-pypatchmatch-2.0.1.dist-info/licenses/opencv/SoftFloat-COPYING.txt,sha256=DFsINlE22lJjnXd_Hr_AOYiwFp2AZVyQxZ8bP6PlJqI,1732
-pypatchmatch-2.0.1.dist-info/licenses/opencv/zlib-LICENSE,sha256=4y_04A2dlJMFN2NSkdo55-YScDM0v2_ejH8Whv6KRaI,1002
-pypatchmatch-2.0.1.dist-info/sboms/opencv.cdx.json,sha256=ATex-BysD8SgsmzwbF8T3jwHedHA_RBYyqgJlC-Amew,866
-pypatchmatch-2.0.1.dist-info/RECORD,,