Add documentation.

[master-thesis.git] / Parasitemia / ParasitemiaCore / Granulometry.fs

diff --git a/Parasitemia/ParasitemiaCore/Granulometry.fs b/Parasitemia/ParasitemiaCore/Granulometry.fs
index ed8bda6..0afe5cc 100644 (file)
--- a/Parasitemia/ParasitemiaCore/Granulometry.fs
+++ b/Parasitemia/ParasitemiaCore/Granulometry.fs
@@ -8,9 +8,13 @@ open Emgu.CV.Structure
 
 open Utils
 
-// 'range': a minimum and maximum radius.
-// 'scale': <= 1.0, to speed up the process.
-let findRadiusByClosing (img: Image<Gray, 'TDepth>) (range: int * int) (scale: float) : int =
+/// <summary>
+/// Granulometry by closing on the image 'img' by testing circle structrual elements with radius range in 'range'.
+/// </summary>
+/// <param name="img"></param>
+/// <param name="range">Minimum radius * maximum radius</param>
+/// <param name="scale">le 1.0, to speed up the process.</param>
+let findRadiusByClosing (img: Image<Gray, 'TDepth>) (range: int * int) (scale: float) (useOctagon: bool) : int =
     use scaledImg = if scale = 1. then img else img.Resize(scale, CvEnum.Inter.Area)
 
     let r1, r2 = range
@@ -20,7 +24,7 @@ let findRadiusByClosing (img: Image<Gray, 'TDepth>) (range: int * int) (scale: f
     let intensityImg = scaledImg.GetSum().Intensity
 
     // 's' must be odd.
-    let octagon (s: int) : Matrix<byte> =
+    let octagon (s: int) : Mat =
         if s % 2 = 0 then failwith "s must be odd"
         let m = new Matrix<byte>(Array2D.create s s 1uy)
         let r = (float s) / (Math.Sqrt 2. + 2.) |> roundInt
@@ -32,12 +36,13 @@ let findRadiusByClosing (img: Image<Gray, 'TDepth>) (range: int * int) (scale: f
                     m.[s - i - 1, j] <- 0uy
                     m.[i, s - j - 1] <- 0uy
                     m.[s - i - 1, s - j - 1] <- 0uy
-        m
+        m.Mat
 
     let mutable previous_n = Double.NaN
     for r in r1' .. r2' do
-        let se = CvInvoke.GetStructuringElement(CvEnum.ElementShape.Ellipse, Size(2 * r, 2 * r), Point(-1, -1))
-        //let se = octagon (2 * r - 1)
+        let se = if useOctagon
+                 then octagon (2 * r - 1) // It doesnd't speed up the process.
+                 else CvInvoke.GetStructuringElement(CvEnum.ElementShape.Ellipse, Size(2 * r, 2 * r), Point(-1, -1))
 
         use closed = scaledImg.MorphologyEx(CvEnum.MorphOp.Close, se, Point(-1, -1), 1, CvEnum.BorderType.Replicate, MCvScalar(0.0))
 
@@ -52,8 +57,14 @@ let findRadiusByClosing (img: Image<Gray, 'TDepth>) (range: int * int) (scale: f
 
     float (max + r1') / scale |> roundInt
 
-let findRadiusByAreaClosing (img: Image<Gray, float32>) (range: int * int) : int =
-    let r1, r2 = range
+/// <summary>
+/// Granulometry by area closing on the image 'img' by testing the circle area into the given radius range.
+/// </summary>
+let findRadiusByAreaClosing (img: Image<Gray, float32>) (radiusRange: int * int) : int =
+    let r1, r2 = radiusRange
+
+    if r1 > r2
+    then failwithf "'radiusRange' invalid : %A" radiusRange
 
     use imgCopy = img.Copy()
 
@@ -64,6 +75,6 @@ let findRadiusByAreaClosing (img: Image<Gray, float32>) (range: int * int) : int
         if r <> r1 && diff > maxDiff
         then
             maxDiff <- diff
-            max_r <- r - 1 )
+            max_r <- r - 1)
     max_r