Files
rtabmap/api/latest/group__ExtractIndices.html
T

183 lines
15 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: Point Cloud Indices Extraction</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">&#160;0.23.11</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&amp;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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__ExtractIndices.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">Point Cloud Indices Extraction</div></div>
</div><!--header-->
<div class="contents">
<p>Extracts a subset of points from a point cloud based on specified indices.
<a href="#details">More...</a></p>
<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:ga8685395807479f06b19d9d41616a03a7" id="r_ga8685395807479f06b19d9d41616a03a7"><td class="memItemLeft" align="right" valign="top"><a id="ga8685395807479f06b19d9d41616a03a7" name="ga8685395807479f06b19d9d41616a03a7"></a>
pcl::IndicesPtr RTABMAP_CORE_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>rtabmap::util3d::extractIndices</b> (const pcl::PointCloud&lt; pcl::PointXYZ &gt;::Ptr &amp;cloud, const pcl::IndicesPtr &amp;indices, bool negative)</td></tr>
<tr class="memdesc:ga8685395807479f06b19d9d41616a03a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract indices from point cloud of type <code>pcl::PointXYZ</code>. <br /></td></tr>
<tr class="separator:ga8685395807479f06b19d9d41616a03a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8ce0dc4070d599c6f4a8c55651c2f944" id="r_ga8ce0dc4070d599c6f4a8c55651c2f944"><td class="memItemLeft" align="right" valign="top"><a id="ga8ce0dc4070d599c6f4a8c55651c2f944" name="ga8ce0dc4070d599c6f4a8c55651c2f944"></a>
pcl::IndicesPtr RTABMAP_CORE_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>rtabmap::util3d::extractIndices</b> (const pcl::PointCloud&lt; pcl::PointNormal &gt;::Ptr &amp;cloud, const pcl::IndicesPtr &amp;indices, bool negative)</td></tr>
<tr class="memdesc:ga8ce0dc4070d599c6f4a8c55651c2f944"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract indices from point cloud of type <code>pcl::PointNormal</code>. <br /></td></tr>
<tr class="separator:ga8ce0dc4070d599c6f4a8c55651c2f944"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0c8a4fe56efba09d2bf6c5b84da36702" id="r_ga0c8a4fe56efba09d2bf6c5b84da36702"><td class="memItemLeft" align="right" valign="top"><a id="ga0c8a4fe56efba09d2bf6c5b84da36702" name="ga0c8a4fe56efba09d2bf6c5b84da36702"></a>
pcl::IndicesPtr RTABMAP_CORE_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>rtabmap::util3d::extractIndices</b> (const pcl::PointCloud&lt; pcl::PointXYZRGB &gt;::Ptr &amp;cloud, const pcl::IndicesPtr &amp;indices, bool negative)</td></tr>
<tr class="memdesc:ga0c8a4fe56efba09d2bf6c5b84da36702"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract indices from point cloud of type <code>pcl::PointXYZRGB</code>. <br /></td></tr>
<tr class="separator:ga0c8a4fe56efba09d2bf6c5b84da36702"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga93acd3d20cbab15b628cbc2a0f3b1919" id="r_ga93acd3d20cbab15b628cbc2a0f3b1919"><td class="memItemLeft" align="right" valign="top"><a id="ga93acd3d20cbab15b628cbc2a0f3b1919" name="ga93acd3d20cbab15b628cbc2a0f3b1919"></a>
pcl::IndicesPtr RTABMAP_CORE_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>rtabmap::util3d::extractIndices</b> (const pcl::PointCloud&lt; pcl::PointXYZRGBNormal &gt;::Ptr &amp;cloud, const pcl::IndicesPtr &amp;indices, bool negative)</td></tr>
<tr class="memdesc:ga93acd3d20cbab15b628cbc2a0f3b1919"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract indices from point cloud of type <code>pcl::PointXYZRGBNormal</code>. <br /></td></tr>
<tr class="separator:ga93acd3d20cbab15b628cbc2a0f3b1919"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf8e635d6864b0a7f41bad4bb185a57f4" id="r_gaf8e635d6864b0a7f41bad4bb185a57f4"><td class="memItemLeft" align="right" valign="top"><a id="gaf8e635d6864b0a7f41bad4bb185a57f4" name="gaf8e635d6864b0a7f41bad4bb185a57f4"></a>
pcl::IndicesPtr RTABMAP_CORE_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>rtabmap::util3d::extractIndices</b> (const pcl::PointCloud&lt; pcl::PointXYZI &gt;::Ptr &amp;cloud, const pcl::IndicesPtr &amp;indices, bool negative)</td></tr>
<tr class="memdesc:gaf8e635d6864b0a7f41bad4bb185a57f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract indices from point cloud of type <code>pcl::PointXYZI</code>. <br /></td></tr>
<tr class="separator:gaf8e635d6864b0a7f41bad4bb185a57f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae196609121fa899ba2735d406aedc73b" id="r_gae196609121fa899ba2735d406aedc73b"><td class="memItemLeft" align="right" valign="top"><a id="gae196609121fa899ba2735d406aedc73b" name="gae196609121fa899ba2735d406aedc73b"></a>
pcl::IndicesPtr RTABMAP_CORE_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>rtabmap::util3d::extractIndices</b> (const pcl::PointCloud&lt; pcl::PointXYZINormal &gt;::Ptr &amp;cloud, const pcl::IndicesPtr &amp;indices, bool negative)</td></tr>
<tr class="memdesc:gae196609121fa899ba2735d406aedc73b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract indices from point cloud of type <code>pcl::PointXYZINormal</code>. <br /></td></tr>
<tr class="separator:gae196609121fa899ba2735d406aedc73b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2a39a8e9d769e5e2cea8054b7084af1e" id="r_ga2a39a8e9d769e5e2cea8054b7084af1e"><td class="memItemLeft" align="right" valign="top"><a id="ga2a39a8e9d769e5e2cea8054b7084af1e" name="ga2a39a8e9d769e5e2cea8054b7084af1e"></a>
pcl::PointCloud&lt; pcl::PointXYZ &gt;::Ptr RTABMAP_CORE_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>rtabmap::util3d::extractIndices</b> (const pcl::PointCloud&lt; pcl::PointXYZ &gt;::Ptr &amp;cloud, const pcl::IndicesPtr &amp;indices, bool negative, bool keepOrganized)</td></tr>
<tr class="memdesc:ga2a39a8e9d769e5e2cea8054b7084af1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract points from point cloud of type <code>pcl::PointXYZ</code> with corresponding indices. <br /></td></tr>
<tr class="separator:ga2a39a8e9d769e5e2cea8054b7084af1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaca2188ec4a875fb9c6d2fa240888dcf1" id="r_gaca2188ec4a875fb9c6d2fa240888dcf1"><td class="memItemLeft" align="right" valign="top"><a id="gaca2188ec4a875fb9c6d2fa240888dcf1" name="gaca2188ec4a875fb9c6d2fa240888dcf1"></a>
pcl::PointCloud&lt; pcl::PointXYZRGB &gt;::Ptr RTABMAP_CORE_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>rtabmap::util3d::extractIndices</b> (const pcl::PointCloud&lt; pcl::PointXYZRGB &gt;::Ptr &amp;cloud, const pcl::IndicesPtr &amp;indices, bool negative, bool keepOrganized)</td></tr>
<tr class="memdesc:gaca2188ec4a875fb9c6d2fa240888dcf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract points from point cloud of type <code>pcl::PointXYZRGB</code> with corresponding indices. <br /></td></tr>
<tr class="separator:gaca2188ec4a875fb9c6d2fa240888dcf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf6cd58fdda3450fb11496395e35908d7" id="r_gaf6cd58fdda3450fb11496395e35908d7"><td class="memItemLeft" align="right" valign="top"><a id="gaf6cd58fdda3450fb11496395e35908d7" name="gaf6cd58fdda3450fb11496395e35908d7"></a>
pcl::PointCloud&lt; pcl::PointXYZRGBNormal &gt;::Ptr RTABMAP_CORE_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>rtabmap::util3d::extractIndices</b> (const pcl::PointCloud&lt; pcl::PointXYZRGBNormal &gt;::Ptr &amp;cloud, const pcl::IndicesPtr &amp;indices, bool negative, bool keepOrganized)</td></tr>
<tr class="memdesc:gaf6cd58fdda3450fb11496395e35908d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract points from point cloud of type <code>pcl::PointXYZRGBNormal</code> with corresponding indices. <br /></td></tr>
<tr class="separator:gaf6cd58fdda3450fb11496395e35908d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad759e35639cd87f04ebd09eadb5865f5" id="r_gad759e35639cd87f04ebd09eadb5865f5"><td class="memItemLeft" align="right" valign="top"><a id="gad759e35639cd87f04ebd09eadb5865f5" name="gad759e35639cd87f04ebd09eadb5865f5"></a>
pcl::PointCloud&lt; pcl::PointXYZI &gt;::Ptr RTABMAP_CORE_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>rtabmap::util3d::extractIndices</b> (const pcl::PointCloud&lt; pcl::PointXYZI &gt;::Ptr &amp;cloud, const pcl::IndicesPtr &amp;indices, bool negative, bool keepOrganized)</td></tr>
<tr class="memdesc:gad759e35639cd87f04ebd09eadb5865f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract points from point cloud of type <code>pcl::PointXYZI</code> with corresponding indices. <br /></td></tr>
<tr class="separator:gad759e35639cd87f04ebd09eadb5865f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa312bb0ae54f1472d4e4f22bee7cc4d6" id="r_gaa312bb0ae54f1472d4e4f22bee7cc4d6"><td class="memItemLeft" align="right" valign="top"><a id="gaa312bb0ae54f1472d4e4f22bee7cc4d6" name="gaa312bb0ae54f1472d4e4f22bee7cc4d6"></a>
pcl::PointCloud&lt; pcl::PointXYZINormal &gt;::Ptr RTABMAP_CORE_EXPORT&#160;</td><td class="memItemRight" valign="bottom"><b>rtabmap::util3d::extractIndices</b> (const pcl::PointCloud&lt; pcl::PointXYZINormal &gt;::Ptr &amp;cloud, const pcl::IndicesPtr &amp;indices, bool negative, bool keepOrganized)</td></tr>
<tr class="memdesc:gaa312bb0ae54f1472d4e4f22bee7cc4d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract points from point cloud of type <code>pcl::PointXYZINormal</code> with corresponding indices. <br /></td></tr>
<tr class="separator:gaa312bb0ae54f1472d4e4f22bee7cc4d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Extracts a subset of points from a point cloud based on specified indices. </p>
<p>This function filters the input point cloud by extracting the points corresponding to the provided set of indices. The <code>negative</code> parameter determines whether to extract the points listed in the indices (if <code>negative</code> is false) or to exclude the points listed in the indices (if <code>negative</code> is true).</p>
<p>The function uses PCL's <code>ExtractIndices</code> to perform the extraction and returns the resulting set of indices as a shared pointer to a vector of integers.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cloud</td><td>The input point cloud from which to extract points. </td></tr>
<tr><td class="paramname">indices</td><td>A pointer to the indices specifying the points to be extracted (or excluded). </td></tr>
<tr><td class="paramname">negative</td><td>If true, the points specified by <code>indices</code> are excluded; otherwise, they are included.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A vector of indices representing the extracted points (or remaining points if <code>negative</code> is true), or a new point cloud with the corresponding points.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function uses PCL's <code>ExtractIndices</code> filter to extract or remove the points based on the provided indices. </dd>
<dd>
The returned <code>output</code> indices correspond to the points that are either extracted or excluded from the input cloud. </dd></dl>
</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>