Perception 0.8.0__tar.gz → 0.8.2__tar.gz

{perception-0.8.0 → perception-0.8.2}/PKG-INFO

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: Perception
-Version: 0.8.0
+Version: 0.8.2
 Summary: Perception provides flexible, well-documented, and comprehensively tested tooling for perceptual hashing research, development, and production use.
 License: Apache-2.0
+License-File: LICENSE
 Author: Thorn
 Author-email: info@wearethorn.org
 Requires-Python: >=3.10,<4.0
@@ -12,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Provides-Extra: benchmarking
 Provides-Extra: experimental
 Provides-Extra: matching

{perception-0.8.0 → perception-0.8.2}/perception/hashers/tools.py

@@ -1070,3 +1070,31 @@ def unletterbox(
     bounds = (x1, x2 + 1), (y1, y2 + 1)
 
     return bounds
+
+
+def unletterbox_crop(
+    image: np.ndarray, min_fraction_meaningful_pixels: float = 0.1
+) -> np.ndarray | None:
+    """Detect and crop the letterboxed regions from an image.
+
+    Args:
+        image: The image from which to remove letterboxing.
+        min_fraction_meaningful_pixels: 0 to 1: if cropped version is
+        smaller than this fraction of the image do not unletterbox.
+        0.1 == 10% of the image.
+    Returns:
+        The cropped image or None if the image is mostly blank space.
+    """
+    assert isinstance(
+        image, np.ndarray
+    ), "Please send np.ndarray to unletterbox_image()."
+
+    bounds = unletterbox(
+        image, min_fraction_meaningful_pixels=min_fraction_meaningful_pixels
+    )
+    if bounds is None:
+        return None
+    (x1, x2), (y1, y2) = bounds
+    cropped = np.ascontiguousarray(image[y1:y2, x1:x2])
+    assert cropped.data.contiguous
+    return cropped

{perception-0.8.0 → perception-0.8.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "Perception"
-version = "0.8.0"
+version = "0.8.2"
 description = "Perception provides flexible, well-documented, and comprehensively tested tooling for perceptual hashing research, development, and production use."
 authors = ["Thorn <info@wearethorn.org>"]
 license = "Apache License 2.0"
@@ -17,10 +17,10 @@ Pillow = "*"
 pywavelets = "^1.5.0"
 tqdm = "*"
 validators = ">=0.22, <1.0"
+scipy = "*"
 
 # Benchmarking Extras
 matplotlib = { version = "*", optional = true }
-scipy = { version = "*", optional = true }
 imgaug = { version = "*", optional = true }
 tabulate = { version = "*", optional = true }
 scikit-learn = { version = "*", optional = true }

{perception-0.8.0 → perception-0.8.2}/setup.py

@@ -26,8 +26,8 @@ install_requires = \
  'validators>=0.22,<1.0']
 
 extras_require = \
-{'benchmarking': ['matplotlib',
-                  'scipy',
+{':extra == "benchmarking"': ['scipy'],
+ 'benchmarking': ['matplotlib',
                   'imgaug',
                   'tabulate',
                   'scikit-learn',
@@ -37,7 +37,7 @@ extras_require = \
 
 setup_kwargs = {
     'name': 'Perception',
-    'version': '0.8.0',
+    'version': '0.8.2',
     'description': 'Perception provides flexible, well-documented, and comprehensively tested tooling for perceptual hashing research, development, and production use.',
     'long_description': "# perception ![ci](https://github.com/thorn-oss/perception/workflows/ci/badge.svg)\n\n`perception` provides flexible, well-documented, and comprehensively tested tooling for perceptual hashing research, development, and production use. See [the documentation](https://perception.thorn.engineering/en/latest/) for details.\n\n## Background\n\n`perception` was initially developed at [Thorn](https://www.thorn.org) as part of our work to eliminate child sexual abuse material from the internet. For more information on the issue, check out [our CEO's TED talk](https://www.thorn.org/blog/time-is-now-eliminate-csam/).\n\n## Getting Started\n\n### Installation\n\n`pip install perception`\n\n### Hashing\n\nHashing with different functions is simple with `perception`.\n\n```python\nfrom perception import hashers\n\nfile1, file2 = 'test1.jpg', 'test2.jpg'\nhasher = hashers.PHash()\nhash1, hash2 = hasher.compute(file1), hasher.compute(file2)\ndistance = hasher.compute_distance(hash1, hash2)\n```\n\n### Examples\n\nSee below for end-to-end examples for common use cases for perceptual hashes.\n\n- [Detecting child sexual abuse material](https://perception.thorn.engineering/en/latest/examples/detecting_csam.html)\n- [Deduplicating media](https://perception.thorn.engineering/en/latest/examples/deduplication.html)\n- [Benchmarking perceptual hashes](https://perception.thorn.engineering/en/latest/examples/benchmarking.html)\n\n## Supported Hashing Algorithms\n\n`perception` currently ships with:\n\n- pHash (DCT hash) (`perception.hashers.PHash`)\n- Facebook's PDQ Hash (`perception.hashers.PDQ`)\n- dHash (difference hash) (`perception.hashers.DHash`)\n- aHash (average hash) (`perception.hashers.AverageHash`)\n- Marr-Hildreth (`perception.hashers.MarrHildreth`)\n- Color Moment (`perception.hashers.ColorMoment`)\n- Block Mean (`perception.hashers.BlockMean`)\n- wHash (wavelet hash) (`perception.hashers.WaveletHash`)\n\n## Contributing\n\nTo work on the project, start by doing the following.\n\n```bash\n# Install local dependencies for\n# code completion, etc.\nmake init\n\n- To do a (close to) comprehensive check before committing code, you can use `make precommit`.\n\nTo implement new features, please first file an issue proposing your change for discussion.\n\nTo report problems, please file an issue with sample code, expected results, actual results, and a complete traceback.\n\n## Alternatives\n\nThere are other packages worth checking out to see if they meet your needs for perceptual hashing. Here are some\nexamples.\n\n- [dedupe](https://github.com/dedupeio/dedupe)\n- [imagededup](https://idealo.github.io/imagededup/)\n- [ImageHash](https://github.com/JohannesBuchner/imagehash)\n- [PhotoHash](https://github.com/bunchesofdonald/photohash)\n```\n",
     'author': 'Thorn',