Adding sub-module documentation.

docs/annotated.html

@@ -313,23 +313,23 @@
 <tr id="row_13_8_7_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1piece_1_1Template.html" target="_self">Template</a></td><td class="desc">Stores and encapsulates a template instance of a visual puzzle piece </td></tr>
 <tr id="row_13_9_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_13_9_" class="arrow" onclick="toggleFolder('13_9_')">&#9658;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacepuzzle_1_1pieces.html" target="_self">pieces</a></td><td class="desc"></td></tr>
 <tr id="row_13_9_0_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_13_9_0_" class="arrow" onclick="toggleFolder('13_9_0_')">&#9658;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacepuzzle_1_1pieces_1_1edge.html" target="_self">edge</a></td><td class="desc"></td></tr>
-<tr id="row_13_9_0_0_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1edge_1_1Edge.html" target="_self">Edge</a></td><td class="desc"></td></tr>
+<tr id="row_13_9_0_0_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1edge_1_1Edge.html" target="_self">Edge</a></td><td class="desc">Puzzle piece edge based comparison </td></tr>
 <tr id="row_13_9_1_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_13_9_1_" class="arrow" onclick="toggleFolder('13_9_1_')">&#9658;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacepuzzle_1_1pieces_1_1matchDifferent.html" target="_self">matchDifferent</a></td><td class="desc"></td></tr>
 <tr id="row_13_9_1_0_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgDistance.html" target="_self">CfgDistance</a></td><td class="desc">Configuration setting specifier for distance matcher class </td></tr>
 <tr id="row_13_9_1_1_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgHistogramCV.html" target="_self">CfgHistogramCV</a></td><td class="desc">Configuration setting specifier for Histogram puzzle comparator class </td></tr>
 <tr id="row_13_9_1_2_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgMoments.html" target="_self">CfgMoments</a></td><td class="desc">Configuration setting specifier for <a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1Moments.html" title="Uses shape moments to establish similarity.">Moments</a> class </td></tr>
 <tr id="row_13_9_1_3_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgPCA.html" target="_self">CfgPCA</a></td><td class="desc">Configuration setting specifier for <a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1Moments.html" title="Uses shape moments to establish similarity.">Moments</a> class </td></tr>
-<tr id="row_13_9_1_4_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1Distance.html" target="_self">Distance</a></td><td class="desc"></td></tr>
-<tr id="row_13_9_1_5_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1HistogramCV.html" target="_self">HistogramCV</a></td><td class="desc"></td></tr>
+<tr id="row_13_9_1_4_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1Distance.html" target="_self">Distance</a></td><td class="desc">Distance-based puzzle piece matching </td></tr>
+<tr id="row_13_9_1_5_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1HistogramCV.html" target="_self">HistogramCV</a></td><td class="desc">OpenCV Histogram puzzle comparator class </td></tr>
 <tr id="row_13_9_1_6_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1Moments.html" target="_self">Moments</a></td><td class="desc">Uses shape moments to establish similarity </td></tr>
 <tr id="row_13_9_1_7_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1PCA.html" target="_self">PCA</a></td><td class="desc">Uses pca to calculate rotation </td></tr>
 <tr id="row_13_9_2_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_13_9_2_" class="arrow" onclick="toggleFolder('13_9_2_')">&#9658;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacepuzzle_1_1pieces_1_1matcher.html" target="_self">matcher</a></td><td class="desc"></td></tr>
 <tr id="row_13_9_2_0_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1CfgDifferent.html" target="_self">CfgDifferent</a></td><td class="desc">Configuration setting specifier for difference matcher class </td></tr>
 <tr id="row_13_9_2_1_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1CfgMatcher.html" target="_self">CfgMatcher</a></td><td class="desc">Configuration setting specifier for puzzle piece matcher class </td></tr>
 <tr id="row_13_9_2_2_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1CfgSimilar.html" target="_self">CfgSimilar</a></td><td class="desc">Configuration setting specifier for similar matcher class </td></tr>
