<!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>mrpt::utils::TMatchingPairList Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<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><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a> </li>
<li class="navelem"><a class="el" href="namespacemrpt_1_1utils.html">utils</a> </li>
<li class="navelem"><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html">TMatchingPairList</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">mrpt::utils::TMatchingPairList Class Reference<div class="ingroups"><a class="el" href="group__mrpt__base__grp.html">[mrpt-base]</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::utils::TMatchingPairList" --><!-- doxytag: inherits="vector< TMatchingPair >" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A list of <a class="el" href="structmrpt_1_1utils_1_1_t_matching_pair.html" title="A structure for holding correspondences between two sets of points or points-like entities in 2D or 3...">TMatchingPair</a>. </p>
</div>
<p><code>#include <<a class="el" href="_t_matching_pair_8h_source.html">mrpt/utils/TMatchingPair.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mrpt::utils::TMatchingPairList:</div>
<div class="dyncontent">
<div class="center"><img src="classmrpt_1_1utils_1_1_t_matching_pair_list__inherit__graph.png" border="0" usemap="#mrpt_1_1utils_1_1_t_matching_pair_list_inherit__map" alt="Inheritance graph"/></div>
<map name="mrpt_1_1utils_1_1_t_matching_pair_list_inherit__map" id="mrpt_1_1utils_1_1_t_matching_pair_list_inherit__map">
<area shape="rect" id="node2" href="classstd_1_1vector.html" title="std::vector\< TMatchingPair \>" alt="" coords="5,96,197,123"/><area shape="rect" id="node4" href="classstd_1_1vector.html" title="STL class." alt="" coords="59,5,143,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classmrpt_1_1utils_1_1_t_matching_pair_list-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#aa4b8536560b363d842c7673c0c50fd98">indexOtherMapHasCorrespondence</a> (unsigned int idx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if the given index from the "other" map appears in the list. <a href="#aa4b8536560b363d842c7673c0c50fd98"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#a0829429fb9bede865855ebd57fbbdaee">dumpToFile</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &fileName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Saves the correspondences to a text file. <a href="#a0829429fb9bede865855ebd57fbbdaee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#ac8db7b502ef0fab6d417617de0e770f0">saveAsMATLABScript</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &filName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Saves the correspondences as a MATLAB script which draws them. <a href="#ac8db7b502ef0fab6d417617de0e770f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#a891a3d674623d0e0c934bcc4804d4974">overallSquareError</a> (const <a class="el" href="classmrpt_1_1poses_1_1_c_pose2_d.html">CPose2D</a> &q) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Computes the overall square error between the 2D points in the list of correspondences, given the 2D transformation "q" </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ \sum\limits_i e_i \]" src="form_83.png"/>
</p>
<p> Where <img class="formulaInl" alt="$ e_i $" src="form_84.png"/> are the elements of the square error vector as computed by computeSquareErrorVector. <a href="#a891a3d674623d0e0c934bcc4804d4974"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#a4b1912c2d828f27b1208210e853eeaac">overallSquareErrorAndPoints</a> (const <a class="el" href="classmrpt_1_1poses_1_1_c_pose2_d.html">CPose2D</a> &q, <a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> &xs, <a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> &ys) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Computes the overall square error between the 2D points in the list of correspondences, given the 2D transformation "q", and return the transformed points as well. <a href="#a4b1912c2d828f27b1208210e853eeaac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#aadb538605544eaea8a2740d9230818fb">squareErrorVector</a> (const <a class="el" href="classmrpt_1_1poses_1_1_c_pose2_d.html">CPose2D</a> &q, <a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> &out_sqErrs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a vector with the square error between each pair of correspondences in the list, given the 2D transformation "q" Each element <img class="formulaInl" alt="$ e_i $" src="form_84.png"/> is the square distance between the "this" (global) point and the "other" (local) point transformed through "q": </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ e_i = | x_{this} - q \oplus x_{other} |^2 \]" src="form_85.png"/>
</p>
<p>. <a href="#aadb538605544eaea8a2740d9230818fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#ad356eb49bc50d1b9142c41b9d23afc19">squareErrorVector</a> (const <a class="el" href="classmrpt_1_1poses_1_1_c_pose2_d.html">CPose2D</a> &q, <a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> &out_sqErrs, <a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> &xs, <a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> &ys) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a vector with the square error between each pair of correspondences in the list and the transformed "other" (local) points, given the 2D transformation "q" Each element <img class="formulaInl" alt="$ e_i $" src="form_84.png"/> is the square distance between the "this" (global) point and the "other" (local) point transformed through "q": </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ e_i = | x_{this} - q \oplus x_{other} |^2 \]" src="form_85.png"/>
</p>
<p>. <a href="#ad356eb49bc50d1b9142c41b9d23afc19"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#ac6dfa14bdd472557be4e5579be0d4762">contains</a> (const <a class="el" href="structmrpt_1_1utils_1_1_t_matching_pair.html">TMatchingPair</a> &p) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test whether the given pair "p" is within the pairings. <a href="#ac6dfa14bdd472557be4e5579be0d4762"></a><br/></td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac6dfa14bdd472557be4e5579be0d4762"></a><!-- doxytag: member="mrpt::utils::TMatchingPairList::contains" ref="ac6dfa14bdd472557be4e5579be0d4762" args="(const TMatchingPair &p) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::TMatchingPairList::contains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmrpt_1_1utils_1_1_t_matching_pair.html">TMatchingPair</a> & </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test whether the given pair "p" is within the pairings. </p>
</div>
</div>
<a class="anchor" id="a0829429fb9bede865855ebd57fbbdaee"></a><!-- doxytag: member="mrpt::utils::TMatchingPairList::dumpToFile" ref="a0829429fb9bede865855ebd57fbbdaee" args="(const std::string &fileName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::TMatchingPairList::dumpToFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>fileName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Saves the correspondences to a text file. </p>
</div>
</div>
<a class="anchor" id="aa4b8536560b363d842c7673c0c50fd98"></a><!-- doxytag: member="mrpt::utils::TMatchingPairList::indexOtherMapHasCorrespondence" ref="aa4b8536560b363d842c7673c0c50fd98" args="(unsigned int idx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::TMatchingPairList::indexOtherMapHasCorrespondence </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>idx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks if the given index from the "other" map appears in the list. </p>
</div>
</div>
<a class="anchor" id="a891a3d674623d0e0c934bcc4804d4974"></a><!-- doxytag: member="mrpt::utils::TMatchingPairList::overallSquareError" ref="a891a3d674623d0e0c934bcc4804d4974" args="(const CPose2D &q) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float mrpt::utils::TMatchingPairList::overallSquareError </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmrpt_1_1poses_1_1_c_pose2_d.html">CPose2D</a> & </td>
<td class="paramname"><em>q</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Computes the overall square error between the 2D points in the list of correspondences, given the 2D transformation "q" </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ \sum\limits_i e_i \]" src="form_83.png"/>
</p>
<p> Where <img class="formulaInl" alt="$ e_i $" src="form_84.png"/> are the elements of the square error vector as computed by computeSquareErrorVector. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#aadb538605544eaea8a2740d9230818fb" title="Returns a vector with the square error between each pair of correspondences in the list...">squareErrorVector</a>, <a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#a4b1912c2d828f27b1208210e853eeaac" title="Computes the overall square error between the 2D points in the list of correspondences, given the 2D transformation "q", and return the transformed points as well.">overallSquareErrorAndPoints</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4b1912c2d828f27b1208210e853eeaac"></a><!-- doxytag: member="mrpt::utils::TMatchingPairList::overallSquareErrorAndPoints" ref="a4b1912c2d828f27b1208210e853eeaac" args="(const CPose2D &q, vector_float &xs, vector_float &ys) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float mrpt::utils::TMatchingPairList::overallSquareErrorAndPoints </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmrpt_1_1poses_1_1_c_pose2_d.html">CPose2D</a> & </td>
<td class="paramname"><em>q</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> & </td>
<td class="paramname"><em>xs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> & </td>
<td class="paramname"><em>ys</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Computes the overall square error between the 2D points in the list of correspondences, given the 2D transformation "q", and return the transformed points as well. </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ \sum\limits_i e_i \]" src="form_83.png"/>
</p>
<p> Where <img class="formulaInl" alt="$ e_i $" src="form_84.png"/> are the elements of the square error vector as computed by computeSquareErrorVector </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#aadb538605544eaea8a2740d9230818fb" title="Returns a vector with the square error between each pair of correspondences in the list...">squareErrorVector</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac8db7b502ef0fab6d417617de0e770f0"></a><!-- doxytag: member="mrpt::utils::TMatchingPairList::saveAsMATLABScript" ref="ac8db7b502ef0fab6d417617de0e770f0" args="(const std::string &filName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::TMatchingPairList::saveAsMATLABScript </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>filName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Saves the correspondences as a MATLAB script which draws them. </p>
</div>
</div>
<a class="anchor" id="aadb538605544eaea8a2740d9230818fb"></a><!-- doxytag: member="mrpt::utils::TMatchingPairList::squareErrorVector" ref="aadb538605544eaea8a2740d9230818fb" args="(const CPose2D &q, vector_float &out_sqErrs) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::TMatchingPairList::squareErrorVector </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmrpt_1_1poses_1_1_c_pose2_d.html">CPose2D</a> & </td>
<td class="paramname"><em>q</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> & </td>
<td class="paramname"><em>out_sqErrs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a vector with the square error between each pair of correspondences in the list, given the 2D transformation "q" Each element <img class="formulaInl" alt="$ e_i $" src="form_84.png"/> is the square distance between the "this" (global) point and the "other" (local) point transformed through "q": </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ e_i = | x_{this} - q \oplus x_{other} |^2 \]" src="form_85.png"/>
</p>
<p>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#a891a3d674623d0e0c934bcc4804d4974" title="Computes the overall square error between the 2D points in the list of correspondences, given the 2D transformation "q" Where are the elements of the square error vector as computed by computeSquareErrorVector.">overallSquareError</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad356eb49bc50d1b9142c41b9d23afc19"></a><!-- doxytag: member="mrpt::utils::TMatchingPairList::squareErrorVector" ref="ad356eb49bc50d1b9142c41b9d23afc19" args="(const CPose2D &q, vector_float &out_sqErrs, vector_float &xs, vector_float &ys) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::TMatchingPairList::squareErrorVector </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmrpt_1_1poses_1_1_c_pose2_d.html">CPose2D</a> & </td>
<td class="paramname"><em>q</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> & </td>
<td class="paramname"><em>out_sqErrs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> & </td>
<td class="paramname"><em>xs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemrpt.html#aa271572e3985202e030758bfd54a02e1">vector_float</a> & </td>
<td class="paramname"><em>ys</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a vector with the square error between each pair of correspondences in the list and the transformed "other" (local) points, given the 2D transformation "q" Each element <img class="formulaInl" alt="$ e_i $" src="form_84.png"/> is the square distance between the "this" (global) point and the "other" (local) point transformed through "q": </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ e_i = | x_{this} - q \oplus x_{other} |^2 \]" src="form_85.png"/>
</p>
<p>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_t_matching_pair_list.html#a891a3d674623d0e0c934bcc4804d4974" title="Computes the overall square error between the 2D points in the list of correspondences, given the 2D transformation "q" Where are the elements of the square error vector as computed by computeSquareErrorVector.">overallSquareError</a> </dd></dl>
</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
