mirror of
https://github.com/bspeice/libcvautomation
synced 2025-08-05 23:15:26 -04:00
Release version 1.2 documentation
This commit is contained in:
Bradlee Speice
182
cva-match.html
182
cva-match.html
@ -1,54 +1,132 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
<title>libcvautomation: </title>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css">
|
||||
</head><body>
|
||||
<!-- Generated by Doxygen 1.4.7 -->
|
||||
<div class="tabs">
|
||||
<ul>
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li>
|
||||
<form action="search.php" method="get">
|
||||
<table cellspacing="0" cellpadding="0" border="0">
|
||||
<tr>
|
||||
<td><label> <u>S</u>earch for </label></td>
|
||||
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
|
||||
</tr>
|
||||
</table>
|
||||
</form>
|
||||
</li>
|
||||
</ul></div>
|
||||
<dl compact><dt><b>Author:</b></dt><dd>Bradlee Speice <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>> </dd></dl>
|
||||
<dl compact><dt><b>Date:</b></dt><dd>7/11/2012 </dd></dl>
|
||||
<h2><a class="anchor" name="usage">
|
||||
Usage:</a></h2>
|
||||
This program uses OpenCV in order to recognize an image within an image. The return code is how many matches were found - return 0 for no matches, 1 for one match, etc.<h2><a class="anchor" name="example">
|
||||
Example Usage:</a></h2>
|
||||
Match two images against the root X11 window:<p>
|
||||
cva-match --x-root -s "<image_name>" -s "<image_name_2>"<p>
|
||||
Match a root and sub image with a custom tolerance and search method<p>
|
||||
cva-match -r "<root_image>" -s "<image_name>" -o 75 -m 1<h2><a class="anchor" name="options">
|
||||
Full Options:</a></h2>
|
||||
-h, --help: Display this usage message.<p>
|
||||
-u, --usage: Display this usage message.<p>
|
||||
-r, --root-image: Location of the root image to compare against.<p>
|
||||
-s, --sub-image: Location of the sub-image to find in root.<p>
|
||||
-p, --separator: Separator of the X and Y coordinates.<p>
|
||||
-t, --tolerance: Set how strict the match is - 100 is recommended lowest value.<p>
|
||||
<dl compact><dt><b>Note:</b></dt><dd>When using CCORR or CCOEFF tolerance works in opposite direction, so -50 is recommended highest value.</dd></dl>
|
||||
-m, --search-method: Set which method is used to search for sub-images.<p>
|
||||
<dl compact><dt><b>Note:</b></dt><dd>Search Methods: CV_TM_SQDIFF = 0, CV_TM_SQDIFF_NORMED = 1, CV_TM_CCORR = 2, CV_TM_CCORR_NORMED = 3, CV_TM_CCOEFF = 4, CV_TM_COEFF_NORMED = 5</dd></dl>
|
||||
-x, --x-root[=DISPLAY]: Set the root image to come from X11<p>
|
||||
<dl compact><dt><b>Note:</b></dt><dd>The DISPLAY variable is optional, not specifying it will cause X to use the default display (not specifically :0.0)</dd></dl>
|
||||
-c, --center: The output points should be centered on the sub-image, rather than the top-left corner.<p>
|
||||
-o, --sane-tolerance: Set the tolerance using a scale of 1-100, rather than INT_MIN to INT_MAX (100 ~= INT_MAX)<h2><a class="anchor" name="contact">
|
||||
Contact Information:</a></h2>
|
||||
Questions? Comments? Concerns? Suggestions? Send all feedback to Bradlee Speice at <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>> <hr size="1"><address style="align: right;"><small>Generated on Tue Jul 17 12:19:00 2012 for libcvautomation by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<title>libcvautomation: $title</title>
|
||||
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
||||
</script>
|
||||
<script type="text/x-mathjax-config">
|
||||
MathJax.Hub.Config({
|
||||
extensions: ["tex2jax.js"],
|
||||
jax: ["input/TeX","output/HTML-CSS"],
|
||||
});
|
||||
</script><script src="http://www.mathjax.org/mathjax/MathJax.js"></script>
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div! -->
|
||||
|
||||
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
|
||||
|
||||
<td style="padding-left: 0.5em;">
|
||||
<div id="projectname">libcvautomation
|
||||
 <span id="projectnumber">1.2</span>
|
||||
</div>
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<!-- Generated by Doxygen 1.7.6.1 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>Bradlee Speice <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>> </dd></dl>
|
||||
<dl class="date"><dt><b>Date:</b></dt><dd>7/18/2012 </dd></dl>
|
||||
<h2><a class="anchor" id="usage"></a>
|
||||
Usage:</h2>
|
||||
<p>This program uses OpenCV in order to recognize an image within an image. The return code is how many matches were found - return 0 for no matches, 1 for one match, etc.</p>
|
||||
<h2><a class="anchor" id="example"></a>
|
||||
Example Usage:</h2>
|
||||
<p>Match two images against the root X11 window:</p>
|
||||
<p>cva-match --x-root -s "<image_name>" -s "<image_name_2>"</p>
|
||||
<p>Match a root and sub image with a custom tolerance and search method</p>
|
||||
<p>cva-match -r "<root_image>" -s "<image_name>" -o 75 -m 1</p>
|
||||
<h2><a class="anchor" id="options"></a>
|
||||
Full Options:</h2>
|
||||
<p>-h, --help: Display this usage message.</p>
|
||||
<p>-u, --usage: Display this usage message.</p>
|
||||
<p>-r, --root-image: Location of the root image to compare against.</p>
|
||||
<p>-s, --sub-image: Location of the sub-image to find in root.</p>
|
||||
<p>-p, --separator: Separator of the X and Y coordinates.</p>
|
||||
<p>-t, --tolerance: Set how strict the match is - 100 is recommended lowest value.</p>
|
||||
<dl class="note"><dt><b>Note:</b></dt><dd>When using CCORR or CCOEFF tolerance works in opposite direction, so -50 is recommended highest value.</dd></dl>
|
||||
<p>-m, --search-method: Set which method is used to search for sub-images.</p>
|
||||
<dl class="note"><dt><b>Note:</b></dt><dd>Search Methods: CV_TM_SQDIFF = 0, CV_TM_SQDIFF_NORMED = 1, CV_TM_CCORR = 2, CV_TM_CCORR_NORMED = 3, CV_TM_CCOEFF = 4, CV_TM_COEFF_NORMED = 5</dd></dl>
|
||||
<p>-x, --x-root[=DISPLAY]: Set the root image to come from X11</p>
|
||||
<dl class="note"><dt><b>Note:</b></dt><dd>The DISPLAY variable is optional, not specifying it will cause X to use the default display (not specifically :0.0)</dd></dl>
|
||||
<p>-c, --center: The output points should be centered on the sub-image, rather than the top-left corner.</p>
|
||||
<p>-o, --sane-tolerance: Set the tolerance using a scale of 1-100, rather than INT_MIN to INT_MAX (100 ~= INT_MAX)</p>
|
||||
<h2><a class="anchor" id="contact"></a>
|
||||
Contact Information:</h2>
|
||||
<p>Questions? Comments? Concerns? Suggestions? Send all feedback to Bradlee Speice at <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>> </p>
|
||||
</div></div><!-- contents -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Defines</a></div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Wed Jul 18 2012 14:10:15 for libcvautomation by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.6.1
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user