jdeskew 0.2.2__tar.gz → 0.3.0__tar.gz

{jdeskew-0.2.2 → jdeskew-0.3.0}/.circleci/config.yml

@@ -8,7 +8,7 @@ executors:
     docker:
       - image: cimg/python:3.9
     environment:
-      TZ: "Asia/Ho_Chi_Minh"
+      TZ: "Australia/Melbourne"
 
 jobs:
   build-and-test:

{jdeskew-0.2.2 → jdeskew-0.3.0}/.github/workflows/python-package.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11",  "3.12"]
 
     steps:
       - uses: actions/checkout@v3

{jdeskew-0.2.2 → jdeskew-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: jdeskew
-Version: 0.2.2
+Version: 0.3.0
 Summary: Document Image Skew Estimation using Adaptive Radial Projection
 Author-email: Luan Pham <phamquiluan@gmail.com>
 License: MIT License
@@ -26,13 +26,22 @@ License: MIT License
         SOFTWARE.
         
 Description-Content-Type: text/markdown
-Provides-Extra: dev
 License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: opencv-python-headless
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: fastapi; extra == "dev"
+Requires-Dist: uvicorn[standard]; extra == "dev"
+Requires-Dist: python-multipart; extra == "dev"
+Dynamic: license-file
 
 # Document Image Skew Estimation
 
-*To my love, Jenna*
-
 [![pypi package](https://img.shields.io/pypi/v/jdeskew.svg)](https://pypi.org/project/jdeskew)
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/phamquiluan/jdeskew/tree/master.svg?style=svg&circle-token=f409daaab0e6671c81bb4b266b387fe933c131eb)](https://dl.circleci.com/status-badge/redirect/gh/phamquiluan/jdeskew/tree/master)
 [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/25553a5195074e37a01dd3370c55abaa)](https://www.codacy.com/gh/phamquiluan/jdeskew/dashboard?utm_source=github.com&utm_medium=referral&utm_content=phamquiluan/jdeskew&utm_campaign=Badge_Coverage)
@@ -153,6 +162,8 @@ This datasets are built upon three other datasets: DISEC 2013, RVL-CDIP, RDCL 20
 | DISE 2021 (45 degree) | https://drive.google.com/file/d/1a-a6aOqdsghjeHGLnCLsDs7NoJIus-Pw/view?usp=sharing |
 | DISE 2021 (15 degree) | https://drive.google.com/file/d/1BLiuu-j28dbuPFi4n3C0KuV6vXGmB0qS/view?usp=sharing |
 
+Can also download from Zenodo: https://zenodo.org/records/12570649
+
 ## Reproducibility and Evaluation Code
 
 Check the [reproduce.ipynb](reproduce.ipynb) file
@@ -170,3 +181,7 @@ L. Pham, H. Hoang, X.T. Mai, T. A. Tran, "Adaptive Radial Projection on Fourier
   organization={IEEE}
 }
 ```
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=phamquiluan/jdeskew&type=Date)](https://star-history.com/#phamquiluan/jdeskew&Date)

{jdeskew-0.2.2 → jdeskew-0.3.0}/README.md

@@ -1,7 +1,5 @@
 # Document Image Skew Estimation
 
-*To my love, Jenna*
-
 [![pypi package](https://img.shields.io/pypi/v/jdeskew.svg)](https://pypi.org/project/jdeskew)
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/phamquiluan/jdeskew/tree/master.svg?style=svg&circle-token=f409daaab0e6671c81bb4b266b387fe933c131eb)](https://dl.circleci.com/status-badge/redirect/gh/phamquiluan/jdeskew/tree/master)
 [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/25553a5195074e37a01dd3370c55abaa)](https://www.codacy.com/gh/phamquiluan/jdeskew/dashboard?utm_source=github.com&utm_medium=referral&utm_content=phamquiluan/jdeskew&utm_campaign=Badge_Coverage)
@@ -122,6 +120,8 @@ This datasets are built upon three other datasets: DISEC 2013, RVL-CDIP, RDCL 20
 | DISE 2021 (45 degree) | https://drive.google.com/file/d/1a-a6aOqdsghjeHGLnCLsDs7NoJIus-Pw/view?usp=sharing |
 | DISE 2021 (15 degree) | https://drive.google.com/file/d/1BLiuu-j28dbuPFi4n3C0KuV6vXGmB0qS/view?usp=sharing |
 
+Can also download from Zenodo: https://zenodo.org/records/12570649
+
 ## Reproducibility and Evaluation Code
 
 Check the [reproduce.ipynb](reproduce.ipynb) file
@@ -139,3 +139,7 @@ L. Pham, H. Hoang, X.T. Mai, T. A. Tran, "Adaptive Radial Projection on Fourier
   organization={IEEE}
 }
 ```
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=phamquiluan/jdeskew&type=Date)](https://star-history.com/#phamquiluan/jdeskew&Date)

{jdeskew-0.2.2 → jdeskew-0.3.0}/jdeskew/estimator.py

@@ -1,9 +1,10 @@
 """Skew Estimator."""
 import cv2
 import numpy as np
+from typing import Optional
 
 
-def _ensure_gray(image):
+def _ensure_gray(image: np.ndarray) -> np.ndarray:
     try:
         image = cv2.cvtColor(image, cv2.COLOR_BGR2GRAY)
     except cv2.error:
@@ -11,7 +12,7 @@ def _ensure_gray(image):
     return image
 
 
-def _ensure_optimal_square(image):
+def _ensure_optimal_square(image: np.ndarray) -> np.ndarray:
     assert image is not None, image
     nw = nh = cv2.getOptimalDFTSize(max(image.shape[:2]))
     output_image = cv2.copyMakeBorder(
@@ -26,7 +27,7 @@ def _ensure_optimal_square(image):
     return output_image
 
 
-def _get_fft_magnitude(image):
+def _get_fft_magnitude(image: np.ndarray) -> np.ndarray:
     gray = _ensure_gray(image)
     opt_gray = _ensure_optimal_square(gray)
 
@@ -35,7 +36,7 @@ def _get_fft_magnitude(image):
         ~opt_gray, 255, cv2.ADAPTIVE_THRESH_GAUSSIAN_C, cv2.THRESH_BINARY, 15, -10
     )
 
-    # perform fft
+    # perform fft - using fft2 to ensure square output
     dft = np.fft.fft2(opt_gray)
     shifted_dft = np.fft.fftshift(dft)
 
@@ -44,7 +45,7 @@ def _get_fft_magnitude(image):
     return magnitude
 
 
-def _get_angle_radial_projection(m, angle_max=None, num=None, W=None):
+def _get_angle_radial_projection(m: np.ndarray, angle_max: Optional[float] = None, num: Optional[int] = None) -> float:
     """Get angle via radial projection.
 
     Arguments:
@@ -57,42 +58,45 @@ def _get_angle_radial_projection(m, angle_max=None, num=None, W=None):
     r = c = m.shape[0] // 2
 
     if angle_max is None:
-        pass
+        angle_max = 15.0
 
     if num is None:
         num = 20
 
     tr = np.linspace(-1 * angle_max, angle_max, int(angle_max * num * 2)) / 180 * np.pi
-    profile_arr = tr.copy()
 
-    def f(t):
-        _f = np.vectorize(
-            lambda x: m[c + int(x * np.cos(t)), c + int(-1 * x * np.sin(t))]
-        )
-        _l = _f(range(0, r))
-        val_init = np.sum(_l)
-        return val_init
+    # Pre-allocate array for better performance
+    li = np.zeros_like(tr)
 
-    vf = np.vectorize(f)
-    li = vf(profile_arr)
+    for i, t in enumerate(tr):
+        x = np.arange(0, r)
+        y = c + np.int32(x * np.cos(t))
+        x = c + np.int32(-1 * x * np.sin(t))
+        # Use boolean indexing for faster computation
+        valid_indices = (y >= 0) & (y < m.shape[0]) & (x >= 0) & (x < m.shape[1])
+        li[i] = np.sum(m[y[valid_indices], x[valid_indices]])
 
     a = tr[np.argmax(li)] / np.pi * 180
 
     if a == -1 * angle_max:
-        return 0
-    return a
+        return 0.0
+    return float(a)
 
 
 def get_angle(
-    image: np.ndarray, vertical_image_shape: int = None, angle_max: float = None
-):
+    image: np.ndarray,
+    vertical_image_shape: Optional[int] = None,
+    angle_max: Optional[float] = None
+) -> float:
     """Getting angle from a given document image.
 
-    image : np.ndarray
-    vertical_image_shape : int
-      resize image as preprocessing
-    angle_max : float
-      maximum angle to searching
+    Args:
+        image: Input image as numpy array
+        vertical_image_shape: Optional resize height for preprocessing
+        angle_max: Maximum angle to search for
+
+    Returns:
+        float: Estimated skew angle in degrees
     """
     assert isinstance(image, np.ndarray), image
 
@@ -100,7 +104,7 @@ def get_angle(
     #     vertical_image_shape = 512
 
     if angle_max is None:
-        angle_max = 15
+        angle_max = 15.0
 
     # resize
     if vertical_image_shape is not None:

{jdeskew-0.2.2 → jdeskew-0.3.0}/jdeskew/utility.py

@@ -2,7 +2,7 @@
 import cv2
 
 
-def rotate(image, angle, resize=True, border_mode=None, border_value=None):
+def rotate(image, angle, resize=True, border_mode=None, border_value=None, flags=None):
     """Rotate input image respect to a given angle.
 
     Params:
@@ -13,6 +13,9 @@ def rotate(image, angle, resize=True, border_mode=None, border_value=None):
     """
     if border_mode is None:
         border_mode = cv2.BORDER_CONSTANT
+    if flags is None:
+        # flags=cv2.INTER_NEAREST
+        flags = cv2.INTER_LINEAR
 
     h, w = image.shape[:2]
     M = cv2.getRotationMatrix2D(center=(w // 2, h // 2), angle=angle, scale=1.0)
@@ -20,8 +23,7 @@ def rotate(image, angle, resize=True, border_mode=None, border_value=None):
         src=image,
         M=M,
         dsize=(w, h),
-        # flags=cv2.INTER_CUBIC,
-        flags=cv2.INTER_NEAREST,
+        flags=flags,
         borderMode=border_mode,
         borderValue=None if border_mode == cv2.BORDER_REPLICATE else border_value,
     )

{jdeskew-0.2.2 → jdeskew-0.3.0}/jdeskew.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: jdeskew
-Version: 0.2.2
+Version: 0.3.0
 Summary: Document Image Skew Estimation using Adaptive Radial Projection
 Author-email: Luan Pham <phamquiluan@gmail.com>
 License: MIT License
@@ -26,13 +26,22 @@ License: MIT License
         SOFTWARE.
         
 Description-Content-Type: text/markdown
-Provides-Extra: dev
 License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: opencv-python-headless
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: fastapi; extra == "dev"
+Requires-Dist: uvicorn[standard]; extra == "dev"
+Requires-Dist: python-multipart; extra == "dev"
+Dynamic: license-file
 
 # Document Image Skew Estimation
 
-*To my love, Jenna*
-
 [![pypi package](https://img.shields.io/pypi/v/jdeskew.svg)](https://pypi.org/project/jdeskew)
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/phamquiluan/jdeskew/tree/master.svg?style=svg&circle-token=f409daaab0e6671c81bb4b266b387fe933c131eb)](https://dl.circleci.com/status-badge/redirect/gh/phamquiluan/jdeskew/tree/master)
 [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/25553a5195074e37a01dd3370c55abaa)](https://www.codacy.com/gh/phamquiluan/jdeskew/dashboard?utm_source=github.com&utm_medium=referral&utm_content=phamquiluan/jdeskew&utm_campaign=Badge_Coverage)
@@ -153,6 +162,8 @@ This datasets are built upon three other datasets: DISEC 2013, RVL-CDIP, RDCL 20
 | DISE 2021 (45 degree) | https://drive.google.com/file/d/1a-a6aOqdsghjeHGLnCLsDs7NoJIus-Pw/view?usp=sharing |
 | DISE 2021 (15 degree) | https://drive.google.com/file/d/1BLiuu-j28dbuPFi4n3C0KuV6vXGmB0qS/view?usp=sharing |
 
+Can also download from Zenodo: https://zenodo.org/records/12570649
+
 ## Reproducibility and Evaluation Code
 
 Check the [reproduce.ipynb](reproduce.ipynb) file
@@ -170,3 +181,7 @@ L. Pham, H. Hoang, X.T. Mai, T. A. Tran, "Adaptive Radial Projection on Fourier
   organization={IEEE}
 }
 ```
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=phamquiluan/jdeskew&type=Date)](https://star-history.com/#phamquiluan/jdeskew&Date)

{jdeskew-0.2.2 → jdeskew-0.3.0}/jdeskew.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ LICENSE
 README.md
 cog.yaml
 estimator.py
+icip_paper.pdf
 main.py
 pyproject.toml
 reproduce.ipynb

{jdeskew-0.2.2 → jdeskew-0.3.0}/tests/test.py

@@ -19,7 +19,6 @@ def test_basic():
 def test_text_image_angle_range_10(angle: int):
     """Test_text_image_angle_range_10."""
     image = cv2.imread(path.join(path.dirname(__file__), "test.png"))
-    # for angle in range(-10, 10):
     skew_image = rotate(image, angle=angle, resize=False)
     estimated_angle = get_angle(skew_image, vertical_image_shape=512)
     assert abs(angle + estimated_angle) < 0.5, f"{angle} - {estimated_angle}"
@@ -29,7 +28,6 @@ def test_text_image_angle_range_10(angle: int):
 def test_text_image_angle_range_44(angle: int):
     """Test_text_image_angle_range_44."""
     image = cv2.imread(path.join(path.dirname(__file__), "test.png"))
-    # for angle in range(-44, 44):
     skew_image = rotate(image, angle=angle, resize=False)
     estimated_angle = get_angle(skew_image, vertical_image_shape=512, angle_max=44.9)
     assert abs(angle + estimated_angle) < 0.5, f"{angle} - {estimated_angle}"