aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormutantturkey <mutantturke@gmail.com>2012-10-31 17:37:29 -0400
committermutantturkey <mutantturke@gmail.com>2012-10-31 17:37:29 -0400
commit754edf136d1020462f65d60c963aeea4da5df1a6 (patch)
tree454acf021c4ec867564d9cd7d8a18623e0d8b818
parent039ef3345967fe291b1487a9a588a37909531af0 (diff)
add basic explaination of how some of the tools work, and set line wrapping to 80 lines.
-rw-r--r--fly-tools/README.markdown30
1 files changed, 26 insertions, 4 deletions
diff --git a/fly-tools/README.markdown b/fly-tools/README.markdown
index ac94d8c..60e2b98 100644
--- a/fly-tools/README.markdown
+++ b/fly-tools/README.markdown
@@ -1,6 +1,8 @@
fly-tools
=========
+These are the programs that do all the hard work!
+
FlyTracking
------------
@@ -13,7 +15,8 @@ Usage:
FilterFlyMask
------------
-FilterFlyMask runs some filtering operations on masks to ensure that the FlyTracking tool processes the information correctly.
+FilterFlyMask runs some filtering operations on masks to ensure that the
+FlyTracking tool processes the information correctly.
Usage:
@@ -22,8 +25,12 @@ Usage:
filter-mask
-----------
-filter-mask is an alternative fly filter that works much faster. It utilizes the OpenCV and CvBlob libraries.
+filter-mask is an alternative fly filter that works much faster. It utilizes
+the OpenCV and CvBlob libraries.
+The filter works simply, it counts the number of blobs and grabs the largest
+two. Anything else is discarded and the two blobs are written to a new image.
+
Usage:
filter-mask -i <input-file> -o <output-file> -r <ratio>
@@ -31,7 +38,17 @@ Usage:
mask-generator
-------------
-This tool creates masks from cropped video frames, which the need to be filtered by the FilterFlyMask tool.
+This tool creates binary masks from cropped video frames, which the need to be
+filtered by the FilterFlyMask tool.
+
+The program works by doing 3 specific image manipulations to the input images.
+
+1. subtract the background image from the input image
+2. auto-level the image. This operation sets the lightest pixel to white and
+then normalizes the rest of the image accordingly. This step is important to
+ensure that the mask output is relatively similar when ligt conditions are
+changing during a sequence.
+3. Threshold the image, anything over 30% is marked as white, the rest is black
Usage:
@@ -44,7 +61,12 @@ Todo:
derive-background
-----------------
-This tool will generate a common background image of a set of video frames (PNGs), based on the statistical mode of each pixel.
+This tool will generate a common background image of a set of video frames
+(PNGs), based on the statistical mode of each pixel.
+
+The program works by iterating through each image, through each pixel, adding
+them to a histogram and then calculates each pixel's mode and spews out the
+resulting image.
Usage: