Sophie

Sophie

distrib > Fedora > 16 > i386 > by-pkgid > 4bc66056a634db26a1f4d0845dc41ca6 > files > 5314

mrpt-doc-0.9.5-0.1.20110925svn2670.fc16.i686.rpm

<!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::CMappedImage 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> &gt; <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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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_c_mapped_image.html">CMappedImage</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">mrpt::utils::CMappedImage 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::CMappedImage" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class encapsulates a MRPT Image and allows the sampling of individual pixels with sub-pixel accuracy and with a change of coordinates (eg, meters). </p>
<p>Only work with graylevels (for convenience), so if a color image is passed it'll be passed first to grayscale.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_c_image.html" title="A class for storing images as grayscale or RGB bitmaps.">CImage</a> </dd></dl>
</div>
<p><code>#include &lt;<a class="el" href="_c_mapped_image_8h_source.html">mrpt/utils/CMappedImage.h</a>&gt;</code></p>

<p><a href="classmrpt_1_1utils_1_1_c_mapped_image-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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a2595c82750aea6eee1ca632967f32a36">CMappedImage</a> (<a class="el" href="structmrpt_1_1utils_1_1_c_image_ptr.html">CImagePtr</a> img, double x0=0, double x1=-1, double y0=0, double y1=-1, <a class="el" href="group__mrpt__base__grp.html#gaaa1dce60212047066cc950eb834e96fd">TInterpolationMethod</a> method=IMG_INTERP_LINEAR)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor: Must pass an image (as a smart pointer) and the coordinates of the border.  <a href="#a2595c82750aea6eee1ca632967f32a36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#aec85251fb8b757685af7f54504398232">changeCoordinates</a> (double x0, double x1, double y0, double y1)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Changes the coordinates of the image (see constructor for the meaning)  <a href="#aec85251fb8b757685af7f54504398232"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a4a345e4ada8d5e6e6fa8d2aab39e8d20">getPixel</a> (double x, double y) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the interpolated pixel at the coordinates (x,y), in the range [0,255] (grayscale) If the point is out of the image, 0 is returned.  <a href="#a4a345e4ada8d5e6e6fa8d2aab39e8d20"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrpt_1_1utils_1_1_c_image_ptr.html">CImagePtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a2c8c03b1327c622accd1ea24ef3adf72">m_img</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a6972899df586ee5ca12a99983834d41f">m_x0</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a183a7596c1f7937d18c42760c920ba7d">m_x1</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#ac46ecccb30104bb5ababa428c1a2cd27">m_y0</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a930775a75d658b72345d094d6777743a">m_y1</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a29ee26a3f9a053ea10bbfe10fa5835c6">m_pixel_size</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">width * pixel_size = (x1-x0)  <a href="#a29ee26a3f9a053ea10bbfe10fa5835c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mrpt__base__grp.html#gaaa1dce60212047066cc950eb834e96fd">TInterpolationMethod</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a0cf0e674dbe69bfa1a53bc306700f3ab">m_method</a></td></tr>
</table>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2595c82750aea6eee1ca632967f32a36"></a><!-- doxytag: member="mrpt::utils::CMappedImage::CMappedImage" ref="a2595c82750aea6eee1ca632967f32a36" args="(CImagePtr img, double x0=0, double x1=&#45;1, double y0=0, double y1=&#45;1, TInterpolationMethod method=IMG_INTERP_LINEAR)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mrpt::utils::CMappedImage::CMappedImage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structmrpt_1_1utils_1_1_c_image_ptr.html">CImagePtr</a>&#160;</td>
          <td class="paramname"><em>img</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>x0</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>x1</em> = <code>-1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>y0</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>y1</em> = <code>-1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__mrpt__base__grp.html#gaaa1dce60212047066cc950eb834e96fd">TInterpolationMethod</a>&#160;</td>
          <td class="paramname"><em>method</em> = <code>IMG_INTERP_LINEAR</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructor: Must pass an image (as a smart pointer) and the coordinates of the border. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">img</td><td>The image. A copy of the smart pointer is kept internally to this object. </td></tr>
    <tr><td class="paramname">x0</td><td>Coordinate X of the left side (default: 0) </td></tr>
    <tr><td class="paramname">x1</td><td>Coordinate X of the right side (or -1 to IMAGE_WIDTH-1) </td></tr>
    <tr><td class="paramname">y0</td><td>Coordinate Y of the top side (default: 0) </td></tr>
    <tr><td class="paramname">y1</td><td>Coordinate Y of the bottom side (or -1 to IMAGE_HEIGHT-1) </td></tr>
    <tr><td class="paramname">method</td><td>The interpolation method: It can be imNEAREST, imBILINEAR or imBICUBIC. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aec85251fb8b757685af7f54504398232"></a><!-- doxytag: member="mrpt::utils::CMappedImage::changeCoordinates" ref="aec85251fb8b757685af7f54504398232" args="(double x0, double x1, double y0, double y1)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mrpt::utils::CMappedImage::changeCoordinates </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>x0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>x1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>y0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>y1</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Changes the coordinates of the image (see constructor for the meaning) </p>

</div>
</div>
<a class="anchor" id="a4a345e4ada8d5e6e6fa8d2aab39e8d20"></a><!-- doxytag: member="mrpt::utils::CMappedImage::getPixel" ref="a4a345e4ada8d5e6e6fa8d2aab39e8d20" args="(double x, double y) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double mrpt::utils::CMappedImage::getPixel </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>y</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the interpolated pixel at the coordinates (x,y), in the range [0,255] (grayscale) If the point is out of the image, 0 is returned. </p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a2c8c03b1327c622accd1ea24ef3adf72"></a><!-- doxytag: member="mrpt::utils::CMappedImage::m_img" ref="a2c8c03b1327c622accd1ea24ef3adf72" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structmrpt_1_1utils_1_1_c_image_ptr.html">CImagePtr</a> <a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a2c8c03b1327c622accd1ea24ef3adf72">mrpt::utils::CMappedImage::m_img</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_c_mapped_image_8h_source.html#l00046">46</a> of file <a class="el" href="_c_mapped_image_8h_source.html">CMappedImage.h</a>.</p>

</div>
</div>
<a class="anchor" id="a0cf0e674dbe69bfa1a53bc306700f3ab"></a><!-- doxytag: member="mrpt::utils::CMappedImage::m_method" ref="a0cf0e674dbe69bfa1a53bc306700f3ab" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__mrpt__base__grp.html#gaaa1dce60212047066cc950eb834e96fd">TInterpolationMethod</a> <a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a0cf0e674dbe69bfa1a53bc306700f3ab">mrpt::utils::CMappedImage::m_method</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_c_mapped_image_8h_source.html#l00049">49</a> of file <a class="el" href="_c_mapped_image_8h_source.html">CMappedImage.h</a>.</p>

</div>
</div>
<a class="anchor" id="a29ee26a3f9a053ea10bbfe10fa5835c6"></a><!-- doxytag: member="mrpt::utils::CMappedImage::m_pixel_size" ref="a29ee26a3f9a053ea10bbfe10fa5835c6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a29ee26a3f9a053ea10bbfe10fa5835c6">mrpt::utils::CMappedImage::m_pixel_size</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>width * pixel_size = (x1-x0) </p>

<p>Definition at line <a class="el" href="_c_mapped_image_8h_source.html#l00048">48</a> of file <a class="el" href="_c_mapped_image_8h_source.html">CMappedImage.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6972899df586ee5ca12a99983834d41f"></a><!-- doxytag: member="mrpt::utils::CMappedImage::m_x0" ref="a6972899df586ee5ca12a99983834d41f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a6972899df586ee5ca12a99983834d41f">mrpt::utils::CMappedImage::m_x0</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_c_mapped_image_8h_source.html#l00047">47</a> of file <a class="el" href="_c_mapped_image_8h_source.html">CMappedImage.h</a>.</p>

</div>
</div>
<a class="anchor" id="a183a7596c1f7937d18c42760c920ba7d"></a><!-- doxytag: member="mrpt::utils::CMappedImage::m_x1" ref="a183a7596c1f7937d18c42760c920ba7d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a183a7596c1f7937d18c42760c920ba7d">mrpt::utils::CMappedImage::m_x1</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_c_mapped_image_8h_source.html#l00047">47</a> of file <a class="el" href="_c_mapped_image_8h_source.html">CMappedImage.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac46ecccb30104bb5ababa428c1a2cd27"></a><!-- doxytag: member="mrpt::utils::CMappedImage::m_y0" ref="ac46ecccb30104bb5ababa428c1a2cd27" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#ac46ecccb30104bb5ababa428c1a2cd27">mrpt::utils::CMappedImage::m_y0</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_c_mapped_image_8h_source.html#l00047">47</a> of file <a class="el" href="_c_mapped_image_8h_source.html">CMappedImage.h</a>.</p>

</div>
</div>
<a class="anchor" id="a930775a75d658b72345d094d6777743a"></a><!-- doxytag: member="mrpt::utils::CMappedImage::m_y1" ref="a930775a75d658b72345d094d6777743a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classmrpt_1_1utils_1_1_c_mapped_image.html#a930775a75d658b72345d094d6777743a">mrpt::utils::CMappedImage::m_y1</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_c_mapped_image_8h_source.html#l00047">47</a> of file <a class="el" href="_c_mapped_image_8h_source.html">CMappedImage.h</a>.</p>

</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>