-<tr id="row_13_9_2_3_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1MatchDifferent.html" target="_self">MatchDifferent</a></td><td class="desc">The puzzle piece matching scores are based on differences </td></tr>
-<tr id="row_13_9_2_4_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1Matcher.html" target="_self">Matcher</a></td><td class="desc"></td></tr>
-<tr id="row_13_9_2_5_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1MatchSimilar.html" target="_self">MatchSimilar</a></td><td class="desc"></td></tr>
+<tr id="row_13_9_2_3_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1MatchDifferent.html" target="_self">MatchDifferent</a></td><td class="desc">The puzzle piece matching scores are based on differences. Lower is better </td></tr>
+<tr id="row_13_9_2_4_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1Matcher.html" target="_self">Matcher</a></td><td class="desc">Generic puzzle piece matching class. Actual instances should use similarity of difference matching sub-classes </td></tr>
+<tr id="row_13_9_2_5_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1MatchSimilar.html" target="_self">MatchSimilar</a></td><td class="desc">Similarity matching </td></tr>
 <tr id="row_13_9_3_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_13_9_3_" class="arrow" onclick="toggleFolder('13_9_3_')">&#9658;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacepuzzle_1_1pieces_1_1matchSimilar.html" target="_self">matchSimilar</a></td><td class="desc"></td></tr>
 <tr id="row_13_9_3_0_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchSimilar_1_1CfgSIFTCV.html" target="_self">CfgSIFTCV</a></td><td class="desc">Configuration setting specifier for OpenCV SIFT matcher class </td></tr>
 <tr id="row_13_9_3_1_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpuzzle_1_1pieces_1_1matchSimilar_1_1SIFTCV.html" target="_self">SIFTCV</a></td><td class="desc">Uses sift features to establish similarity </td></tr>

docs/classdetector_1_1Configuration_1_1AlgConfig.html

@@ -160,7 +160,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a418793636fd792a2b17e86fc
       </table>
 </div><div class="memdoc">
 
