Jelajahi Sumber

Commented GaussianFilter class.

Jayke Meijer 14 tahun lalu
induk
melakukan
98c9cb74bd
1 mengubah file dengan 15 tambahan dan 1 penghapusan
  1. 15 1
      src/GaussianFilter.py

+ 15 - 1
src/GaussianFilter.py

@@ -1,9 +1,20 @@
+# Gaussian Filter Class for use with License Plate Recognition with
+# Local Binary Patterns.
+#
+# Authors:  Taddeüs Kroes
+#           Jayke Meijer
+#           Fabiën Tesselaar
+#           Richard Torenvliet
+#           Gijs van der Voort
+
 from GrayscaleImage import GrayscaleImage
 from scipy.ndimage import gaussian_filter
 
 class GaussianFilter:
+    """This class can apply a Gaussian blur on an image."""
 
     def __init__(self, scale):
+        """Create a GaussianFilter object with a given scale."""
         self.scale = scale
 
     def get_filtered_copy(self, image):
@@ -12,12 +23,15 @@ class GaussianFilter:
         return GrayscaleImage(None, image)
 
     def filter(self, image):
+        """Apply a Gaussian blur on the image data."""
         image.data = gaussian_filter(image.data, self.scale)
 
     def get_scale(self):
-      return self.scale
+        """Return the scale of the Gaussian kernel."""
+        return self.scale
 
     def set_scale(self, scale):
+        """Set the scale of the Gaussian kernel."""
         self.scale = float(scale)
 
     scale = property(get_scale, set_scale)