add scripts to generate pypi packe easily with the latest codes

Author: vboxuser

README.md

@@ -15,7 +15,7 @@ Uses oriented gabor filter bank to enhance the fingerprint image. The orientatio
   import cv2
   
   img = cv2.imread('image_path', 0)						# read input image
-  out = fingerprint_enhancer.enhance_Fingerprint(img)		# enhance the fingerprint image
+  out = fingerprint_enhancer.enhance_fingerprint(img)		# enhance the fingerprint image
   cv2.imshow('enhanced_image', out);						# display the result
   cv2.waitKey(0)											# hold the display window
   ```

devtool.py

@@ -1,6 +1,7 @@
 """Module to run pre commit checks for staged files."""
 from subprocess import check_call
 import os
+
 import fire
 import git
 

enhanced/1.jpg

@@ -0,0 +1,28 @@
+"""generate the fingerprint_enhancer python package."""
+
+from setuptools import setup
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="fingerprint_enhancer",
+    version="0.0.14",
+    author="utkarsh-deshmukh",
+    author_email="utkarsh.deshmukh@gmail.com",
+    description="enhance fingerprint images",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/Utkarsh-Deshmukh/Fingerprint-Enhancement-Python",
+    download_url="https://github.com/Utkarsh-Deshmukh/Fingerprint-Enhancement-Python/archive/develop.zip",
+    install_requires=["numpy", "opencv-python", "scipy"],
+    license="MIT",
+    keywords="Fingerprint Image Enhancement",
+    package_dir={"": "src"},
+    packages=["fingerprint_enhancer"],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+)

enhanced/2.jpg

@@ -7,7 +7,7 @@
 
 import sys
 import cv2
-from fingerprint_image_enhancer import FingerprintImageEnhancer
+from fingerprint_enhancer.fingerprint_image_enhancer import FingerprintImageEnhancer
 
 if __name__ == "__main__":
     image_enhancer = FingerprintImageEnhancer()  # Create object called image_enhancer
@@ -22,5 +22,5 @@
     if len(img.shape) > 2:  # convert image into gray if necessary
         img = cv2.cvtColor(img, cv2.COLOR_BGR2GRAY)
 
-    out = image_enhancer.enhance(img)  # run image enhancer
+    image_enhancer.enhance(img, invert_output=True)  # run image enhancer
     image_enhancer.save_enhanced_image("enhanced/" + IMG_NAME)  # save output

setup.py

@@ -0,0 +1,2 @@
+"""fingerprint_enhancer module."""
+from .fingerprint_image_enhancer import enhance_fingerprint

src/example.py

@@ -6,32 +6,64 @@
 """
 
 import math
-import numpy as np
+import os
+
 import cv2
-from scipy import signal
-from scipy import ndimage
+import numpy as np
 import scipy
+from scipy import ndimage, signal
 
 
-# pylint: disable=too-many-instance-attributes, too-many-function-args, too-many-locals
+# pylint: disable=too-many-instance-attributes, too-many-function-args, too-many-locals, too-many-arguments
 class FingerprintImageEnhancer:
     """Fingerprint Enhancer Object."""
 
-    def __init__(self):
-        """Initialize the object."""
-        self.ridge_segment_blksze = 16
-        self.ridge_segment_thresh = 0.1
-        self.gradient_sigma = 1
-        self.block_sigma = 7
-        self.orient_smooth_sigma = 7
-        self.ridge_freq_blksze = 38
-        self.ridge_freq_windsze = 5
-        self.min_wave_length = 5
-        self.max_wave_length = 15
-        self.relative_scale_factor_x = 0.65
-        self.relative_scale_factor_y = 0.65
-        self.angle_inc = 3
-        self.ridge_filter_thresh = -3
+    def __init__(
+        self,
+        ridge_segment_blksze=16,
+        ridge_segment_thresh=0.1,
+        gradient_sigma=1,
+        block_sigma=7,
+        orient_smooth_sigma=7,
+        ridge_freq_blksze=38,
+        ridge_freq_windsze=5,
+        min_wave_length=5,
+        max_wave_length=15,
+        relative_scale_factor_x=0.65,
+        relative_scale_factor_y=0.65,
+        angle_inc=3.0,
+        ridge_filter_thresh=-3,
+    ):
+        """initialize the object
+
+        Args:
+            ridge_segment_blksze (int, optional): ridge_segment_blksze. Defaults to 16.
+            ridge_segment_thresh (float, optional): ridge_segment_thresh. Defaults to 0.1.
+            gradient_sigma (int, optional): gradient_sigma. Defaults to 1.
+            block_sigma (int, optional): block_sigma. Defaults to 7.
+            orient_smooth_sigma (int, optional): orient_smooth_sigma. Defaults to 7.
+            ridge_freq_blksze (int, optional): block size for ridge_freq calculation. Defaults to 38.
+            ridge_freq_windsze (int, optional): window size for ridge_freq calculation. Defaults to 5.
+            min_wave_length (int, optional): min_wave_length. Defaults to 5.
+            max_wave_length (int, optional): max_wave_length. Defaults to 15.
+            relative_scale_factor_x (float, optional): relative_scale_factor_x. Defaults to 0.65.
+            relative_scale_factor_y (float, optional): relative_scale_factor_x. Defaults to 0.65.
+            angle_inc (float, optional): angle increment for gabor filtering. Defaults to 3.0.
+            ridge_filter_thresh (int, optional): ridge filter threshold. Defaults to -3.
+        """
+        self.ridge_segment_blksze = ridge_segment_blksze
+        self.ridge_segment_thresh = ridge_segment_thresh
+        self.gradient_sigma = gradient_sigma
+        self.block_sigma = block_sigma
+        self.orient_smooth_sigma = orient_smooth_sigma
+        self.ridge_freq_blksze = ridge_freq_blksze
+        self.ridge_freq_windsze = ridge_freq_windsze
+        self.min_wave_length = min_wave_length
+        self.max_wave_length = max_wave_length
+        self.relative_scale_factor_x = relative_scale_factor_x
+        self.relative_scale_factor_y = relative_scale_factor_y
+        self.angle_inc = angle_inc
+        self.ridge_filter_thresh = ridge_filter_thresh
 
         self._mask = []
         self._normim = []
@@ -515,18 +547,20 @@ def save_enhanced_image(self, path: str) -> None:
         Args:
             path (str): image name.
         """
+        os.makedirs(os.path.dirname(path), exist_ok=True)
         # saves the enhanced image at the specified path
         cv2.imwrite(path, (255 * self._binim))
 
-    def enhance(self, img: np.ndarray, resize: bool = True) -> np.ndarray:
+    def enhance(self, img: np.ndarray, resize: bool = True, invert_output=False) -> np.ndarray:
         """Enhance the input image.
 
         Args:
             img (np.ndarray): input image.
             resize (bool, optional): resize the input image. Defaults to True.
+            invert_output (bool, optional): invert the output
 
         Returns:
-            _type_np.ndarray: return the enhanced image.
+            np.ndarray: return the enhanced image.
         """
         if resize:
             rows, cols = np.shape(img)
@@ -541,4 +575,67 @@ def enhance(self, img: np.ndarray, resize: bool = True) -> np.ndarray:
         self.__ridge_orient()  # compute orientation image
         self.__ridge_freq()  # compute major frequency of ridges
         self.__ridge_filter()  # filter the image using oriented gabor filter
+        if invert_output:
+            self._binim ^= True
         return self._binim
+
+
+# pylint: disable = too-many-arguments
+def enhance_fingerprint(
+    img: np.ndarray,
+    resize: bool = False,
+    ridge_segment_blksze: int = 16,
+    ridge_segment_thresh: float = 0.1,
+    gradient_sigma: int = 1,
+    block_sigma: int = 7,
+    orient_smooth_sigma: int = 7,
+    ridge_freq_blksze: int = 38,
+    ridge_freq_windsze: int = 5,
+    min_wave_length: int = 5,
+    max_wave_length: int = 15,
+    relative_scale_factor_x: float = 0.65,
+    relative_scale_factor_y: float = 0.65,
+    angle_inc: float = 3.0,
+    ridge_filter_thresh: int = -3,
+    invert_output: bool = False,
+) -> np.ndarray:
+    """enhance the input image.
+
+    Args:
+        img (np.ndarray): input image
+        resize (bool, optional): resize the input image to a fixed size. Defaults to False.
+        ridge_segment_blksze (int, optional): ridge_segment_blksze. Defaults to 16.
+        ridge_segment_thresh (float, optional): ridge_segment_thresh. Defaults to 0.1.
+        gradient_sigma (int, optional): gradient_sigma. Defaults to 1.
+        block_sigma (int, optional): block_sigma. Defaults to 7.
+        orient_smooth_sigma (int, optional): orient_smooth_sigma. Defaults to 7.
+        ridge_freq_blksze (int, optional): block size for ridge_freq calculation. Defaults to 38.
+        ridge_freq_windsze (int, optional): window size for ridge_freq calculation. Defaults to 5.
+        min_wave_length (int, optional): min_wave_length. Defaults to 5.
+        max_wave_length (int, optional): max_wave_length. Defaults to 15.
+        relative_scale_factor_x (float, optional): relative_scale_factor_x. Defaults to 0.65.
+        relative_scale_factor_y (float, optional): relative_scale_factor_x. Defaults to 0.65.
+        angle_inc (float, optional): angle increment for gabor filtering. Defaults to 3.0.
+        ridge_filter_thresh (int, optional): ridge filter threshold. Defaults to -3.
+        invert_output (bool, optional): flag to invert the enhanced-output. Defaults to False.
+
+    Returns:
+        np.ndarray: _description_
+    """
+    image_enhancer = FingerprintImageEnhancer(
+        ridge_segment_blksze,
+        ridge_segment_thresh,
+        gradient_sigma,
+        block_sigma,
+        orient_smooth_sigma,
+        ridge_freq_blksze,
+        ridge_freq_windsze,
+        min_wave_length,
+        max_wave_length,
+        relative_scale_factor_x,
+        relative_scale_factor_y,
+        angle_inc,
+        ridge_filter_thresh,
+    )  # Create object called image_enhancer
+    enhanced_output = image_enhancer.enhance(img, resize, invert_output=invert_output)
+    return enhanced_output