-<p>Reimplemented in <a class="el" href="classpuzzle_1_1board_1_1CfgCorrespondences.html#a418793636fd792a2b17e86fc767ccb78">CfgCorrespondences</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgPCA.html#a418793636fd792a2b17e86fc767ccb78">CfgPCA</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgMoments.html#a418793636fd792a2b17e86fc767ccb78">CfgMoments</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1CfgSimilar.html#a418793636fd792a2b17e86fc767ccb78">CfgSimilar</a>, <a class="el" href="classdetector_1_1bgmodel_1_1inCorner_1_1CfgInCorner.html#a418793636fd792a2b17e86fc767ccb78">CfgInCorner</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1CfgDifferent.html#a418793636fd792a2b17e86fc767ccb78">CfgDifferent</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgHistogramCV.html#a418793636fd792a2b17e86fc767ccb78">CfgHistogramCV</a>, <a class="el" href="classdetector_1_1bgmodel_1_1Gaussian_1_1CfgSGCone.html#a418793636fd792a2b17e86fc767ccb78">CfgSGCone</a>, <a class="el" href="classdetector_1_1bgmodel_1_1GMM_1_1CfgGMM__cv.html#a418793636fd792a2b17e86fc767ccb78">CfgGMM_cv</a>, <a class="el" href="classpuzzle_1_1parser_1_1CfgBoardMeasure.html#a418793636fd792a2b17e86fc767ccb78">CfgBoardMeasure</a>, <a class="el" href="classtrackpointer_1_1centroid_1_1CfgCentroind.html#a418793636fd792a2b17e86fc767ccb78">CfgCentroind</a>, <a class="el" href="classtrackpointer_1_1centroidMulti_1_1CfgCentMulti.html#a418793636fd792a2b17e86fc767ccb78">CfgCentMulti</a>, <a class="el" href="classpuzzle_1_1builder_1_1interlocking_1_1CfgInterlocking.html#a418793636fd792a2b17e86fc767ccb78">CfgInterlocking</a>, <a class="el" href="classpuzzle_1_1builder_1_1adjacent_1_1CfgAdjacent.html#a418793636fd792a2b17e86fc767ccb78">CfgAdjacent</a>, <a class="el" href="classpuzzle_1_1builder_1_1arrangement_1_1CfgArrangement.html#a418793636fd792a2b17e86fc767ccb78">CfgArrangement</a>, <a class="el" href="classbyMotion_1_1CfgMoving.html#a418793636fd792a2b17e86fc767ccb78">CfgMoving</a>, <a class="el" href="classdetector_1_1bgmodel_1_1Gaussian_1_1CfgSGM.html#a418793636fd792a2b17e86fc767ccb78">CfgSGM</a>, <a class="el" href="classpuzzle_1_1builder_1_1gridded_1_1CfgGridded.html#a418793636fd792a2b17e86fc767ccb78">CfgGridded</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1CfgMatcher.html#a418793636fd792a2b17e86fc767ccb78">CfgMatcher</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgDistance.html#a418793636fd792a2b17e86fc767ccb78">CfgDistance</a>, and <a class="el" href="classdetector_1_1bgmodel_1_1onWorkspace_1_1CfgOnWS.html#a418793636fd792a2b17e86fc767ccb78">CfgOnWS</a>.</p>
+<p>Reimplemented in <a class="el" href="classpuzzle_1_1board_1_1CfgCorrespondences.html#a418793636fd792a2b17e86fc767ccb78">CfgCorrespondences</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgPCA.html#a418793636fd792a2b17e86fc767ccb78">CfgPCA</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgMoments.html#a418793636fd792a2b17e86fc767ccb78">CfgMoments</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1CfgSimilar.html#a418793636fd792a2b17e86fc767ccb78">CfgSimilar</a>, <a class="el" href="classdetector_1_1bgmodel_1_1inCorner_1_1CfgInCorner.html#a418793636fd792a2b17e86fc767ccb78">CfgInCorner</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1CfgDifferent.html#a418793636fd792a2b17e86fc767ccb78">CfgDifferent</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgHistogramCV.html#a418793636fd792a2b17e86fc767ccb78">CfgHistogramCV</a>, <a class="el" href="classdetector_1_1bgmodel_1_1Gaussian_1_1CfgSGCone.html#a418793636fd792a2b17e86fc767ccb78">CfgSGCone</a>, <a class="el" href="classdetector_1_1bgmodel_1_1GMM_1_1CfgGMM__cv.html#a418793636fd792a2b17e86fc767ccb78">CfgGMM_cv</a>, <a class="el" href="classpuzzle_1_1parser_1_1CfgBoardMeasure.html#a418793636fd792a2b17e86fc767ccb78">CfgBoardMeasure</a>, <a class="el" href="classtrackpointer_1_1centroid_1_1CfgCentroind.html#a418793636fd792a2b17e86fc767ccb78">CfgCentroind</a>, <a class="el" href="classtrackpointer_1_1centroidMulti_1_1CfgCentMulti.html#a418793636fd792a2b17e86fc767ccb78">CfgCentMulti</a>, <a class="el" href="classpuzzle_1_1builder_1_1interlocking_1_1CfgInterlocking.html#a418793636fd792a2b17e86fc767ccb78">CfgInterlocking</a>, <a class="el" href="classpuzzle_1_1builder_1_1adjacent_1_1CfgAdjacent.html#a418793636fd792a2b17e86fc767ccb78">CfgAdjacent</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matcher_1_1CfgMatcher.html#a418793636fd792a2b17e86fc767ccb78">CfgMatcher</a>, <a class="el" href="classpuzzle_1_1builder_1_1arrangement_1_1CfgArrangement.html#a418793636fd792a2b17e86fc767ccb78">CfgArrangement</a>, <a class="el" href="classbyMotion_1_1CfgMoving.html#a418793636fd792a2b17e86fc767ccb78">CfgMoving</a>, <a class="el" href="classdetector_1_1bgmodel_1_1Gaussian_1_1CfgSGM.html#a418793636fd792a2b17e86fc767ccb78">CfgSGM</a>, <a class="el" href="classpuzzle_1_1builder_1_1gridded_1_1CfgGridded.html#a418793636fd792a2b17e86fc767ccb78">CfgGridded</a>, <a class="el" href="classpuzzle_1_1pieces_1_1matchDifferent_1_1CfgDistance.html#a418793636fd792a2b17e86fc767ccb78">CfgDistance</a>, and <a class="el" href="classdetector_1_1bgmodel_1_1onWorkspace_1_1CfgOnWS.html#a418793636fd792a2b17e86fc767ccb78">CfgOnWS</a>.</p>
 
 </div>
 </div>