Commented Filtering code

Author: Defcon27

Image_Filters/ConvolutionalFilters.py

@@ -5,6 +5,7 @@
 
 
 class ConvolutionFilter():
+    """Converts input image to grayscale and applies various convolution filters"""
 
     def __init__(self, image):
         self.image = cv2.cvtColor(image, cv2.COLOR_RGB2GRAY)
@@ -26,6 +27,8 @@ def __init__(self, image):
                                    [0,  1, 0]))
 
     def __convolution(self, image_roi, kernel):
+        # This function convolves the input kernel on the input image region of interest 
+
         kernel_dimension = len(kernel)
         pixel_sum = 0
 
@@ -40,6 +43,10 @@ def __convolution(self, image_roi, kernel):
             return pixel_sum % 255
 
     def __applyFilter(self, kernel):
+        """ Returns convolved image 
+        Applies the input convolution filter onto the image 
+        """
+
         image = self.image
         filtered_image = np.zeros(image.shape)
 
@@ -56,30 +63,31 @@ def __applyFilter(self, kernel):
         return filtered_image
 
     def applySharpen(self):
+        """Returns image convolved with Sharpening filter"""
         kernel = self.sharpen
-
         filtered_image = self.__applyFilter(kernel)
         return filtered_image
 
     def applySobelX(self):
+        """Returns image convolved with SobelX filter"""
         kernel = self.sobelX
-
         filtered_image = self.__applyFilter(kernel)
         return filtered_image
 
     def applySobelY(self):
+        """Returns image convolved with SobelY filter"""
         kernel = self.sobelY
-
         filtered_image = self.__applyFilter(kernel)
         return filtered_image
 
     def applyLaplacian(self):
+        """Returns image convolved with Laplacian filter"""
         kernel = self.laplacian
-
         filtered_image = self.__applyFilter(kernel)
         return filtered_image
 
     def applyCannyEdge(self):
+        """Returns image convolved with CannyEdge filter"""
 
         filtered_image = cv2.Canny(self.image, 50, 240)
         return filtered_image

Image_Filters/NoiseReduction.py

@@ -5,6 +5,7 @@
 
 
 class NoiseReduction():
+    """Converts input image to grayscale and reduces noise in the image"""
 
     def __init__(self, image):
         self.image = image
@@ -14,6 +15,8 @@ def __init__(self, image):
         self.largeBlur = np.ones((21, 21), dtype="float") * (1.0 / (21 * 21))
 
     def __convolution(self, image_roi, kernel):
+        # This function convolves the input kernel on the input image region of interest 
+
         kernel_dimension = len(kernel)
         pixel_sum = 0
 
@@ -28,6 +31,10 @@ def __convolution(self, image_roi, kernel):
             return pixel_sum % 255
 
     def __applyFilter(self, kernel):
+        """ Returns convolved image 
+        Applies the input convolution filter onto the image 
+        """
+
         image = self.image
         kernel_dimension = len(kernel)
         kernel_margin = kernel_dimension//2
@@ -47,21 +54,24 @@ def __applyFilter(self, kernel):
         return filtered_image
 
     def applySmallBlur(self):
+        """Returns image applied with small blur filter"""
+
         kernel = self.smallBlur
         image = self.image
-
         blured_image = cv2.filter2D(image, -1, kernel)
         return blured_image
 
     def applyLargeBlur(self):
+        """Returns image applied with large blur filter"""
+
         kernel = self.largeBlur
         image = self.image
-
         blured_image = cv2.filter2D(image, -1, kernel)
         return blured_image
 
     def applyGaussianBlur(self):
-        image = self.image
+        """Returns image applied with Gaussian blur filter"""
 
+        image = self.image
         filtered_image = cv2.GaussianBlur(image, (9, 9), 0)
         return filtered_image