mirror of
https://github.com/introlab/rtabmap.git
synced 2026-10-03 16:47:47 +08:00
302 lines
14 KiB
HTML
302 lines
14 KiB
HTML
<!-- HTML header for doxygen 1.9.8-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RTAB-Map: Region of Interest (ROI) Computation</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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="custom.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript">window.RTABMAP_DOC_ROOT="";</script>
|
|
<script type="text/javascript" src="../versions.js"></script>
|
|
<script type="text/javascript" src="version-switcher.js"></script>
|
|
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
|
|
<script type="text/javascript">DoxygenAwesomeDarkModeToggle.init();</script>
|
|
</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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">RTAB-Map<span id="projectnumber"> 0.23.13</span>
|
|
</div>
|
|
<div id="projectbrief">Real-Time Appearance-Based Mapping</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('group__RoiComputation.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Region of Interest (ROI) Computation</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga79d3f93673fb236980f0be532695f478" id="r_ga79d3f93673fb236980f0be532695f478"><td class="memItemLeft" align="right" valign="top">cv::Rect RTABMAP_CORE_EXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RoiComputation.html#ga79d3f93673fb236980f0be532695f478">rtabmap::util2d::computeRoi</a> (const cv::Mat &image, const std::string &roiRatios)</td></tr>
|
|
<tr class="memdesc:ga79d3f93673fb236980f0be532695f478"><td class="mdescLeft"> </td><td class="mdescRight">Computes a region of interest (ROI) in the image using string-defined ratios. <br /></td></tr>
|
|
<tr class="separator:ga79d3f93673fb236980f0be532695f478"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2f0ffb8f6882e28709b03446d50250bb" id="r_ga2f0ffb8f6882e28709b03446d50250bb"><td class="memItemLeft" align="right" valign="top">cv::Rect RTABMAP_CORE_EXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RoiComputation.html#ga2f0ffb8f6882e28709b03446d50250bb">rtabmap::util2d::computeRoi</a> (const cv::Size &imageSize, const std::string &roiRatios)</td></tr>
|
|
<tr class="memdesc:ga2f0ffb8f6882e28709b03446d50250bb"><td class="mdescLeft"> </td><td class="mdescRight">Computes a region of interest (ROI) from an image size and a string of ratios. <br /></td></tr>
|
|
<tr class="separator:ga2f0ffb8f6882e28709b03446d50250bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga81d9f49d117d02494c7ff57f5d426b15" id="r_ga81d9f49d117d02494c7ff57f5d426b15"><td class="memItemLeft" align="right" valign="top">cv::Rect RTABMAP_CORE_EXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RoiComputation.html#ga81d9f49d117d02494c7ff57f5d426b15">rtabmap::util2d::computeRoi</a> (const cv::Mat &image, const std::vector< float > &roiRatios)</td></tr>
|
|
<tr class="memdesc:ga81d9f49d117d02494c7ff57f5d426b15"><td class="mdescLeft"> </td><td class="mdescRight">Computes a region of interest (ROI) in the image using float vector-defined ratios. <br /></td></tr>
|
|
<tr class="separator:ga81d9f49d117d02494c7ff57f5d426b15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga56fed8ce688e8e9eb3b1f74ad0febcef" id="r_ga56fed8ce688e8e9eb3b1f74ad0febcef"><td class="memItemLeft" align="right" valign="top">cv::Rect RTABMAP_CORE_EXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RoiComputation.html#ga56fed8ce688e8e9eb3b1f74ad0febcef">rtabmap::util2d::computeRoi</a> (const cv::Size &imageSize, const std::vector< float > &roiRatios)</td></tr>
|
|
<tr class="memdesc:ga56fed8ce688e8e9eb3b1f74ad0febcef"><td class="mdescLeft"> </td><td class="mdescRight">Computes a region of interest (ROI) using float ratios and the image size. <br /></td></tr>
|
|
<tr class="separator:ga56fed8ce688e8e9eb3b1f74ad0febcef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Functions to compute the ROI in an image using ratio-based cropping. </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga79d3f93673fb236980f0be532695f478" name="ga79d3f93673fb236980f0be532695f478"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga79d3f93673fb236980f0be532695f478">◆ </a></span>computeRoi() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">cv::Rect RTABMAP_CORE_EXPORT rtabmap::util2d::computeRoi </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const cv::Mat & </td>
|
|
<td class="paramname"><em>image</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>roiRatios</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Computes a region of interest (ROI) in the image using string-defined ratios. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image</td><td>Input image. </td></tr>
|
|
<tr><td class="paramname">roiRatios</td><td>A string of 4 space-separated float values representing the ROI ratios:<ul>
|
|
<li>left, right, top, bottom.</li>
|
|
<li>Each ratio should be between 0 and 1.</li>
|
|
<li>For example, "0.1 0.1 0.2 0.2" removes 10% from the left/right and 20% from the top/bottom. </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A cv::Rect defining the ROI, or an empty rectangle if input is invalid. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga2f0ffb8f6882e28709b03446d50250bb" name="ga2f0ffb8f6882e28709b03446d50250bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga2f0ffb8f6882e28709b03446d50250bb">◆ </a></span>computeRoi() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">cv::Rect RTABMAP_CORE_EXPORT rtabmap::util2d::computeRoi </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const cv::Size & </td>
|
|
<td class="paramname"><em>imageSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>roiRatios</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Computes a region of interest (ROI) from an image size and a string of ratios. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">imageSize</td><td>The size of the image (width x height). </td></tr>
|
|
<tr><td class="paramname">roiRatios</td><td>A string with 4 space-separated float values indicating cropping ratios:<ul>
|
|
<li>left, right, top, bottom. </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The computed ROI rectangle. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga81d9f49d117d02494c7ff57f5d426b15" name="ga81d9f49d117d02494c7ff57f5d426b15"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga81d9f49d117d02494c7ff57f5d426b15">◆ </a></span>computeRoi() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">cv::Rect RTABMAP_CORE_EXPORT rtabmap::util2d::computeRoi </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const cv::Mat & </td>
|
|
<td class="paramname"><em>image</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< float > & </td>
|
|
<td class="paramname"><em>roiRatios</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Computes a region of interest (ROI) in the image using float vector-defined ratios. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image</td><td>Input image. </td></tr>
|
|
<tr><td class="paramname">roiRatios</td><td>A vector of 4 float values (left, right, top, bottom) representing the ROI.<ul>
|
|
<li>Each value should be between 0 and 1. </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A cv::Rect defining the cropped region. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga56fed8ce688e8e9eb3b1f74ad0febcef" name="ga56fed8ce688e8e9eb3b1f74ad0febcef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga56fed8ce688e8e9eb3b1f74ad0febcef">◆ </a></span>computeRoi() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">cv::Rect RTABMAP_CORE_EXPORT rtabmap::util2d::computeRoi </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const cv::Size & </td>
|
|
<td class="paramname"><em>imageSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< float > & </td>
|
|
<td class="paramname"><em>roiRatios</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Computes a region of interest (ROI) using float ratios and the image size. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">imageSize</td><td>The size of the image (width x height). </td></tr>
|
|
<tr><td class="paramname">roiRatios</td><td>A vector of 4 float values representing ratios for cropping:<ul>
|
|
<li>[left, right, top, bottom].</li>
|
|
<li>Each must be in the range [0, 1), and valid (i.e., left + right < 1, top + bottom < 1). </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The computed ROI rectangle. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|