proper comments for segment-image-labelOutput

segment-image-labelOutput.h

@@ -12,19 +12,26 @@
 
 #include <mex.h>
 
-/*
- * Segment an image
- *
- * Returns a int image giving the index of the corresponding segment for every pixel
- *
- * im: image to segment.
- * sigma: to smooth the image.
- * c: constant for treshold function.
- * min_size: minimum component size (enforced by post-processing stage).
- * num_ccs: number of connected components in the segmentation.
+ /**
+ * @brief Segment an image, returning an int-image giving the index of the corresponding segment for every pixel
+ * @author Alexander Freytag
+ * @date 27-03-2014 ( dd-mm-yyyy, last updated)
+ * 
+ * @param[in] im: image to segment
+ * @param[in] sigma: to smooth the image
+ * @param[in] c: constant for treshold function
+ * @param[in] min_size: minimum component size (enforced by post-processing stage)
+ * @param[in] num_ccs: number of connected components in the segmentation
+ * 
+ * @param[out] output int-image giving the index of the corresponding segment for every pixel
  */
-image<int> *segment_image_labelOutput(image<rgb> *im, float sigma, float c, int min_size,
-			  int *num_ccs) {
+image<int> *segment_image_labelOutput(   image<rgb> *im,
+                                         float sigma,
+                                         float c,
+                                         int min_size,
+                                         int *num_ccs
+                                     )
+{
   int width = im->width();
   int height = im->height();
 
@@ -33,8 +40,10 @@ image<int> *segment_image_labelOutput(image<rgb> *im, float sigma, float c, int
   image<float> *b = new image<float>(width, height);
 
   // smooth each color channel  
-  for (int y = 0; y < height; y++) {
-    for (int x = 0; x < width; x++) {
+  for (int y = 0; y < height; y++)
+  {
+    for (int x = 0; x < width; x++)
+    {
       imRef(r, x, y) = imRef(im, x, y).r;
       imRef(g, x, y) = imRef(im, x, y).g;
       imRef(b, x, y) = imRef(im, x, y).b;
@@ -50,69 +59,56 @@ image<int> *segment_image_labelOutput(image<rgb> *im, float sigma, float c, int
   // build graph
   edge *edges = new edge[width*height*4];
   int num = 0;
-  for (int y = 0; y < height; y++) {
-    for (int x = 0; x < width; x++) {
-      if (x < width-1) {
-// 	if ( num == 0)
-// 	{
-// 	  mexPrintf("r: %f , b: %f g: %f\n", imRef(smooth_r, x, y), imRef(smooth_g, x, y), imRef(smooth_b, x, y));
-// 	}
-	edges[num].a = y * width + x;
-	edges[num].b = y * width + (x+1);
-	edges[num].w = diff(smooth_r, smooth_g, smooth_b, x, y, x+1, y);
-	num++;
+  for (int y = 0; y < height; y++)
+  {
+    for (int x = 0; x < width; x++)
+    {
+      if (x < width-1)
+      {
+        edges[num].a = y * width + x;
+        edges[num].b = y * width + (x+1);
+        edges[num].w = diff(smooth_r, smooth_g, smooth_b, x, y, x+1, y);
+        num++;
       }
 
-      if (y < height-1) {
-	edges[num].a = y * width + x;
-	edges[num].b = (y+1) * width + x;
-	edges[num].w = diff(smooth_r, smooth_g, smooth_b, x, y, x, y+1);
-	num++;
+      if (y < height-1)
+      {
+        edges[num].a = y * width + x;
+        edges[num].b = (y+1) * width + x;
+        edges[num].w = diff(smooth_r, smooth_g, smooth_b, x, y, x, y+1);
+        num++;
       }
 
-      if ((x < width-1) && (y < height-1)) {
-	edges[num].a = y * width + x;
-	edges[num].b = (y+1) * width + (x+1);
-	edges[num].w = diff(smooth_r, smooth_g, smooth_b, x, y, x+1, y+1);
-	num++;
+      if ( (x < width-1) && (y < height-1) )
+      {
+        edges[num].a = y * width + x;
+        edges[num].b = (y+1) * width + (x+1);
+        edges[num].w = diff(smooth_r, smooth_g, smooth_b, x, y, x+1, y+1);
+        num++;
       }
 
-      if ((x < width-1) && (y > 0)) {
-	edges[num].a = y * width + x;
-	edges[num].b = (y-1) * width + (x+1);
-	edges[num].w = diff(smooth_r, smooth_g, smooth_b, x, y, x+1, y-1);
-	num++;
+      if ( (x < width-1) && (y > 0) )
+      {
+        edges[num].a = y * width + x;
+        edges[num].b = (y-1) * width + (x+1);
+        edges[num].w = diff(smooth_r, smooth_g, smooth_b, x, y, x+1, y-1);
+        num++;
       }
     }
   }
   delete smooth_r;
   delete smooth_g;
   delete smooth_b;
-  
-//      for (int i = 0; i < 5; i++) {
-//       int a = edges[i].a;
-//       int b = edges[i].b;
-//       mexPrintf("components %d: %d <-> %d\n",i, a, b);      
-//     }   
-    // so far, everything is always reproducable
 
   // segment
   universe *u = segment_graph(width*height, num, edges, c);
   
-//   // post process small components
-//   mexPrintf("components before PP: %d\n",num);  
-  
-
-//     for (int i = 0; i < 10; i++) {
-//       int a = u->find(edges[i].a);
-//       int b = u->find(edges[i].b);
-//       mexPrintf("components %d: %d <-> %d\n",i, a, b);      
-//     }
-  
-  for (int i = 0; i < num; i++) {
+  // post process small components 
+  for (int i = 0; i < num; i++)
+  {
     int a = u->find(edges[i].a);
     int b = u->find(edges[i].b);
-    if ((a != b) && ((u->size(a) < min_size) || (u->size(b) < min_size)))
+    if ( (a != b) && ((u->size(a) < min_size) || (u->size(b) < min_size))  )
       u->join(a, b);
   }
   delete [] edges;
@@ -121,8 +117,6 @@ image<int> *segment_image_labelOutput(image<rgb> *im, float sigma, float c, int
   // max_int segments ( and therefore also not imgs with more pixels)
   *num_ccs = u->num_sets();
   
-//   mexPrintf("components after PP: %d\n",*num_ccs); 
-
   image<int> *output = new image<int>(width, height);
  
   //how many different regions do we finally have, and which of them are the corresponding indices?
@@ -136,8 +130,8 @@ image<int> *segment_image_labelOutput(image<rgb> *im, float sigma, float c, int
       int comp = u->find(y * width + x);
       if ( regionLabels.find( comp ) == regionLabels.end() )
       {
-	regionLabels.insert( std::pair<int,int>(comp,idx) );
-	idx++;
+        regionLabels.insert( std::pair<int,int>(comp,idx) );
+        idx++;
       }
     }
   }