Release version 1.2 documentation

This commit is contained in:
Bradlee Speice
2012-07-18 14:11:30 -04:00
parent 810e4e9fe8
commit 295c31692c
82 changed files with 8726 additions and 2780 deletions

View File

@ -1,77 +1,154 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<!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: cvautomationList Struct Reference</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&nbsp;Page</span></a></li>
<li id="current"><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&nbsp;Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<h1>cvautomationList Struct Reference</h1><!-- doxytag: class="cvautomationList" -->Implements a structure to build an array for methods like <a class="el" href="libcvautomation-opencv_8h.html#994981e2d31d5fb62fc3b227e36ebf87">matchSubImage_a()</a>.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="libcvautomation_8h-source.html">libcvautomation.h</a>&gt;</code>
<p>
<a href="structcvautomationList-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7608e8c8e792f6d7432841c94016bd50"></a><!-- doxytag: member="cvautomationList::cvaImage" ref="7608e8c8e792f6d7432841c94016bd50" args="" -->
IplImage *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcvautomationList.html#7608e8c8e792f6d7432841c94016bd50">cvaImage</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="81c1bcaa3616b80a839eead6cde7a652"></a><!-- doxytag: member="cvautomationList::fileName" ref="81c1bcaa3616b80a839eead6cde7a652" args="" -->
char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcvautomationList.html#81c1bcaa3616b80a839eead6cde7a652">fileName</a></td></tr>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44326574b58698c640110e846c9131fc"></a><!-- doxytag: member="cvautomationList::resultPoint" ref="44326574b58698c640110e846c9131fc" args="" -->
CvPoint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcvautomationList.html#44326574b58698c640110e846c9131fc">resultPoint</a></td></tr>
<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>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c29f1b89cd1e02ef1ece7f9aacfdf831"></a><!-- doxytag: member="cvautomationList::searchMethod" ref="c29f1b89cd1e02ef1ece7f9aacfdf831" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcvautomationList.html#c29f1b89cd1e02ef1ece7f9aacfdf831">searchMethod</a></td></tr>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d2ad67f51290f2291e8aec5bde3f049c"></a><!-- doxytag: member="cvautomationList::tolerance" ref="d2ad67f51290f2291e8aec5bde3f049c" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcvautomationList.html#d2ad67f51290f2291e8aec5bde3f049c">tolerance</a></td></tr>
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libcvautomation
&#160;<span id="projectnumber">1.2</span>
</div>
</td>
</tr>
</tbody>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Implements a structure to build an array for methods like <a class="el" href="libcvautomation-opencv_8h.html#994981e2d31d5fb62fc3b227e36ebf87">matchSubImage_a()</a>.
<p>
This structure is a simple way to wrap up all needed information for matching sub images in one location. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cvaImage</em>&nbsp;</td><td>An image in IplImage format </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fileName</em>&nbsp;</td><td>The file location of an image to be loaded </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resultPoint</em>&nbsp;</td><td>Holder for a result - for example, storing where this sub image was located in its root image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for this sub image in a root image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for this sub image in a root image </td></tr>
</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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<div class="title">cvautomationList Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="cvautomationList" -->
<p>Implements a structure to build an array for methods like <a class="el" href="libcvautomation-opencv_8h.html#a3facf18280800537b7b7694b5cd731cf" title="Parse an array of sub images and send them to matchSubImage()">matchSubImage_a()</a>
<a href="structcvautomationList.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="libcvautomation_8h_source.html">libcvautomation.h</a>&gt;</code></p>
<p><a href="structcvautomationList-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6fb9bc0615a1e745db5d156f92967987"></a><!-- doxytag: member="cvautomationList::cvaImage" ref="a6fb9bc0615a1e745db5d156f92967987" args="" -->
IplImage *&#160;</td><td class="memItemRight" valign="bottom"><b>cvaImage</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a028f83a54cb2aec781ab6ab3dff3c4d0"></a><!-- doxytag: member="cvautomationList::fileName" ref="a028f83a54cb2aec781ab6ab3dff3c4d0" args="" -->
char *&#160;</td><td class="memItemRight" valign="bottom"><b>fileName</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa5858ce563a5feb1e298a6135dee1a8"></a><!-- doxytag: member="cvautomationList::resultPoint" ref="aaa5858ce563a5feb1e298a6135dee1a8" args="" -->
CvPoint&#160;</td><td class="memItemRight" valign="bottom"><b>resultPoint</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ca7170bc73b7811134f12a178c8ff3a"></a><!-- doxytag: member="cvautomationList::searchMethod" ref="a5ca7170bc73b7811134f12a178c8ff3a" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>searchMethod</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef1f552a2e149ac86cea614ba3935597"></a><!-- doxytag: member="cvautomationList::tolerance" ref="aef1f552a2e149ac86cea614ba3935597" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>tolerance</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Implements a structure to build an array for methods like <a class="el" href="libcvautomation-opencv_8h.html#a3facf18280800537b7b7694b5cd731cf" title="Parse an array of sub images and send them to matchSubImage()">matchSubImage_a()</a> </p>
<p>This structure is a simple way to wrap up all needed information for matching sub images in one location. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cvaImage</td><td>An image in IplImage format </td></tr>
<tr><td class="paramname">fileName</td><td>The file location of an image to be loaded </td></tr>
<tr><td class="paramname">resultPoint</td><td>Holder for a result - for example, storing where this sub image was located in its root image </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for this sub image in a root image </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for this sub image in a root image </td></tr>
</table>
</dd>
</dl>
<dl compact><dt><b>See also:</b></dt><dd>libcv_search_methods </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcv_search_methods.html">Libcv Search Methods</a> </dd></dl>
<p>
<p>Definition at line <a class="el" href="libcvautomation_8h_source.html#l00040">40</a> of file <a class="el" href="libcvautomation_8h_source.html">libcvautomation.h</a>.</p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="libcvautomation_8h_source.html">libcvautomation.h</a></li>
</ul>
</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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
<p>
Definition at line <a class="el" href="libcvautomation_8h-source.html#l00038">38</a> of file <a class="el" href="libcvautomation_8h-source.html">libcvautomation.h</a>.<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="libcvautomation_8h-source.html">libcvautomation.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jul 17 12:19:00 2012 for libcvautomation by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>