comments for pso

[imago.git] / imago_pack / linef.py

diff --git a/imago_pack/linef.py b/imago_pack/linef.py
index 4e35781..06483a3 100644 (file)
--- a/imago_pack/linef.py
+++ b/imago_pack/linef.py
@@ -1,5 +1,6 @@
-"""Go image recognition lines-finding module"""
+"""Lines finding module."""
 
+from functools import partial
 import sys
 from math import sin, cos, pi
 
@@ -13,6 +14,8 @@ import filters
 from hough import Hough
 
 def find_lines(image, show_all, do_something, verbose):
+    """Find lines in the *image*."""
+    # TODO refactor into smaller functions
 
     if verbose:
         print >> sys.stderr, "preprocessing"
@@ -38,48 +41,46 @@ def find_lines(image, show_all, do_something, verbose):
     if verbose:
         print >> sys.stderr, "hough transform"
 
-    hough1 = Hough(im_h.size)
-    im_hough = hough1.transform(im_h)
+    im_hough = Hough.Transform(im_h)
     if show_all:
-        do_something(im_hough, "hough transform")
+        do_something(im_hough.image, "hough transform")
 
-   # im_hough = filters.peaks(im_hough)
+   # im_hough.image = filters.peaks(im_hough.image)
    # if show_all:
-   #     do_something(im_hough, "peak extraction")
+   #     do_something(im_hough.image, "peak extraction")
                
-    im_h2 = filters.high_pass(im_hough, 96)
+    im_h2 = im_hough.apply_filter(partial(filters.high_pass, height=96))
     if show_all:
-        do_something(im_h2, "second high pass filters")
+        do_something(im_h2.image, "second high pass filters")
 
-    im_h2 = filters.components2(im_h2)
+    im_h2 = im_h2.apply_filter(filters.components2)
     if show_all:
-        do_something(im_h2, "components centers")
+        do_something(im_h2.image, "components centers")
 
     if verbose:
         print >> sys.stderr, "second hough transform"
 
-    hough2 = Hough(im_h2.size) 
     # im_hough might be used instead im_h2, but at the moment it brings a lot of
     # noise to the second transform, which later confuses the center-finding
     # mechanism (which is not very robust yet)
-    im_hough2 = hough2.transform(im_h2)
+    im_hough2 = Hough.Transform(im_h2.image)
     if show_all:
-        do_something(im_hough2, "second hough transform")
+        do_something(im_hough2.image, "second hough transform")
 
-    im_h3 = filters.high_pass(im_hough2, 120)
+    im_h3 = im_hough2.apply_filter(partial(filters.high_pass, height=120))
     if show_all:
-        do_something(im_h3, "third high pass filter")
+        do_something(im_h3.image, "third high pass filter")
      
-    im_h3 = filters.components(im_h3)
+    im_h3 = im_h3.apply_filter(filters.components)
     if show_all:
-        do_something(im_h3, "half centers")
+        do_something(im_h3.image, "half centers")
 
     if verbose:
         print >> sys.stderr, "finding the grid"
 
-    lines_m = hough2.all_lines_h(im_h3)
+    lines_m = im_h3.all_lines_h()
     lines = []
-    im_c = im_h2.convert('RGB').convert('RGB', (1, 0.5, 0.5, 0))
+    im_c = im_h2.image.convert('RGB').convert('RGB', (1, 0.5, 0.5, 0))
     draw_c = ImageDraw.Draw(im_c)
     bounds = []
 
@@ -89,12 +90,13 @@ def find_lines(image, show_all, do_something, verbose):
         line_points = set()
         for line in line_l:
             draw.line(line_from_angl_dist(line, im_h2.size), fill=255, width=7)
-            draw_c.line(line_from_angl_dist(line, im_c.size), fill=(70, 70, 70), width=7)
-            for p in combine(im_h2, im_line):
+            draw_c.line(line_from_angl_dist(line, im_c.size),
+                        fill=(70, 70, 70), width=7)
+            for p in combine(im_h2.image, im_line):
                 line_points.add(p)
         for point in line_points:
             draw_c.point(point, fill=(120, 255, 120))
-        lines.append(hough1.lines_from_list(line_points))
+        lines.append(im_hough.lines_from_list(line_points))
         line_points = list(line_points)
         line_points.sort()
         bounds += [line_points[0], line_points[-1]]
@@ -109,9 +111,10 @@ def find_lines(image, show_all, do_something, verbose):
     if show_all:
         do_something(image_g, "lines")
    
-    return lines, lines_m[0][0], lines_m[1][0], bounds, hough1, im_h
+    return lines, lines_m[0][0], lines_m[1][0], bounds, im_hough
 
 def combine(image1, image2):
+    """Return a list of points that are present in both images."""
     im_l1 = image1.load()
     im_l2 = image2.load()
 
@@ -124,6 +127,8 @@ def combine(image1, image2):
     return on_both
 
 def line_from_angl_dist((angle, distance), size):
+    """Take *angle* and *distance* (from the center of the image) of a line and
+    size of the image. Return the line represented by two points."""
     if pi / 4 < angle < 3 * pi / 4:
         y1 = - size[1] / 2
         x1 = int(round((y1 * cos(angle) + distance) / sin(angle))) + size[0] / 2