|
@@ -0,0 +1,347 @@
|
|
|
+<!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"/>
|
|
|
+<meta name="generator" content="Doxygen 1.8.12"/>
|
|
|
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
|
+<title>Tracore: util::Filter2D Class Reference</title>
|
|
|
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
|
+<script type="text/javascript" src="jquery.js"></script>
|
|
|
+<script type="text/javascript" src="dynsections.js"></script>
|
|
|
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
|
+<script type="text/javascript" src="search/searchdata.js"></script>
|
|
|
+<script type="text/javascript" src="search/search.js"></script>
|
|
|
+<script type="text/javascript">
|
|
|
+ $(document).ready(function() { init_search(); });
|
|
|
+</script>
|
|
|
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
|
+</head>
|
|
|
+<body>
|
|
|
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
|
+<div id="titlearea">
|
|
|
+<table cellspacing="0" cellpadding="0">
|
|
|
+ <tbody>
|
|
|
+ <tr style="height: 56px;">
|
|
|
+ <td id="projectalign" style="padding-left: 0.5em;">
|
|
|
+ <div id="projectname">Tracore
|
|
|
+ </div>
|
|
|
+ </td>
|
|
|
+ </tr>
|
|
|
+ </tbody>
|
|
|
+</table>
|
|
|
+</div>
|
|
|
+<!-- end header part -->
|
|
|
+<!-- Generated by Doxygen 1.8.12 -->
|
|
|
+<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="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 List</span></a></li>
|
|
|
+ <li><a href="classes.html"><span>Class Index</span></a></li>
|
|
|
+ <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
|
+ <li><a href="functions.html"><span>Class Members</span></a></li>
|
|
|
+ </ul>
|
|
|
+ </div>
|
|
|
+<!-- window showing the filter options -->
|
|
|
+<div id="MSearchSelectWindow"
|
|
|
+ onmouseover="return searchBox.OnSearchSelectShow()"
|
|
|
+ onmouseout="return searchBox.OnSearchSelectHide()"
|
|
|
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
|
+</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>
|
|
|
+
|
|
|
+<div id="nav-path" class="navpath">
|
|
|
+ <ul>
|
|
|
+<li class="navelem"><b>util</b></li><li class="navelem"><a class="el" href="classutil_1_1Filter2D.html">Filter2D</a></li> </ul>
|
|
|
+</div>
|
|
|
+</div><!-- top -->
|
|
|
+<div class="header">
|
|
|
+ <div class="summary">
|
|
|
+<a href="#pub-methods">Public Member Functions</a> |
|
|
|
+<a href="classutil_1_1Filter2D-members.html">List of all members</a> </div>
|
|
|
+ <div class="headertitle">
|
|
|
+<div class="title">util::Filter2D Class Reference</div> </div>
|
|
|
+</div><!--header-->
|
|
|
+<div class="contents">
|
|
|
+
|
|
|
+<p><code>#include <<a class="el" href="Filter2D_8h_source.html">Filter2D.h</a>></code></p>
|
|
|
+<table class="memberdecls">
|
|
|
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
|
+Public Member Functions</h2></td></tr>
|
|
|
+<tr class="memitem:a56cbb0d40a118f98c5a21d1b0a9e1953"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Filter2D.html#a56cbb0d40a118f98c5a21d1b0a9e1953">Filter2D</a> ()</td></tr>
|
|
|
+<tr class="separator:a56cbb0d40a118f98c5a21d1b0a9e1953"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a83896f35678afd4a024b2ae0255b3e38"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Filter2D.html#a83896f35678afd4a024b2ae0255b3e38">Filter2D</a> (double multiplier, std::vector< double > mask)</td></tr>
|
|
|
+<tr class="separator:a83896f35678afd4a024b2ae0255b3e38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a1d14212292766b1372b190842d8330e8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Filter2D.html#a1d14212292766b1372b190842d8330e8">Filter2D</a> (std::string const &mask_string, char delimiter)</td></tr>
|
|
|
+<tr class="separator:a1d14212292766b1372b190842d8330e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:ab59311cc1727f5285a56c050ede7b14a"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Filter2D.html#ab59311cc1727f5285a56c050ede7b14a">Get</a> (int x, int y) const</td></tr>
|
|
|
+<tr class="separator:ab59311cc1727f5285a56c050ede7b14a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:ad6866d21e5b1d3d6863d859f1b7fa288"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Filter2D.html#ad6866d21e5b1d3d6863d859f1b7fa288">Get</a> (int i) const</td></tr>
|
|
|
+<tr class="separator:ad6866d21e5b1d3d6863d859f1b7fa288"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a2b61ed6deaebb2e97fda04cadd43459c"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Filter2D.html#a2b61ed6deaebb2e97fda04cadd43459c">GetMultiplier</a> () const</td></tr>
|
|
|
+<tr class="separator:a2b61ed6deaebb2e97fda04cadd43459c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:af273117c197dc90208167cd873fe0097"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Filter2D.html#af273117c197dc90208167cd873fe0097">GetVicinity</a> () const</td></tr>
|
|
|
+<tr class="separator:af273117c197dc90208167cd873fe0097"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a4151856406f7a794cd724ce4a7e347eb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Filter2D.html#a4151856406f7a794cd724ce4a7e347eb">GetDimension</a> () const</td></tr>
|
|
|
+<tr class="separator:a4151856406f7a794cd724ce4a7e347eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+<tr class="memitem:a242138102e2e30f4fe9cccf76f817e09"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Filter2D.html#a242138102e2e30f4fe9cccf76f817e09">Normalize</a> ()</td></tr>
|
|
|
+<tr class="separator:a242138102e2e30f4fe9cccf76f817e09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
+</table>
|
|
|
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
|
+<div class="textblock"><p>Utility class for a two-dimensional filter. </p>
|
|
|
+</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
|
+<a class="anchor" id="a56cbb0d40a118f98c5a21d1b0a9e1953"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">util::Filter2D::Filter2D </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Creates a new instance with an identity filter. </p>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a83896f35678afd4a024b2ae0255b3e38"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">util::Filter2D::Filter2D </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">double </td>
|
|
|
+ <td class="paramname"><em>multiplier</em>, </td>
|
|
|
+ </tr>
|
|
|
+ <tr>
|
|
|
+ <td class="paramkey"></td>
|
|
|
+ <td></td>
|
|
|
+ <td class="paramtype">std::vector< double > </td>
|
|
|
+ <td class="paramname"><em>mask</em> </td>
|
|
|
+ </tr>
|
|
|
+ <tr>
|
|
|
+ <td></td>
|
|
|
+ <td>)</td>
|
|
|
+ <td></td><td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Creates a new instance with the given multiplier and mask values. To calculate the value all values are added with their weights from the mask and then the value is multiplied by the multiplier. The multiplier may be used to ensure the overall filter sum is equals one.</p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">multiplier</td><td>The multiplier </td></tr>
|
|
|
+ <tr><td class="paramname">mask</td><td>The mask values </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a1d14212292766b1372b190842d8330e8"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">util::Filter2D::Filter2D </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">std::string const & </td>
|
|
|
+ <td class="paramname"><em>mask_string</em>, </td>
|
|
|
+ </tr>
|
|
|
+ <tr>
|
|
|
+ <td class="paramkey"></td>
|
|
|
+ <td></td>
|
|
|
+ <td class="paramtype">char </td>
|
|
|
+ <td class="paramname"><em>delimiter</em> </td>
|
|
|
+ </tr>
|
|
|
+ <tr>
|
|
|
+ <td></td>
|
|
|
+ <td>)</td>
|
|
|
+ <td></td><td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Creates a new instance by parsing the specified mask string. Values are separated by the specified delimiter. Example: 'multiplier, m00, m01, m02, ..., m10, m11, m12, ..., mnn' as the mask string and ',' as the delimiter.</p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">mask_string</td><td>The string with the multiplier and the mask values to parse </td></tr>
|
|
|
+ <tr><td class="paramname">delimiter</td><td>The delimiter used for the parsing </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<h2 class="groupheader">Member Function Documentation</h2>
|
|
|
+<a class="anchor" id="ab59311cc1727f5285a56c050ede7b14a"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">double util::Filter2D::Get </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">int </td>
|
|
|
+ <td class="paramname"><em>x</em>, </td>
|
|
|
+ </tr>
|
|
|
+ <tr>
|
|
|
+ <td class="paramkey"></td>
|
|
|
+ <td></td>
|
|
|
+ <td class="paramtype">int </td>
|
|
|
+ <td class="paramname"><em>y</em> </td>
|
|
|
+ </tr>
|
|
|
+ <tr>
|
|
|
+ <td></td>
|
|
|
+ <td>)</td>
|
|
|
+ <td></td><td> const</td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Gets the value in the mask at the specified position.</p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">x</td><td>The horizontal position </td></tr>
|
|
|
+ <tr><td class="paramname">y</td><td>The vertical position </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>The value </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="ad6866d21e5b1d3d6863d859f1b7fa288"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">double util::Filter2D::Get </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">int </td>
|
|
|
+ <td class="paramname"><em>i</em></td><td>)</td>
|
|
|
+ <td> const</td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Gets the value in the mask at the specified position.</p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">i</td><td>The index (row-major) </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>The value </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a4151856406f7a794cd724ce4a7e347eb"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">int util::Filter2D::GetDimension </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td> const</td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Gets the dimension of the mask.</p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>The dimension </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a2b61ed6deaebb2e97fda04cadd43459c"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">double util::Filter2D::GetMultiplier </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td> const</td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Gets the multiplier.</p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>The multiplier </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="af273117c197dc90208167cd873fe0097"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">int util::Filter2D::GetVicinity </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td> const</td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Gets the vicinity of the mask. The vicinity is the based on the center and describes the maximum range of values around it in manhattan distance.</p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>The vicinity </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a class="anchor" id="a242138102e2e30f4fe9cccf76f817e09"></a>
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">void util::Filter2D::Normalize </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+<p>Normalizes the mask values. The multiplier is equals one afterwards. </p>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<hr/>The documentation for this class was generated from the following files:<ul>
|
|
|
+<li>util/<a class="el" href="Filter2D_8h_source.html">Filter2D.h</a></li>
|
|
|
+<li>util/Filter2D.cpp</li>
|
|
|
+</ul>
|
|
|
+</div><!-- contents -->
|
|
|
+<!-- start footer part -->
|
|
|
+<hr class="footer"/><address class="footer"><small>
|
|
|
+Generated by  <a href="http://www.doxygen.org/index.html">
|
|
|
+<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
|
+</a> 1.8.12
|
|
|
+</small></address>
|
|
|
+</body>
|
|
|
+</html>
|